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
merchantIdlongY-The merchant account id, issued when merchant been created at Binance.
subMerchantIdlongN-The sub merchant account id, issued when sub merchant been created at Binance.
merchantTradeNostringNletter or digit, no other symbol allowed, can not be empty if prepayId is emptyThe order id, Unique identifier for the request
prepayIdstringNletter 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:

{  "merchantId": 987321472,  "subMerchantId": 987321472,  "merchantTradeNo": "9825382937292",  "prepayId": null}

Query order result by prepayId:

{  "merchantId": 987321472,  "subMerchantId": 987321472,  "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
errorMessagestringY-

Child Attribute#

QueryOrderResult#

AttributesTypeRequiredLimitationDescription
merchantIdlongY-The merchant account id, issued when merchant been created at Binance.
prepayIdstringY-unique id generated by binance
transactionIdstringN-issued once the payment is successful
merchantTradeNostringY-letter or digit, no other symbol allowed, can not be empty if prepayId is empty
tradeTypestringY"WEB", "APP"operate entrance
statusstringY"INITIAL", "PENDING", "PAID", "CANCELED", "ERROR", "REFUNDING", "REFUNDED", "EXPIRED"order status
currencystringY-order currency
totalFeedecimalY-order amount
productNamestringY-product name
productDetailstringY-product detail
openUserIdstringN-Consumer unique id
transactTimelongN-Timestamp when transaction happened
createTimelongY-Timestamp when order was created
payerInfostringNonly merchant got approved by Binance Operation's approval will receive this payerInfopayer information, refer to

PayerInfo Data#

AttributesTypeRequiredLimitationDescription
firstNamestringY-first name
middleNamestringN-middle name
lastNamestringY-last name
walletIdstringY-wallet id
countrystringN-residential country
citystringN-residential city
addressstringN-residential address
identityTypestringN-identity type
identityNumberstringN-identify number
dateOfBirthstringN-date of birth
placeOfBirthstringN-original place of birth
nationalitystringN-payer nationality

Sample Response#

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

Result Code#

NameCodeReasonSolution
UNKNOW_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.
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
INVALID_MERCHANT_TRADE_NO400201merchantTradeNo is invalid or duplicated
ORDER_NOT_FOUND400202Order not found.
INVALID_ACCOUNT_STATUS400203Not support for this account, please check account status.