Skip to main content
GET
Get deposit instructions for an account

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Path Parameters

accountId
string<uuid>
required

Unique identifier for the account

Example:

"3486b413-93d3-4447-afce-2b9c9dc34a32"

assetType
string
required

The asset to retrieve deposit instructions for, fiat or crypto (e.g. "USD" or "BTC")

Response

successful

Deposit instructions for a single asset, across all rails this account supports for it.

assetType
string
required

A string representing a type of asset, which usually corresponds to the asset's ticker symbol. Use /asset-types to list all of the supported asset types for your organization.

Example:

"USD"

rails
(Wire Deposit Rail · object | Blockchain Deposit Rail · object)[]
required

Rails supported for depositing this asset (e.g. Wire, Blockchain).

Deposit instructions for a Wire (Fedwire) transfer.