Skip to main content

Direct Debit Payment Notification

This API is used for Merchant/Partner to notify the upcoming direct debit payment. Please do note that there will be a 24H frozen period to apply the payment. This API is not needed for non-periodic payment. For periodic payment, please call the API 2-5 days prior to inform user of the deduction.

*This API is only available for whitelisted merchants. If you need any help, you can contact us: merchant@binance.com

EndPoint#

POST /binancepay/openapi/pay/notify

Request Parameters#

AttributesTypeRequiredLimitationDescription
subMerchantIdstringNmaximum length 19The sub merchant account id, issued when sub merchant been created at Binance, The parameter subMerchantId is required when configuring show subMerchant info.
merchantRequestIdstringYletter or digit, no other symbol allowed, maximum length 32The order id, Unique identifier for the request, idempotent result will be returned for same requestId
tradeModestringY"DIRECT_DEBIT"
bizIdLongYnumberbusiness orderId like contractId
estimatedAmountdecimalYMax Unit Range: 8 decimal placesAmount to be deducted, please ensure the amount do not exceed the singleUpperLimit of the contract.
currencystringYonly "USDT" can be accepted, fiat NOT supported.order currency

Sample Request Body#

{    "subMerchantId": 123,    "merchantRequestId": "abcd",    "tradeMode": "DIRECT_DEBIT",    "bizId":123,    "estimatedAmount": 6,    "currency":"USDT"}

Response Parameters#

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

Child Attribute#

DataObject#

AttributesTypeRequiredLimitationDescription
orderIdstringYmaximum length 19unique id generated by binance
merchantRequestIdstringYletter or digit, no other symbol allowed, maximum length 32The order id, Unique identifier for the request
transactionTimelongY-transaction time in milli seconds

Sample Response#

applied success#

{    "status": "SUCCESS",    "code": "000000",    "data": {        "merchantRequestId": "a0e29ab291fe6eeec5f13031b38ae284",        "orderId": "203740009645850624",        "transactionTime": 1672710635911    }}

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
MERCHANT_TRANSFER_MERCHANT_TYPE_INVALID406107Merchant type not valid not support individual merchant
MERCHANT_TRANSFER_MERCHANT_TOO_FREQUENT406108Fail rate is high, please try again later