Skip to main content

Close Order

Close order API used for merchant/partner to close order without any prior payment activities triggered by user. The successful close result will be notified asynchronously through Order Notification Webhook with bizStatus = "PAY_CLOSED"

EndPoint#

POST /binancepay/openapi/order/close

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
databooleanN-equals to true when status="SUCCESS",which is close request is accepted,and successful close result will be notified asynchronously through Order Notification Webhook
errorMessagestringN-error description when status="FAIL"

Sample Response#

{  "status": "SUCCESS",  "code": "000000",  "data": true,  "errorMessage": null}

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.
INVALID_ORDER_STATUS400204The Order is not applicable to close as it was paid or has any payment activity on the way.