Skip to main content

Batch Payout Notification

Webhook Endpoints#

Request Parameters#

AttributesTypeRequiredLimitationDescription
bizTypestringY-PAYOUT
bizIdlongY-Payout ID
bizStatusstringY-Same as Payout Query batchStatus
dataTransferQueryResultY-JSON string

Child Attribute#

TransferQueryResult#

AttributesTypeRequiredLimitationDescription
requestIdstringYMaximum length 32The passed-in request ID
batchStatusstringYEnum stringACCEPTED: 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
merchantIdlongY
currencystringYValid crypto currencyThe request currency.
totalAmountdecimalYTotal transfer amount in this batch.
totalNumberintYMaximum length 1000Total number of transfers in the batch.

Sample Request#

{  "bizType": "PAYOUT",  "data": "{\"batchStatus\":\"SUCCESS\",\"currency\":\"BUSD\",\"merchantId\":100100006288,\"requestId\":\"gg8127129\",\"totalAmount\":2.00000000,\"totalNumber\":2}",  "bizId": 29383937493038367292,  "bizStatus": "SUCCESS"}

Response Parameters#

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

Sample Response#

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