Skip to main content

Query Order

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

EndPoint#

POST /binancepay/openapi/order/query

Request Parameters#

AttributesTypeRequiredLimitationDescription
merchantTradeNostringNmaximum length 32,letter or digit, no other symbol allowed, can not be empty if prepayId is emptyThe order id, Unique identifier for the request
prepayIdstringNmaximum length 19,letter or digit, no other symbol allowed, can not be empty if merchantTradeNo is emptyBinance 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#

AttributesTypeRequiredLimitationDescription
statusstringY"SUCCESS" or "FAIL"status of the API request
codestringY-request result code, refer to
dataQueryOrderResultN-response body, refer to
errorMessagestringNmaximum length 256

Child Attribute#

QueryOrderResult#

AttributesTypeRequiredLimitationDescription
merchantIdlongY-The merchant account id, issued when merchant been created at Binance.
prepayIdstringYmaximum length 19unique id generated by binance
transactionIdstringNmaximum length 32issued once the payment is successful
merchantTradeNostringYmaximum length 32merchant trade number
tradeTypestringY"WEB", "APP", "WAP", "MINI_PROGRAM", "PAYMENT_LINK", "OTHERS"operate entrance
statusstringY"INITIAL", "PENDING", "PAID", "CANCELED", "ERROR", "REFUNDING", "REFUNDED", "EXPIRED"order status
currencystringY-order currency
totalFeedecimalYlimitation refer to Create Order API order amountorder amount
productNamestringNmaximum length 256product name
productDetailstringNmaximum length 256product detail
openUserIdstringNmaximum length 19Consumer unique id
transactTimelongN-UnixTimestamp in milliseconds when transaction happened
createTimelongY-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": "BUSD",    "totalFee": 10.88,    "productName": "Ice Cream",    "productDetail": "Greentea ice cream cone",    "openUserId": "",    "transactTime": 1425744000123,    "createTime": 1425744000000  },  "errorMessage": ""}

Result Code#

NameCodeReasonSolution
UNKNOWN_ERROR400000An unknown error occurred while processing the request.Try again later
INVALID_REQUEST400001Parameter format is wrong or parameter transferring doesn't follow the rules.Please check whether the parameters are correct.
INVALID_SIGNATURE400002Incorrect signature resultCheck whether the signature parameter and method comply with signature algorithm requirements.
INVALID_TIMESTAMP400003Timestamp for this request is outside of the time window.Sync server clock
INVALID_API_KEY_OR_IP400004API identity key not found or invalid.Check API identity key
BAD_API_KEY_FMT400005API identity key format invalid.Check API identity key.
BAD_HTTP_METHOD400006Request method not supported.Check Request method.
MEDIA_TYPE_NOT_SUPPORTED400007Media type not supported.Check Request Media type.
INVALID_REQUEST_BODY400008Request body is not a valid json object.Check Request body
MANDATORY_PARAM_EMPTY_OR_MALFORMED400100A parameter was missing/empty/null, or malformed.
INVALID_PARAM_WRONG_LENGTH400101A parameter was not valid, was empty/null, or too long/short, or wrong format.
INVALID_PARAM_WRONG_VALUE400102A parameter was not valid, the value is out of range.
INVALID_PARAM_ILLEGAL_CHAR400103A parameter was not valid, contains illegal characters
INVALID_REQUEST_TOO_LARGE400104Invalid request, content length too large
ORDER_NOT_FOUND400202Order not found.
INVALID_ACCOUNT_STATUS400203Not support for this account, please check account status.