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

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

Properties

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

Properties

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

Properties

​
account_number
string | null
required
Bank account number for deposits in this currency.
​
currency
string
required
Currency supported by these bank instructions.
​
deposit_bank_name
string | null
required
Receiving bank name.
​
deposit_beneficiary_name
string | null
required
Beneficiary name to use for transfer.
​
deposit_reference
string | null
required
Reference to include with bank transfer.
​
rails
string[]
required
Active deposit rails for this currency, such as ach, wire, or sepa.
​
routing_number
string | null
required
Bank routing number for deposits in this currency.
​
crypto
object[]
required
Crypto networks available for this deposit, each with its on-chain deposit address and the tokens accepted on that network.

Properties

​
deposit_address
string | null
required
Address to send funds to on this network. Null when the provider has not issued one yet.
​
icon_url
string | null
required
Network icon URL.
​
name
string
required
Network display name, such as Ethereum or Solana.
​
supported_currencies
object[]
required
Tokens accepted for deposit on this network.

Properties

​
icon_url
string | null
required
Token icon URL. Null when no icon is available.
​
name
string
required
Token symbol, such as USDC.
​
object
string
required
Deposit