Skip to main content
GET
Get Deposit Instruction
Returns the account’s default instruction for one currency: the bank details a payer needs to fund the trading account in that currency. This endpoint covers fiat deposits only. To receive crypto, create a wallet. See the Deposit Flows guide for the full picture. Requires an API key with read access on the accounts scope.

Which instruction you get

Dedicated-account instructions come before memo-routed instructions, and within each kind the oldest first. An account that holds several instructions for one currency, across providers or a mix of both kinds, sees only the default; List Deposit Instructions returns all of them.

Path Parameters

string
required
The account’s external ID (starts with acct_)
string
required
A currency code the API supports, for example USD, EUR or GBP. A code outside the supported set is rejected with 422; it does not produce the unavailable object below.

Response

Two shapes come back, both with HTTP 200: the instruction when the account has one for that currency, and an unavailable object when it does not. Branch on status.

When available

string
Unique identifier for this deposit instruction. Dedicated-account instructions use fi_…; legacy records may use va_…. Shared-account instructions use di_…. Check memo to determine whether a payment reference is required.
string
Always returns "deposit_instruction"
string
The account these instructions belong to (starts with acct_)
string
The requested currency code
string
Always returns "active" on this shape. A revoked source is never returned
string
Name the payer should address the payment to. Nullable.
string
Address of the beneficiary. Nullable.
string
Name of the receiving bank. Nullable.
string
Address of the receiving bank. Nullable.
string
Name on the receiving bank account. Nullable.
string
Bank account number. Nullable.
string
International Bank Account Number. Nullable.
string
SWIFT/BIC code of the receiving bank. Nullable.
string
Routing number, for US rails. Nullable.
string
Sort code, for UK rails. Nullable.
string
Payment reference required for shared-account instructions. The payer must include the returned value exactly. null for dedicated-account instructions.
string
Name of the intermediary bank, when the partner requires one for correspondent routing. Nullable.
string
SWIFT/BIC of the intermediary bank. Nullable.
array
Payment rails this instruction accepts. Values: ach, fedwire, swift, sepa, spei, pix, faster_payments.
string
ISO 8601 timestamp when created
string
ISO 8601 timestamp when last updated, or null

When unavailable

Returned with HTTP 200, not 404, when the account has no instruction for a currency the API otherwise supports.
string
Always returns "deposit_instruction"
string
The requested currency code
string
Always returns "unavailable"
string
Human-readable explanation

Errors

Response Examples

Available

Unavailable