Transfer Single Query
API Information
- Path:
/api/v1/txn/query - Method: POST
- Content-Type: application/json
Business Description
- Used to query the detailed status of a single payment transaction.
- You can query by either requestId or payoutId.
- Use this interface to confirm the transaction status after payment initiation.
Request Parameters
Headers
Request Headers
| Parameter | Value | Required | Description |
|---|---|---|---|
| Content-Type | application/json | Yes | Request body type |
Request Body
Main Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| merchantNo | string | The merchant number of the request initiator. | M |
| onBehalfOf | string | The merchant number that the request is actually associated with. Provide this field only when initiating a request on behalf of another merchant. | N |
| requestId | string(32) | Business transaction ID | C-Required if payoutId is empty |
| payoutId | integer(32) | Payment transaction ID | C-Required if requestId is empty |
| sign | string | Signature | N |
Request Example
json
{
"merchantNo": "800225",
"requestId": "REQ20240101123456789012345678901",
"payoutId": 1808783413957234688,
"sign": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
}Response Result
Response Headers
| Parameter | Value | Required | Description |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | No | Response body type |
Response Parameters
Response Fields
| Parameter | Type | Description |
|---|---|---|
| respCode | string | Response code |
| respMsg | string | Response message |
| data | object | Response data |
| └─merchantNo | string | Merchant number |
| └─onBehalfOf | string | Merchant number that the request is actually associated with; may be null when not querying on behalf of another merchant |
| └─requestId | string | Business transaction ID |
| └─payoutId | integer | Payment transaction ID |
| └─status | string | Status enumeration values |
| └─settleCurrency | string | Settlement Currency |
| └─settleSumAmount | number | Settlement summary amount |
| └─serviceFee | number | Fee |
| └─convRate | number | Conversion FX Rate |
| └─payoutStatusReason | string | Payment status reason |
Response Example
json
{
"respCode": "20000",
"respMsg": null,
"data": {
"merchantNo": "801040",
"onBehalfOf": null,
"requestId": "DM20250888804123",
"payoutId": "1954374604177408000",
"status": "P",
"settleCurrency": "USD",
"settleSumAmount": 8.939382,
"serviceFee": -2.089382,
"convRate": 277.564623,
"payoutStatusReason": null
}
}