Get on-ramp requirements
Returns the USD funding-account rails enabled for this app and environment, and the UPA’s connected wallets on provider-verified destination chains with their supported assets. Call this before rendering the creation form. The current delivery allowlist is Arbitrum One USDC in production and Arbitrum Sepolia USDC in staging/sandbox; read supportedDestinations and destinations for this environment rather than using the general network catalog. Discovery and bank-account issuance have no payment amount; routing still checks app entitlements, market access, and the active provider program’s bank_onramp grant. Missing routes, access, or eligible destinations return available: false with a reason. Unexpected storage or routing errors return the normal HTTP error response and must not be treated as missing configuration. Creation separately requires an active account-level compliance relationship and rejects unverified destination chain/asset pairs with payment_method_not_supported. An advertised destination does not establish live production certification.
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
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
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.
2026-09-09 Path Parameters
Canonical account id returned by the Accounts API.
"acct_123"
Response
On-ramp bank account requirements
"acct_123"
True when a verified name and address is on file, so the funding account can be created without recipient details.
True only when at least one rail has an operational route and at least one connected wallet is on a verified destination.
Why the flow cannot be started, or null when it can.
onramp_route_not_configured, no_eligible_destination, null 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.
individual, business Rails with an operational provider route in this environment. A route may exist for one rail and not another.
Connected wallets on a provider-verified destination chain, with the asset codes verified for that chain.