Skip to main content

Binance Pay: Balance Report Notification

Webhook Endpoints

Binance Pay will send balance report events with final status only when partner use balance report open api for report generation. For submitting download request, refer here.

Request Parameters

AttributesTypeRequiredLimitationDescription
bizTypestringY-BALANCE
bizIdlongY-Download ID
bizIdStrstringY-biz id as string
bizStatusstringY-BALANCE_SUCCESS
dataBalanceReportDataY-JSON string

Child Attribute

BalanceReportData

AttributesTypeRequiredLimitationDescription
downloadTypestringYmerchant_balance_download_task
downloadIdlongYDownload ID, for any issue use this ID to query.
userIdlongYSpot user ID
statusstringY2 = success
downloadLinkstringYDownload URL.
expirationTimestamplongYExpiration timestamp of download link.
createTimestringYCreated time of the download document.

Sample Payload

{
"bizType": "BALANCE",
"data":"{\"downloadType\":\"merchant_balance_download_task\",\"downloadId\":197620356272996352,\"userId\":100102465376,\"status\":2,\"downloadLink\":\"https://sampleurl.com/file1\",\"expirationTimestamp\":1669947455000,\"createTime\":\"2022-12-01 02:15:50\",\"callbackUrl\":\"https://callbackurl.com\"}",
"bizIdStr": "197620356272996352",
"bizId": 197620356272996352,
"bizStatus": "BALANCE_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

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

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