代付订单查询
大约 2 分钟
请求
用于查询代付（Pay-Out）订单状态与详情。
数字货币订单
数字货币代付订单的查询路径与响应字段不同，请见 数字货币订单查询。
请求路径
模板（未列国家请按运营提供的域名与编码拼接）
沙箱：
https://{对应国家域名}/sandbox/{对应国家编码}/disbursement/query
生产：https://{对应国家域名}/{对应国家编码}/disbursement/query
推荐 Host 使用统一域名
openapi.toppayment.com；原国别域名仍可用。
按国家区分的完整地址
| 国家/地区 | 国家码 | 沙箱 | 生产 |
|---|---|---|---|
| 菲律宾 | ph | https://openapi.toppayment.com/sandbox/ph/disbursement/query | https://openapi.toppayment.com/ph/disbursement/query |
| 印度尼西亚 | id | https://openapi.toppayment.com/sandbox/id/disbursement/query | https://openapi.toppayment.com/id/disbursement/query |
| 尼日利亚 | ng | https://openapi.toppayment.com/sandbox/ng/disbursement/query | https://openapi.toppayment.com/ng/disbursement/query |
| 印度 | in | https://openapi.toppayment.com/sandbox/in/disbursement/query | https://openapi.toppayment.com/in/disbursement/query |
| 泰国 | th | https://openapi.toppayment.com/sandbox/th/disbursement/query | https://openapi.toppayment.com/th/disbursement/query |
| 越南 | vn | https://openapi.toppayment.com/sandbox/vn/disbursement/query | https://openapi.toppayment.com/vn/disbursement/query |
| 秘鲁 | pe | https://openapi.toppayment.com/sandbox/pe/disbursement/query | https://openapi.toppayment.com/pe/disbursement/query |
| 巴西 | br | https://openapi.toppayment.com/sandbox/br/disbursement/query | https://openapi.toppayment.com/br/disbursement/query |
| 墨西哥 | mx | https://openapi.toppayment.com/sandbox/mx/disbursement/query | https://openapi.toppayment.com/mx/disbursement/query |
| 哥伦比亚 | co | https://openapi.toppayment.com/sandbox/co/disbursement/query | https://openapi.toppayment.com/co/disbursement/query |
| 玻利维亚 | bo | https://openapi.toppayment.com/sandbox/bo/disbursement/query | https://openapi.toppayment.com/bo/disbursement/query |
| 巴基斯坦 | pk | https://openapi.toppayment.com/sandbox/pk/disbursement/query | https://openapi.toppayment.com/pk/disbursement/query |
| 孟加拉 | bd | https://openapi.toppayment.com/sandbox/bd/disbursement/query | https://openapi.toppayment.com/bd/disbursement/query |
请求头参数
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Content-Type | M | String | 固定：application/json |
请求体参数
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| mchNo | M | String(32) | 商户编号 |
| orderNum | C | String(64) | 商户订单号；与 platOrderNum 至少提供一个 |
| platOrderNum | C | String(64) | 平台订单号；与 orderNum 至少提供一个 |
| timestamp | M | Number(13位) | 毫秒时间戳，例如 1660927384903 |
| sign | M | String | 签名，见签名规则 |
重要
orderNum 与 platOrderNum 至少提供其一。
示例
{
"mchNo": "{{mchNo}}",
"orderNum": "PH12345ad5627",
"platOrderNum": "PRE2008115605537816576",
"timestamp": 1660927384903,
"sign": "按签名规则生成后替换"
}
响应
字段
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| success | M | Boolean | 是否成功 |
| code | M | String | 9999 成功，否则失败 |
| msg | O | String | 描述 |
| timeStamp | M | Number | 响应时间戳（毫秒） |
| data | M | Object | 订单详情 |
| orderNum | M | String | 商户订单号 |
| platOrderNum | M | String | 平台订单号 |
| amount | M | Number | 金额 |
| fee | M | Number | 手续费 |
| feeType | M | Number | 手续费类型（0：内扣，1：外扣） |
| status | M | Number | 交易状态，见交易状态码 |
| statusMsg | M | String | 状态描述（平台返回英文原文，如 supplement success! 表示补单成功） |
| bankCode | M | String | 银行代码 |
| bankCard | M | String | 银行卡号/账户号 |
| accountName | M | String | 账户名 |
| description | O | String | 备注 |
示例
{
"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"
}
}