Skip to main content

Query Collection Result

Query collection result API used for 3rd party application to collection order status

EndPoint#

POST https://bpay.binanceapi.com/binancepay/openapi/collection/query

Request Parameters#

AttributesTypeRequiredDescription
orderIdStringNOcollection order id in binance pay system, either trade no or collection order id should be provided
clientTradeNoStringNOmaximum length 32, trade no in client system, either trade no or collection order id should be provided

Response#

NameTypeRequiredDescription
statusStringYESstatus of the API request, "SUCCESS" or "FAIL"
codeStringYESrequest result code, refer to Result Code
dataQueryCollectionOrderRespYESresponse body, refer to QueryCollectionOrderResp
errorMessagestringYES

QueryCollectionOrderResp:#

AttributesTypeRequiredDescription
orderIdStringYES
clientTradeNoStringYESmaximum length 32
statusStringYES"INITIAL", "PENDING", "PAID"

Result Code#

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
PAYMENT_C2C_COLLECTION_ORDER_NOT_FOUND400207collection order not foundCheck request property value