Query Order

Query order API used for merchant/partner to query order status

EndPoint

POST /binancepay/openapi/order/query

Request Parameters

Attributes	Type	Required	Limitation	Description
merchantTradeNo	string	N	maximum length 32,letter or digit, no other symbol allowed, can not be empty if prepayId is empty	The order id, Unique identifier for the request
prepayId	string	N	maximum length 19,letter or digit, no other symbol allowed, can not be empty if merchantTradeNo is empty	Binance unique order id

Sample Request Body

Query order result by merchantTradeNo:

{
  "merchantTradeNo": "9825382937292",
  "prepayId": null
}

Query order result by prepayId:

{
  "merchantTradeNo": null,
  "prepayId": "9825382937292"
}

Response Parameters

Attributes	Type	Required	Limitation	Description
status	string	Y	"SUCCESS" or "FAIL"	status of the API request
code	string	Y	-	request result code, refer to
data	QueryOrderResult	N	-	response body, refer to
errorMessage	string	N	maximum length 256

Child Attribute

QueryOrderResult

Attributes	Type	Required	Limitation	Description
merchantId	long	Y	-	The merchant account id, issued when merchant been created at Binance.
prepayId	string	Y	maximum length 19	unique id generated by binance
transactionId	string	N	maximum length 32	issued once the payment is successful
merchantTradeNo	string	Y	maximum length 32	merchant trade number
tradeType	string	Y	"WEB", "APP", "WAP", "MINI_PROGRAM", "PAYMENT_LINK", "OTHERS"	operate entrance
status	string	Y	"INITIAL", "PENDING", "PAID", "CANCELED", "ERROR", "REFUNDING", "REFUNDED", "EXPIRED"	order status
currency	string	Y	-	order currency
totalFee	decimal	Y	limitation refer to Create Order API order amount	order amount
productName	string	N	maximum length 256	product name
productDetail	string	N	maximum length 256	product detail
openUserId	string	N	maximum length 19	Consumer unique id
passThroughInfo	string	N	maximum length 512	pass through info, from the create order api
transactTime	long	N	-	UnixTimestamp in milliseconds when transaction happened
createTime	long	Y	-	UnixTimestamp in milliseconds when order was created

Sample Response

{
  "status": "SUCCESS",
  "code": "000000",
  "data": {
    "merchantId": 98729382672,
    "prepayId": "383729303729303",
    "transactionId": "23729202729220282",
    "merchantTradeNo": "9825382937292",
    "tradeType": "APP",
    "status": "PAID",
    "currency": "USDT",
    "totalFee": 10.88,
    "productName": "Ice Cream",
    "productDetail": "Greentea ice cream cone",
    "openUserId": "",
    "passThroughInfo": "",
    "transactTime": 1425744000123,
    "createTime": 1425744000000
  },
  "errorMessage": ""
}

Result Code

Name	Code	Reason	Solution
UNKNOWN_ERROR	400000	An unknown error occurred while processing the request.	Try again later
INVALID_REQUEST	400001	Parameter format is wrong or parameter transferring doesn't follow the rules.	Please check whether the parameters are correct.
INVALID_SIGNATURE	400002	Incorrect signature result	Check whether the signature parameter and method comply with signature algorithm requirements.
INVALID_TIMESTAMP	400003	Timestamp for this request is outside of the time window.	Sync server clock
INVALID_API_KEY_OR_IP	400004	API identity key not found or invalid.	Check API identity key
BAD_API_KEY_FMT	400005	API identity key format invalid.	Check API identity key.
BAD_HTTP_METHOD	400006	Request method not supported.	Check Request method.
MEDIA_TYPE_NOT_SUPPORTED	400007	Media type not supported.	Check Request Media type.
INVALID_REQUEST_BODY	400008	Request body is not a valid json object.	Check Request body
MANDATORY_PARAM_EMPTY_OR_MALFORMED	400100	A parameter was missing/empty/null, or malformed.
INVALID_PARAM_WRONG_LENGTH	400101	A parameter was not valid, was empty/null, or too long/short, or wrong format.
INVALID_PARAM_WRONG_VALUE	400102	A parameter was not valid, the value is out of range.
INVALID_PARAM_ILLEGAL_CHAR	400103	A parameter was not valid, contains illegal characters
INVALID_REQUEST_TOO_LARGE	400104	Invalid request, content length too large
ORDER_NOT_FOUND	400202	Order not found.
INVALID_ACCOUNT_STATUS	400203	Not support for this account, please check account status.