API Document

# 3、Query Orders

  • Query Order Status

# Query Collecting Orders

Request Method

  • POST

Request URL

/api/v3/mex/bankTransfers/query/collectingOrder

Request Type

"Content-Type": "application/json; charset=utf-8"

Request Header Parameters

Param Type Description Sample
access_key String Merchant's backend access key pFqV75X3
timestamp String 13-digit Unix timestamp in milliseconds 1679724896223
nonce String UUID v4 random string 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign String Signature generated using the secret_key kAXyh+eerqrefyaF8dyFB0M4FVo=

Request Example

{
  "externalOrderId": "389508808434869257",
  "orderId": "OCURRPAID202307270301551690426915467DOCKER020000000400000744"
}

Request Parameters Description

Param Type Required Description
externalOrderId String Optional Merchant Order ID
orderId String Optional System Order ID

Response Header

Header: { "Content-Type": "application/json; charset=utf-8" }

Response Example

{
	"code": "200",
	"success": true,
	"msg": "Success",
	"msgEn": "SUCCESS",
	"data": [{
		"orderId": "OCURRPAID202307140712051689318725535DOCKER020000000400000168",
		"cashierId": "OCURRPAID202307140712051689318725469DOCKER020000000200000167",
		"orderType": 1,
		"orderResourceType": 2,
		"userId": "1663371399710216194",
		"orderStatus": 1,
		"orderTime": 1689318726000,
		"channelOrderId": "20230714071207439140854557",
		"externalOrderId": "354997490558818072",
		"orderAmount": "40.2",
		"orderActualAmount": null,
		"orderFee": null,
		"orderPayTime": null,
		"orderCompleteTime": null,
		"currencyType": "MXN",
		"payType": 102,
		"tradeNote": "123",
		"notifyUrl": "http://192.168.1.135:30001/",
		"markStatus": 0,
		"errorMsg": "",
		"errorMsgEn": "",
		"accountType": "",
		"accountName": "",
		"accountNo": "",
		"orderTypeCode": "Pay",
		"orderResourceTypeCode": "Currency",
		"orderStatusCode": "Accepted",
		"payTypeCode": "BANK",
        "userInfoName":"",
      	"userInfoNo":"",
      	"businessId":"1749105475963odyplcnk09geo1668pq"
	}]
}

Response Parameter Description

Parameter Name Type Description
orderId String Order ID
cashierId String Cashier ID
orderType int64 Order type
orderResourceType int64 Order business type
userId String User ID
orderStatus int64 Order status: 1 - Pending payment; 2 - Payment successful
orderTime int64 Order creation time
channelOrderId String Channel-related order ID
externalOrderId String Merchant order ID
orderAmount String Order amount
orderActualAmount String Actual order amount
orderFee int64 Order fee
orderPayTime int64 Payment time
currencyType String Currency type
payType int64 Payment type
tradeNote String Notes
notifyUrl String Callback URL
markStatus int64 Mark status
errorMsg String Error message
errorMsgEn String Error message in English
accountType String Account type
accountName String Account name
accountNo String Account number
orderTypeCode String Order type code
orderResourceTypeCode String Order resource type code
orderStatusCode String Order status code description
payTypeCode String Payment type code referring to payType
userInfoNo String User ID number
userInfoName String User name
businessId String Merchant business ID

# Query Payout Orders

Request Method

  • POST

Request URL

/api/v3/mex/query/transferOrder

Request Type

"Content-Type": "application/json; charset=utf-8"

Request Header Parameters

Param Type Description Sample
access_key String Obtained from merchant backend pFqV75X3
timestamp int64 Unix timestamp (13 digits) 1679724896223
nonce String UUID V4 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign String Calculated signature kAXyh+eerqrefyaF8dyFB0M4FVo=

Request Example

{
  "externalOrderId": "241534072867503522",
  "orderId": "OCARDDEP0202306090256051686279365706DOCKER020000000200001399"
}

Request Parameters Explanation

Param Type Required Description
externalOrderId String Optional Merchant Order Number
orderId String Optional System Order Number

Response Type

Header: { 'Content-Type': 'application/json;charset=utf-8'}

Response Example

{
	"code": "200",
	"success": true,
	"msg": "Success",
	"msgEn": "SUCCESS",
	"data": [{
		"orderId": "OCURRDRAW202307170821151689582075477DOCKER020000000200000233",
		"cashierId": "",
		"orderType": 2,
		"orderResourceType": 2,
		"userId": "1663371399710216194",
		"orderStatus": 1,
		"orderTime": 1689582076000,
		"channelOrderId": "",
		"externalOrderId": "979744221460536657",
		"orderAmount": "40.2",
		"orderActualAmount": "41",
		"orderFee": "0.8",
		"orderPayTime": null,
		"currencyType": "MXN",
		"payType": 202,
		"tradeNote": "123",
		"notifyUrl": "http://192.168.1.135:30001",
		"markStatus": 0,
		"errorMsg": "",
		"errorMsgEn": "",
		"accountType": "40",
		"accountName": "AZTECA2",
		"accountNo": "13178968534",
		"orderTypeCode": "Transfer",
		"orderResourceTypeCode": "Currency",
		"orderStatusCode": "Accepted",
		"payTypeCode": "BANK"
	}]
}

Response Parameters Explanation

Param Type Description
cashierId String Cashier ID
orderType int64 Order type
orderResourceType int64 Order business type
userId String User ID
orderStatus int64 Order status: 1- Accepted; 2- Bank processing; 4- Failed (bank did not accept); 8- Success; 16- Failed
orderTime int64 Order initiation time
channelOrderId String Associated channel order ID
externalOrderId String Merchant order number
orderAmount String Order amount
orderActualAmount String Actual order amount
orderFee int64 Order fee
orderPayTime int64 Order payment time
currencyType String Currency type
payType int64 Payment type
tradeNote String Remark
notifyUrl String Callback URL
markStatus int64 Mark status
errorMsg String Error message
errorMsgEn String Error message (in English)
accountType String Account type
accountName String Account name
accountNo String Account number
orderTypeCode String Order type code
orderResourceTypeCode String Order business type code
orderStatusCode String Order status description
payTypeCode String Payment type code, refers to payType

← 4、 Query Balance →