Pay-In Order Inquiry

Request

Query Pay-In order status and details.

Crypto orders

Crypto pay-in 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}/pay/query
Production: https://{country domain}/{countryCode}/pay/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/pay/query	https://openapi.toppayment.com/ph/pay/query
Indonesia	id	https://openapi.toppayment.com/sandbox/id/pay/query	https://openapi.toppayment.com/id/pay/query
Nigeria	ng	https://openapi.toppayment.com/sandbox/ng/pay/query	https://openapi.toppayment.com/ng/pay/query
India	in	https://openapi.toppayment.com/sandbox/in/pay/query	https://openapi.toppayment.com/in/pay/query
Thailand	th	https://openapi.toppayment.com/sandbox/th/pay/query	https://openapi.toppayment.com/th/pay/query
Vietnam	vn	https://openapi.toppayment.com/sandbox/vn/pay/query	https://openapi.toppayment.com/vn/pay/query
Peru	pe	https://openapi.toppayment.com/sandbox/pe/pay/query	https://openapi.toppayment.com/pe/pay/query
Brazil	br	https://openapi.toppayment.com/sandbox/br/pay/query	https://openapi.toppayment.com/br/pay/query
Mexico	mx	https://openapi.toppayment.com/sandbox/mx/pay/query	https://openapi.toppayment.com/mx/pay/query
Colombia	co	https://openapi.toppayment.com/sandbox/co/pay/query	https://openapi.toppayment.com/co/pay/query
Bolivia	bo	https://openapi.toppayment.com/sandbox/bo/pay/query	https://openapi.toppayment.com/bo/pay/query
Pakistan	pk	https://openapi.toppayment.com/sandbox/pk/pay/query	https://openapi.toppayment.com/pk/pay/query
Bangladesh	bd	https://openapi.toppayment.com/sandbox/bd/pay/query	https://openapi.toppayment.com/bd/pay/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 with/without platOrderNum (at least one of the two)
platOrderNum	C	String(64)	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}}",
  "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
validTime	M	Number	Expiry timestamp (ms)
productDetail	M	String	Product detail
customerName	M	String	Customer name
customerEmail	M	String	Customer email
customerPhone	M	String	Customer phone
status	M	String	Status, see Transaction Status Codes
payerName	O	String	Payer name
payerAccountNo	O	String	Payer account number
payerAccountBank	O	String	Payer account bank

Example

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