Get Deposit Address
Get Deposit Address
Endpoint: POST /getDepositAddress
Description: Retrieves an L1 address for a user to deposit into on the specified network.
Request Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| network | NetworkSymbol | Yes | L1 network (e.g., ETH) |
| identifier | string | Yes | UserID or similar identifier |
| referenceId | string | No | Optional reference ID to identify the deposit order |
Response:
{
"address": "string",
"identifier": "string"
}
Get Deposit Address With Requested Value
Endpoint: POST /getDepositAddressWithRequestedValue
Description: Retrieves an L1 address 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 |
|---|---|---|---|
| network | NetworkSymbol | Yes | L1 network (e.g., ETH) |
| 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, USDC, USD) |
| requestedAmount | string | Yes | Requested amount (as a string to avoid precision issues) |
| token | TokenSymbol | No | Optional token symbol (e.g., USDT) |
| markupPercentage | number | No | Mark up percentage to be applied on the exchange rate (min: -100, max: 100) |
Response:
{
"address": "string",
"identifier": "string",
"referenceId": "string",
"requestedAmount": "string",
"requestedCurrency": "string",
"network": "string",
"token": "string",
"exchangeRate": "string",
"amount": "string"
}