On-ramp accounts
Get on-ramp requirements
Discover the funding rails and eligible wallets before issuing an on-ramp account.
GET
Discover on-ramp bank account options
Read
supportedDestinations and destinations for this environment. When no rail or eligible wallet is available, available is false and unavailableReason says why. Any other failure returns a normal HTTP error; do not treat it as unavailable. Issuance separately requires the account’s 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.
Disclose developerFeeBps before issuing a new account. New USD funding accounts use 25 bps (0.25%) deducted from each incoming deposit before conversion. A null rate means issuance pricing is unavailable. Existing facilities retain their own rate; read the facility rather than applying current issuance pricing to it.Authorizations
Headers
Path Parameters
Response
On-ramp bank account requirements
Rate to disclose before issuing a new USD funding account: 25 bps (0.25%), deducted from each incoming deposit before conversion. Null when issuance pricing is unavailable. Read an existing facility for its own frozen rate.
Required range:
0 <= x <= 10000Example:
25
Why the flow cannot be started, or null when it can.
Available options:
onramp_route_not_configured, no_eligible_destination, null