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: [email protected]
In situation where event was signed to terminated, the webhook will retry up to 6 times to resend the event.
Request Parameters
| Attributes | Type | Required | Limitation | Description |
|---|---|---|---|---|
| bizType | string | Y | - | "DIRECT_DEBIT_CT" |
| bizId | long | Y | - | contract id |
| bizIdStr | string | Y | - | biz id as string |
| bizStatus | string | Y | - | "CONTRACT_SIGNED","CONTRACT_TERMINATED","CONTRACT_EXPIRED" |
| data | string | Y | - | JSON string, data details refer to |
Child Attribute
Notification Data
| Attributes | Type | Required | Limitation | Description |
|---|---|---|---|---|
| merchantContractCode | string | Y | letter or digit, no other symbol allowed, maximum length 32 | The unique ID assigned by the merchant to identify a direct debit contract request. |
| contractId | Long | Y | maximum length 19 | contract id |
| serviceName | string | Y | maximum length 32 | service name |
| openUserId | string | N | - | payer unique id |
| merchantAccountNo | string | N | maximum length 64 | the userID/user account in merchant side e.g. [email protected] |
| singleUpperLimit | decimal | Y | Max Unit Range: 8 decimal places | upper limit |
| currency | string | Y | - | currency |
| contractTerminationWay | int | N | - | 0-by user, 1-auto expire, 2-by operation team. only "CONTRACT_TERMINATED" status |
| contractTerminationTime | Long | N | - | only "CONTRACT_TERMINATED" status |
Sample Payload
CONTRACT SIGNED
Code
CONTRACT TERMINATED
Code
Response Parameters
| Attributes | Type | Required | Limitation | Description |
|---|---|---|---|---|
| returnCode | string | Y | "SUCCESS" or "FAIL" | result code of notification processing, if process fail, Binance Pay will retry |
| returnMessage | string | N | - | return message |
Sample Response
After receiving a webhook with your endpoint, please respond with an HTTP 200 OK.
Code
Was this page helpful?
Last modified on