Deposit Webhook
Whenever the deposit authorization status changes (user authorizes or rejects), Binance Connect will send a webhook message to the Partner's configured webhook callback URL. The Partner can receive this message and react accordingly, such as displaying the deposit addresses or notifying the user of a rejection.
Note: Webhook is the primary delivery mechanism for deposit status changes. Polling via
/deposit/authorizationis available as a fallback in case the webhook is missed or not yet integrated. See Query deposit authorization.
Request Headers
| Field | Type | Remarks |
|---|---|---|
| X-BN-Connect-Timestamp | timestamp | Timestamp |
| X-BN-Connect-Signature | string | SHA256withRSA(requestBody + X-Connect-Timestamp) |
| X-BN-Connect-For | string | Same with your client id (X-Tesla-ClientId) |
How signature works: The signature verification process is the same as the existing Connect webhook. Binance signs the webhook payload with its private key, and the Partner verifies using Binance's public key.
Request Body
| Field | Type | Remarks |
|---|---|---|
| webhookEventType | string | Fixed value: deposit_status_event |
| externalOrderId | string | Partner's unique order ID (same as the one used in /deposit/initiate). |
| status | int | Authorization status: 1 = AUTHORIZED, 2 = REJECTED. Please refer to "Deposit authorization status". |
| cryptoCurrency | string | Crypto currency |
| depositAddresses | object array | Deposit addresses per network. Present when status = 1 (AUTHORIZED), empty array when REJECTED. Refer to DepositAddressObject. |
| updateTime | timestamp | Status change time (epoch milliseconds) |
DepositAddressObject
| Field | Type | Remarks |
|---|---|---|
| depositAddress | string | Deposit address for this network |
| network | string | Blockchain network. E.g. "BSC", "ETH", "SOL" |
| addressTag | string | Address memo/tag (for networks like XRP, XLM, etc.). Null if not required |
Response Body
- HTTP status code should be 200
- Response body is in JSON format.
| Field | Type | Remarks |
|---|---|---|
| returnCode | string | SUCCESS or other code you wish to return to Binance Connect |
| returnMessage | string | The message you wish to return to Binance Connect |
Example - AUTHORIZED (with deposit addresses)
Request Body:
Code
Example - REJECTED
Request Body:
Code