Deposit URL
Get Deposit URL
Endpoint: POST /getDepositUrl
Description: Retrieves a deposit page URL where users can get addresses for multiple currencies.
Request Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| identifier | string | Yes | UserID or similar identifier |
| referenceId | string | No | Optional reference ID to identify the deposit order |
| receiveCurrencies | Currency[] | No | Array of currencies to show (e.g., ['USDT', 'USDC', 'ETH', 'TRX'])Supported currencies: USDT, USDC, ETH, TRX only |
| networks | NetworkSymbol[] | No | Array of networks |
| redirectUrl | string | No | Redirect URL after user deposit |
Response:
{
"url": "string"
}
Get Deposit URL With Requested Value
Endpoint: POST /getDepositUrlWithRequestedValue
Description: Retrieves a deposit page URL with a requested value. The first deposit matching the requested value triggers the referenceId. Other deposits trigger callbacks without the referenceId.
Request Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| identifier | string | Yes | UserID or similar identifier |
| referenceId | string | Yes | Reference ID to identify the deposit order |
| requestedCurrency | Currency | Yes | Requested currency (e.g., USDT, USD) |
| requestedAmount | string | Yes | Requested amount (as a string to avoid precision issues) |
| receiveCurrencies | Currency[] | No | Array of currencies to show (e.g., ['USDT', 'USDC', 'ETH'])Supported currencies: USDT, USDC, ETH, TRX only |
| networks | NetworkSymbol[] | No | Array of networks |
| markupPercentage | number | No | Mark up percentage to be applied on the exchange rate (min: -100, max: 100) |
| redirectUrl | string | No | Redirect URL after user deposit |
Response:
{
"url": "string"
}