Skip to main content
Deposits describe the ways to add funds to an account or user balance: a hosted deposit page, bank transfer instructions, and crypto wallet addresses. Use the Deposits API to get deposit instructions for an account or user, such as a crypto address to send funds to or bank details for a transfer.

​
Endpoints

​
Attributes

​
string | null
required
Account ID of the destination owner.
​
string
Requested deposit amount.
​
string | null
required
URL of the hosted deposit page. Only present for business destinations.
​
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 | null
required
The charge to a saved payment method. Null unless payment_method_id was passed.

Properties

​
string
required
The payment the charge created, prefixed pay_. Retrieve it, or listen for payment.succeeded, to confirm the funds landed.
​
string
required
The saved payment method that was charged, prefixed payt_.
​
object[]
required
Crypto networks available for this deposit, each with its on-chain deposit address and the tokens accepted on that network. Crypto deposits require a $10 minimum.

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, Bitcoin, 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, BTC, ETH, EURC, HYPE, PYUSD, SOL, USD1, USDC, USDC.e, USDG, USDT, USDT0, USDe, USDm, XO, XPL, pUSD, wETH
​
string
required
Deposit