Pay-In Sub-Order Inquiry

Request

Query the sub-order list associated with a Pay-In parent order. This is mainly used for Mexico and Colombia where parent/sub-order splitting exists.

Request URL

Template (if your country is not listed, use the domain and code provided by your account manager)

https://{country domain}/{countryCode}/pay/querySubOrders

This API is production-only. There is no sandbox URL.

Prefer Host openapi.toppayment.com; legacy country domains remain available.

Full URLs by country

Country / region	Code	URL
Mexico	mx	https://openapi.toppayment.com/mx/pay/querySubOrders
Colombia	co	https://openapi.toppayment.com/co/pay/querySubOrders

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)	Parent merchant order number; provide with/without platOrderNum (at least one of the two)
platOrderNum	C	String(64)	Parent platform order number; provide with/without orderNum (at least one of the two)
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}}",
  "platOrderNum": "PRE2008115605537816576",
  "timestamp": 1660927384903,
  "sign": "Generate per signature rules and replace"
}

{
  "mchNo": "{{mchNo}}",
  "orderNum": "MX_ORDER_001",
  "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	Array	Sub-order list
parentPlatOrderNum	M	String	Parent platform order number
parentOrderNum	O	String	Parent merchant order number
platOrderNum	M	String	Sub-order platform order number
orderNum	M	String	Sub-order merchant order number
amount	M	Number	Sub-order amount
status	M	String	Status, see Transaction Status Codes

Example

{
  "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"
    }
  ]
}