Binance Pay: Order Notification
#
Webhook EndpointsBinance Pay will send order events with final status to partner for notification. You will be able to configure webhook endpoints via the Binance Merchant Admin Portal. Result of the orders that are close will be notified to you through this webhook with bizStatus = "PAY_CLOSED".*
*In the event you did not receive "PAY_CLOSED" notification, please contact us: merchant@binance.comIn situation where event was failed to send, the webhook will retry up to 6 times to resend the event.
#
Request ParametersAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
bizType | string | Y | - | "PAY" |
bizId | long | Y | - | Prepay order id |
bizIdStr | string | Y | - | biz id as string |
bizStatus | string | Y | - | "PAY_SUCCESS","PAY_CLOSED" |
data | string | Y | - | JSON string, data details refer to |
#
Child Attribute#
Notification DataAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
merchantTradeNo | string | Y | letter or digit, no other symbol allowed | The order id, Unique identifier for the request |
productType | string | Y | maximum length 16 | product type |
productName | string | Y | maximum length 256 | product name |
transactTime | long | Y | - | transaction time |
tradeType | string | Y | "WEB", "APP", "WAP", "MINI_PROGRAM", "PAYMENT_LINK", "OTHERS" | operate entrance |
totalFee | decimal | Y | - | order amount |
currency | string | Y | - | order currency |
transactionId | string | N | - | debit transaction id |
openUserId | string | N | - | payer unique id |
passThroughInfo | string | N | - | pass through info, from the create order api |
commission | decimal | Y | - | Transaction fees charged. Please refer to your contract for more info |
paymentInfo | object | N | - | payment information, refer to |
#
PaymentInfo DataAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
payerId | long | Y | - | payer pay id |
payMethod | string | Y | - | pay method |
paymentInstructions | list[PaymentInstruction] | Y | - | payment instruction list, refer to |
channel | string | N | - | channel |
subChannel | string | N | - | sub channel |
#
PaymentInstruction DataAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
currency | string | Y | - | payment currency |
amount | decimal | Y | - | currency amount |
price | decimal | Y | - | currency price |
#
Sample Payload#
PAY SUCCESS#
PAY FAIL#
Response ParametersAttributes | 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 ResponseAfter receiving a webhook with your endpoint, please respond with an HTTP 200 OK.