Skip to main content
GET
Get deposit instructions for an on-ramp bank account
Returns the beneficiary name, bank, ABA routing number and account number the account holder should send funds to, plus where converted funds are delivered. This is the only endpoint that returns the full account number: call it from your backend, show the details to the account holder, and never log or store them. Responses are marked Cache-Control: no-store, private. rail identifies the rail requested at issuance. acceptedRails lists the rails the sender can use with these instructions: those issued on the account and currently enabled for your app. Display those choices rather than assuming the requested rail is the only one available. Only an active on-ramp bank account has instructions; any other status returns 409. See Depositing funds.

Authorizations

Authorization
string
header
required

HTTP Basic auth. Username is the Stableyard app ID. Password is the app secret. The optional Stableyard-Version request header must match the environment pin.

Headers

Stableyard-Version
enum<string>

Optional contract-version assertion. Omit it to use the app environment's pinned version. A different supported version is accepted only after that environment is explicitly migrated.

Available options:
2026-09-09

Path Parameters

accountId
string
required

Canonical account id returned by the Accounts API.

Example:

"acct_123"

onrampBankAccountId
string
required

Id returned when the on-ramp bank account was issued.

Example:

"onramp_acct_123"

Response

Deposit instructions

id
string
required
Example:

"onramp_acct_123"

accountId
string
required
rail
enum<string> | null
required

The rail named when the account was requested.

Available options:
ach,
fedwire,
fednow,
null
acceptedRails
enum<string>[]
required

Every rail a sender can use with these bank details: what the account was issued with, limited to the rails enabled for the app.

Available options:
ach,
fedwire,
fednow
Example:
currency
string
required
Example:

"USD"

destination
object
required

Where converted funds are delivered.

beneficiary
object
required

The account holder name to put on the transfer.

bank
object
required