Skip to main content
GET
curl

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

Query Parameters

from_symbol
string
required

Source asset ticker symbol (e.g. USD) — the asset the user pays with. Use GET /v1/ramp/fiat-currencies to discover supported source currencies. Ticker symbol of an asset (e.g. BTC, USDC, EUR).

Required string length: 3 - 16
Example:

"BTC"

from_type
enum<string>
default:fiat

Classification of the source asset. Pair with from_symbol to disambiguate when the same ticker exists across asset classes (e.g. USDC as stablecoin vs crypto). Defaults to fiat. Only fiat sources are currently supported (on-ramp).

Available options:
fiat,
crypto,
stablecoin,
xstock
from_method
string
required

Funding method used for the source side. Use GET /v1/ramp/payment-methods to discover supported payment methods.

from_amount
string<decimal128>
required

Amount to spend, denominated in the source asset, as a decimal string.

Required string length: 1 - 64
Pattern: ^-?[0-9]+(\.[0-9]+)?$
Example:

"1.23"

to_symbol
string
required

Destination asset ticker symbol (e.g. BTC) — the asset the user receives. Use GET /v1/ramp/buy/crypto to discover supported destination assets. Ticker symbol of an asset (e.g. BTC, USDC, EUR).

Required string length: 3 - 16
Example:

"BTC"

to_type
enum<string>
default:crypto

Classification of the destination asset. Pair with to_symbol to disambiguate when the same ticker exists across asset classes (e.g. USDC as stablecoin vs crypto). Defaults to crypto. Only crypto and stablecoin destinations are currently supported (on-ramp).

Available options:
fiat,
crypto,
stablecoin,
xstock
to_method
string
required

Withdrawal method for the destination asset. Use GET /v1/ramp/buy/crypto to discover available withdrawal methods for each asset.

to_network
string

Optional withdrawal network identifier. Use GET /v1/ramp/buy/crypto to discover available networks for each destination asset.

to_address
string

Optional destination wallet address for the crypto withdrawal.

to_memo
string

Optional memo/tag/note for the crypto withdrawal (used for certain assets).

affiliate_fee_bps
string<bps>

Affiliate fee in basis points to attribute to the partner (0-10000 where 100 = 1%). This fee is additive to the platform fee, increasing the total fee charged to the user. The affiliate_fee in webhook payloads reflects the partner's portion of the total fee for transactions originating from this checkout. Basis points represented as a string. Range 0-10000 where 100 = 1%.

Pattern: ^\d{1,5}$
Example:

"250"

country
string
required

ISO 3166-1 alpha-2 country code. Use GET /v1/ramp/countries to discover supported values.

Maximum string length: 2
subdivision
string

ISO 3166-2 subdivision code suffix (e.g., CA for California when country is US). Use GET /v1/ramp/countries to discover supported values.

redirect_url
string<uri>

URL to redirect the user after completing checkout successfully.

failure_url
string<uri>

URL to redirect the user after a failed checkout.

external_user_id
string

Optional partner-supplied user identifier.

Maximum string length: 64
external_partner_id
string

Optional partner-supplied partner identifier.

Maximum string length: 64
external_transaction_id
string

Optional partner transaction identifier.

Maximum string length: 64
external_metadata
string

Optional metadata to store alongside the checkout.

Maximum string length: 1000

Response

Response

data
object
required