Batch Payout Notification
Webhook Endpoints#
Request Parameters#
| Attributes | Type | Required | Limitation | Description |
|---|---|---|---|---|
| bizType | string | Y | - | PAYOUT |
| bizId | long | Y | - | Payout ID |
| bizIdStr | string | Y | - | biz id as string |
| bizStatus | string | Y | - | Same as Payout Query batchStatus |
| data | TransferQueryResult | Y | - | JSON string |
Child Attribute#
TransferQueryResult#
| Attributes | Type | Required | Limitation | Description |
|---|---|---|---|---|
| requestId | string | Y | Maximum length 32 | The passed-in request ID |
| batchStatus | string | Y | Enum string | ACCEPTED: accepted the request, will process it soon. PROCESSING: batch under processing SUCCESS: all transfers are successful PART_SUCCESS: transfers partially succeeded FAILED: all transfers failed CANCELED: there remains transfers with unknown results after retry limit, will not retry further |
| merchantId | long | Y | ||
| currency | string | Y | Valid crypto currency | The request currency. |
| totalAmount | decimal | Y | Total transfer amount in this batch. | |
| totalNumber | int | Y | Maximum length 1000 | Total number of transfers in the batch. |
Sample Payload#
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.