Skip to main content

Direct Debit/Pre Authorization Notification

Webhook Endpoints#

Binance Pay will send direct debit/pre authorization contract events to partner for notification. You will be able to configure webhook endpoints via the Binance Merchant Admin Portal.

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

In situation where event was signed to terminated, the webhook will retry up to 6 times to resend the event.

Request Parameters#

AttributesTypeRequiredLimitationDescription
bizTypestringY-"DIRECT_DEBIT_CT"
bizIdlongY-contract id
bizIdStrstringY-biz id as string
bizStatusstringY-"CONTRACT_SIGNED","CONTRACT_TERMINATED"
datastringY-JSON string, data details refer to

Child Attribute#

Notification Data#

AttributesTypeRequiredLimitationDescription
merchantContractCodestringYletter or digit, no other symbol allowed, maximum length 32The unique ID assigned by the merchant to identify a direct debit contract request.
contractIdLongYmaximum length 19contract id
serviceNamestringYmaximum length 32service name
openUserIdstringN-payer unique id
merchantAccountNostringNmaximum length 64the userID/user account in merchant side e.g. xxx@gmail.com
singleUpperLimitdecimalYMax Unit Range: 8 decimal placesupper limit
currencystringY-currency
contractTerminationWayintN-0-by user, 1-auto expire, 2-by operation team. only "CONTRACT_TERMINATED" status
contractTerminationTimeLongN-only "CONTRACT_TERMINATED" status

Sample Payload#

CONTRACT SIGNED#

{  "bizType": "DIRECT_DEBIT_CT",  "data": "{\"merchantContractCode\":\"a9d1deffaecba9f592aa682b5c997042\",\"contractId\":205638372306477056,\"serviceName\":\"Tra Direct Debit\",\"openUserId\":\"04fdfaf5c88d746168e3cc0a582b65d4\",\"merchantAccountNo\":\"sss@gmail.com\",\"currency\":\"USDT\",\"singleUpperLimit\":50.00000000}",  "bizIdStr": "205638372306477056",  "bizId": 205638372306477056,  "bizStatus": "CONTRACT_SIGNED"}

CONTRACT TERMINATED#

{  "bizType": "DIRECT_DEBIT_CT",  "data": "{\"merchantContractCode\":\"a9d1deffaecba9f592aa682b5c997042\",\"contractId\":205638372306477056,\"serviceName\":\"Tra Direct Debit\",\"openUserId\":\"04fdfaf5c88d746168e3cc0a582b65d4\",\"merchantAccountNo\":\"sss@gmail.com\",\"currency\":\"USDT\",\"singleUpperLimit\":50.00000000,\"contractTerminationWay\":0,\"contractTerminationTime\":1673594769902}",  "bizIdStr": "205638372306477056",  "bizId": 205638372306477056,  "bizStatus": "CONTRACT_TERMINATED"}

Response Parameters#

AttributesTypeRequiredLimitationDescription
returnCodestringY"SUCCESS" or "FAIL"result code of notification processing, if process fail, Binance Pay will retry
returnMessagestringN-return message

Sample Response#

After receiving a webhook with your endpoint, please respond with an HTTP 200 OK.

{"returnCode":"SUCCESS","returnMessage":null}