Deposit APIs
Initiate deposit
Code
Create a deposit session. Returns a universal link for opening the Binance App authorization page where the user can authorize the Partner to access their deposit addresses.
The
externalOrderIdserves as an idempotency key. Calling this API multiple times with the sameexternalOrderIdwill return the same universal link.
Request Body
| Field | Type | Mandatory | Remarks |
|---|---|---|---|
| cryptoCurrency | string | Yes | Crypto currency. E.g. "USDT", "ETH" |
| networks | string array | Yes | Blockchain networks (one or more). E.g. ["BSC", "ETH", "SOL"]. Use depositEnable from the crypto-network API to check which networks support deposit. |
| externalOrderId | string | Yes | Partner's unique order ID (idempotency key). Supports only letters, numbers, hyphens and underscores. |
| amount | string | No | Expected deposit amount (display only, not enforced). This is shown to the user on the authorization page for reference. |
| redirectUrl | string | No | Partner web redirect URL. The user will be redirected to this URL after authorization in the Binance App. |
| redirectDeepLink | string | No | Partner native app deeplink. The user will be redirected to this deeplink after authorization in the Binance App. |
Response Body
| Field | Type | Remarks |
|---|---|---|
| link | string | Binance App universal link. Redirect the user to this link to open the deposit authorization page in the Binance App. |
| linkExpireTime | timestamp | The expiration time of the link (epoch milliseconds). After this time, the user can no longer authorize this deposit session. |
Example
Request Parameters:
Code
Response:
Code
Example - Single network
Request Parameters:
Code
Response:
Code
Was this page helpful?
Last modified on