Skip to main content
GET
List onramp options

Headers

x-api-key
string

Integrator API key: the project’s orders

x-user-country
string

Trusted edge-resolved ISO country. When present it overrides body.baseCountry and x-client-ip, and enables country-specific payment-method validation.

Pattern: ^[A-Z]{2}$
Example:

"PH"

x-client-ip
string

The end user's IP address as observed by the edge, for edges that can name the IP but cannot resolve a country themselves (no local GeoIP database). Used only when x-user-country is absent, and ignored unless it is a publicly-routable address. Prefer x-user-country when your edge already has a country — for example Cloudflare's cf-ipcountry — since it needs no lookup here.

Example:

"203.0.113.7"

authorization
string

Customer bearer from POST /compliance/sessions: that customer’s orders, and every order on its bound account

Example:

"Bearer eyJhbGciOi..."

Query Parameters

provider
enum<string>
required
Available options:
swapped,
noah
kind
enum<string>

swapped only, required there

Available options:
fiat,
exchange
currency
enum<string>

noah only. One option for this currency; both without

Available options:
EUR,
USD
connections
string

swapped exchange only. Comma-separated allowlist, served in catalogue order; an unknown slug is a 400

Maximum string length: 1024
connectionKind
enum<string>

swapped exchange only, ignored with connections

Available options:
exchange,
wallet,
all

Response

The options

provider
enum<string>
required
Available options:
swapped
kind
enum<string>
required
Available options:
fiat
country
string | null
required

Null when the country or catalogue is unknown; fall back to your own defaults

Pattern: ^[A-Z]{2}$
Example:

"US"

methods
object[]
required

Curated: the deposit modal’s rows (regional Popular pick, card, bank transfer, Apple Pay)

otherMethods
object[]
required

Every other method Swapped offers in the country, in its order; pass any as method on POST /onramp/orders