Skip to main content
GET
Discover on-ramp bank account options
Discover enabled USD funding rails and eligible wallets before issuing an on-ramp account. Read supportedDestinations and destinations for this environment. Missing configuration returns available: false; unexpected storage or routing failures use normal HTTP errors. Issuance separately requires account-level bank_onramp approval. recipientOnFile reports whether a verified recipient name and address can be reused. When true, omit recipientType, recipientName and recipientAddress together at issuance. Otherwise, supply all three. This flag does not grant bank access or replace capability approval.

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"

Response

On-ramp bank account requirements

accountId
string
required
Example:

"acct_123"

recipientOnFile
boolean
required

True when a verified name and address is on file, so the funding account can be created without recipient details.

available
boolean
required

True only when at least one rail has an operational route and at least one connected wallet is on a verified destination.

unavailableReason
enum<string> | null
required

Why the flow cannot be started, or null when it can.

Available options:
onramp_route_not_configured,
no_eligible_destination,
null
supportedDestinations
object[]
required

Provider-verified delivery chains and assets, including when this UPA has no eligible wallet. This catalog does not grant rail access or account-level compliance approval.

recipientTypes
enum<string>[]
required
Available options:
individual,
business
rails
object[]
required

Rails with an operational provider route in this environment. A route may exist for one rail and not another.

destinations
object[]
required

Connected wallets on a provider-verified destination chain, with the asset codes verified for that chain.