代收主子单查询

请求

用于查询代收（Pay-In）主单下关联的子单列表。当前主要用于墨西哥、哥伦比亚存在主子单拆分的场景。

请求路径

模板（未列国家请按运营提供的域名与编码拼接）

https://{对应国家域名}/{对应国家编码}/pay/querySubOrders

本接口仅提供生产环境，无沙箱地址。

推荐 Host 使用统一域名 openapi.toppayment.com；原国别域名仍可用。

按国家区分的完整地址

国家/地区	国家码	地址
墨西哥	mx	https://openapi.toppayment.com/mx/pay/querySubOrders
哥伦比亚	co	https://openapi.toppayment.com/co/pay/querySubOrders

请求头参数

字段	必填	类型	描述
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}}",
  "platOrderNum": "PRE2008115605537816576",
  "timestamp": 1660927384903,
  "sign": "按签名规则生成后替换"
}

{
  "mchNo": "{{mchNo}}",
  "orderNum": "MX_ORDER_001",
  "timestamp": 1660927384903,
  "sign": "按签名规则生成后替换"
}

响应

字段

字段	必填	类型	描述
success	M	Boolean	是否成功
code	M	String	9999 成功，否则失败
msg	O	String	描述
timeStamp	M	Number	响应时间戳（毫秒）
data	M	Array	子单列表
parentPlatOrderNum	M	String	父单平台订单号
parentOrderNum	O	String	父单商户订单号
platOrderNum	M	String	子单平台订单号
orderNum	M	String	子单商户订单号
amount	M	Number	子单金额
status	M	String	交易状态，见交易状态码

示例

{
  "success": true,
  "code": "9999",
  "msg": null,
  "timeStamp": 1767873183510,
  "data": [
    {
      "parentPlatOrderNum": "PRE2008115605537816576",
      "parentOrderNum": "MX_ORDER_001",
      "platOrderNum": "PRE2008115605537816576-1",
      "orderNum": "MX_ORDER_001_1",
      "amount": 100.00,
      "status": "NO_PAY"
    },
    {
      "parentPlatOrderNum": "PRE2008115605537816576",
      "parentOrderNum": "MX_ORDER_001",
      "platOrderNum": "PRE2008115605537816576-2",
      "orderNum": "MX_ORDER_001_2",
      "amount": 100.00,
      "status": "SUCCESS"
    }
  ]
}