Skip to main content
Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses. Use the Deposits API to create deposit instructions for an account.

Endpoints

Attributes

string | null
required
Account ID of the destination owner. Null for raw wallet address destinations.
string
Requested deposit amount.
string | null
required
URL of the hosted deposit page. Only present for business destinations.
object
required
Metadata from the request.
object
required
Available deposit methods for destination.

Properties

object | null
required
Bank deposit details. Only present when bank deposits are active for the destination account.

Properties

object[]
required
Bank transfer currencies available for this deposit.

Properties

string | null
required
Bank account number for deposits in this currency.
string
required
Currency supported by these bank instructions.
string | null
required
Receiving bank address.
string | null
required
Receiving bank name.
string | null
required
Beneficiary name to use for transfer.
string | null
required
Reference to include with bank transfer.
string[]
required
Active deposit rails for this currency.Available options: ach, wire, sepa, fps, chaps
string | null
required
Bank routing number for deposits in this currency.
string | null
required
SWIFT/BIC code for international wires, when available.
object[]
required
Crypto networks available for this deposit, each with its on-chain deposit address and the tokens accepted on that network.

Properties

string | null
required
Address to send funds to on this network. Null when the provider has not issued one yet.
string | null
required
Network icon URL.
string
required
Network display name.Available options: Ethereum, Solana, Base, BNB Smart Chain, Hyperliquid, Hypercore, MegaETH, Polygon, Plasma, Arbitrum
object[]
required
Tokens accepted for deposit on this network.

Properties

string | null
required
Token icon URL. Null when no icon is available.
string
required
Token symbol.Available options: ARB, BNB, ETH, EURC, HYPE, PYUSD, SOL, USD1, USDC, USDC.e, USDG, USDT, USDT0, USDe, USDm, XO, XPL, pUSD, wETH
string
required
Deposit