代收订单查询
大约 2 分钟
请求
用于查询代收（Pay-In）订单状态与详情。
数字货币订单
数字货币代收订单的查询路径与响应字段不同，请见 数字货币订单查询。
请求路径
模板（未列国家请按运营提供的域名与编码拼接）
沙箱：
https://{对应国家域名}/sandbox/{对应国家编码}/pay/query
生产：https://{对应国家域名}/{对应国家编码}/pay/query
推荐 Host 使用统一域名
openapi.toppayment.com；原国别域名仍可用。
按国家区分的完整地址
| 国家/地区 | 国家码 | 沙箱 | 生产 |
|---|---|---|---|
| 菲律宾 | ph | https://openapi.toppayment.com/sandbox/ph/pay/query | https://openapi.toppayment.com/ph/pay/query |
| 印度尼西亚 | id | https://openapi.toppayment.com/sandbox/id/pay/query | https://openapi.toppayment.com/id/pay/query |
| 尼日利亚 | ng | https://openapi.toppayment.com/sandbox/ng/pay/query | https://openapi.toppayment.com/ng/pay/query |
| 印度 | in | https://openapi.toppayment.com/sandbox/in/pay/query | https://openapi.toppayment.com/in/pay/query |
| 泰国 | th | https://openapi.toppayment.com/sandbox/th/pay/query | https://openapi.toppayment.com/th/pay/query |
| 越南 | vn | https://openapi.toppayment.com/sandbox/vn/pay/query | https://openapi.toppayment.com/vn/pay/query |
| 秘鲁 | pe | https://openapi.toppayment.com/sandbox/pe/pay/query | https://openapi.toppayment.com/pe/pay/query |
| 巴西 | br | https://openapi.toppayment.com/sandbox/br/pay/query | https://openapi.toppayment.com/br/pay/query |
| 墨西哥 | mx | https://openapi.toppayment.com/sandbox/mx/pay/query | https://openapi.toppayment.com/mx/pay/query |
| 哥伦比亚 | co | https://openapi.toppayment.com/sandbox/co/pay/query | https://openapi.toppayment.com/co/pay/query |
| 玻利维亚 | bo | https://openapi.toppayment.com/sandbox/bo/pay/query | https://openapi.toppayment.com/bo/pay/query |
| 巴基斯坦 | pk | https://openapi.toppayment.com/sandbox/pk/pay/query | https://openapi.toppayment.com/pk/pay/query |
| 孟加拉 | bd | https://openapi.toppayment.com/sandbox/bd/pay/query | https://openapi.toppayment.com/bd/pay/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 | 手续费 |
| validTime | M | Number | 过期时间戳（毫秒） |
| productDetail | M | String | 产品描述 |
| customerName | M | String | 客户姓名 |
| customerEmail | M | String | 客户邮箱 |
| customerPhone | M | String | 客户电话 |
| status | M | String | 交易状态，见交易状态码 |
| payerName | O | String | 付款人姓名（平台可能返回英文原文） |
| payerAccountNo | O | String | 付款人账号 |
| payerAccountBank | O | String | 付款人开户行 |
示例
{
"success": true,
"code": "9999",
"msg": null,
"timeStamp": 1767873183510,
"data": {
"orderNum": "PH12345ad5627",
"platOrderNum": "PRE2008115605537816576",
"amount": 200.00,
"fee": 0.00,
"validTime": 1767697044000,
"productDetail": "azel",
"customerName": "azel",
"customerEmail": "[email protected]",
"customerPhone": "18121153777",
"status": "INIT_ORDER"
}
}