Pay-Out Order Inquiry
About 2 min
Request
Query Pay-Out order status and details.
Crypto orders
Crypto pay-out orders use a different URL and response schema — see Crypto Order Inquiry.
Request URL
Template (if your country is not listed, use the domain and code provided by your account manager)
Sandbox:
https://{country domain}/sandbox/{countryCode}/disbursement/query
Production:https://{country domain}/{countryCode}/disbursement/query
Prefer Host
openapi.toppayment.com; legacy country domains remain available.
Full URLs by country
| Country / region | Code | Sandbox | Production |
|---|---|---|---|
| Philippines | ph | https://openapi.toppayment.com/sandbox/ph/disbursement/query | https://openapi.toppayment.com/ph/disbursement/query |
| Indonesia | id | https://openapi.toppayment.com/sandbox/id/disbursement/query | https://openapi.toppayment.com/id/disbursement/query |
| Nigeria | ng | https://openapi.toppayment.com/sandbox/ng/disbursement/query | https://openapi.toppayment.com/ng/disbursement/query |
| India | in | https://openapi.toppayment.com/sandbox/in/disbursement/query | https://openapi.toppayment.com/in/disbursement/query |
| Thailand | th | https://openapi.toppayment.com/sandbox/th/disbursement/query | https://openapi.toppayment.com/th/disbursement/query |
| Vietnam | vn | https://openapi.toppayment.com/sandbox/vn/disbursement/query | https://openapi.toppayment.com/vn/disbursement/query |
| Peru | pe | https://openapi.toppayment.com/sandbox/pe/disbursement/query | https://openapi.toppayment.com/pe/disbursement/query |
| Brazil | br | https://openapi.toppayment.com/sandbox/br/disbursement/query | https://openapi.toppayment.com/br/disbursement/query |
| Mexico | mx | https://openapi.toppayment.com/sandbox/mx/disbursement/query | https://openapi.toppayment.com/mx/disbursement/query |
| Colombia | co | https://openapi.toppayment.com/sandbox/co/disbursement/query | https://openapi.toppayment.com/co/disbursement/query |
| Bolivia | bo | https://openapi.toppayment.com/sandbox/bo/disbursement/query | https://openapi.toppayment.com/bo/disbursement/query |
| Pakistan | pk | https://openapi.toppayment.com/sandbox/pk/disbursement/query | https://openapi.toppayment.com/pk/disbursement/query |
| Bangladesh | bd | https://openapi.toppayment.com/sandbox/bd/disbursement/query | https://openapi.toppayment.com/bd/disbursement/query |
Request Header
| Field | Required | Type | Description |
|---|---|---|---|
| Content-Type | M | String | Fixed: application/json |
Request Body
| Field | Required | Type | Description |
|---|---|---|---|
| mchNo | M | String(32) | Merchant number |
| orderNum | C | String(64) | Merchant order number; provide at least one of orderNum / platOrderNum |
| platOrderNum | C | String(64) | Platform order number; provide at least one of orderNum / platOrderNum |
| timestamp | M | Number(13) | Millisecond timestamp, e.g. 1660927384903 |
| sign | M | String | Signature, see Signature |
Important
Provide at least one of orderNum or platOrderNum.
Example
{
"mchNo": "{{mchNo}}",
"orderNum": "PH12345ad5627",
"platOrderNum": "PRE2008115605537816576",
"timestamp": 1660927384903,
"sign": "Generate per signature rules and replace"
}
Response
Fields
| Field | Required | Type | Description |
|---|---|---|---|
| success | M | Boolean | Success flag |
| code | M | String | 9999 success, others failure |
| msg | O | String | Message |
| timeStamp | M | Number | Response timestamp (ms) |
| data | M | Object | Order details |
| orderNum | M | String | Merchant order number |
| platOrderNum | M | String | Platform order number |
| amount | M | Number | Amount |
| fee | M | Number | Fee |
| feeType | M | Number | Fee type (0: internal, 1: external) |
| status | M | Number | Status, see Transaction Status Codes |
| statusMsg | M | String | Status message |
| bankCode | M | String | Bank code |
| bankCard | M | String | Bank card / account number |
| accountName | M | String | Account name |
| description | O | String | Remark |
Example
{
"success": true,
"code": "9999",
"msg": null,
"timeStamp": 1774876011669,
"data": {
"orderNum": "PHPPR22OD312345622",
"platOrderNum": "TRANS2037041938602917888",
"amount": 10000.00000000,
"fee": 2200.00000000,
"feeType": 1,
"status": 2,
"statusMsg": "supplement success!",
"bankCode": "008",
"bankCard": "12340995811",
"accountName": "Ujang",
"description": "test"
}
}