Binance Pay: Order Notification

Webhook Endpoints#

Binance Pay will send order final status to partner for notification. You can configure webhook endpoints via the Binance Merchant Admin Portal to be notified about order events.

Request Parameters#

AttributesTypeRequiredLimitationDescription
bizTypestringY-"PAY", "REFUND"
bizIdstringY-Prepay order id
bizStatusstringY-"PAY_SUCCESS","PAY_FAILED","PAY_EXPIRED","REFUND_INITIAL","REFUND_SUCCESS","REFUND_REJECTED"
datastringY-JSON string, data details refer to

Child Attribute#

Notification Data#

AttributesTypeRequiredLimitationDescription
merchantTradeNostringYletter or digit, no other symbol allowedThe order id, Unique identifier for the request
productTypestringYmaximum length 16product type
productNamestringYmaximum length 256product name
tradeTypestringY"WEB", "APP"operate entrance
totalFeedecimalY-order amount
currencystringY-order currency
transactTimelongN-Timestamp when transaction happened
openUserIdstringN-Consumer unique id
commissiondecimalY-Commission fee if any

Sample Request#

{
"bizType": "PAY",
"data": "{\"merchantTradeNo\":\"9825382937292\",\"totalFee\":0.88000000,\"transactTime\":1619508939664,\"currency\":\"EUR\",\"commission\":0,\"openUserId\":\"1211HS10K81f4273ac031\",\"productType\":\"Food\",\"productName\":\"Ice Cream\",\"tradeType\":\"WEB\",\"transactionId\":\"M_R_282737362839373\"}",
"bizId": 29383937493038367292,
"bizStatus": "PAY_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}