Skip to main content
GET
Get Ramp checkout URL

Authorizations

API-Key
string
header
required

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

API-Sign
string
header
required

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

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Query Parameters

from_symbol
string
required

Source asset ticker symbol (e.g., "USD"). Use GET /v1/ramp/fiat-currencies to discover supported source currencies. Symbol identifying an asset within its asset category.

Required string length: 1 - 16
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). Only fiat sources are currently supported (on-ramp). Source asset classification accepted by Ramp on-ramp flows.

Available options:
fiat
from_method
string
required

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

Required string length: 1 - 128
from_amount
string
required

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

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

Destination asset ticker symbol (e.g., "BTC"). Use GET /v1/ramp/buy/crypto to discover supported destination assets. Symbol identifying an asset within its asset category.

Required string length: 1 - 16
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). Only crypto and stablecoin destinations are currently supported (on-ramp). Destination asset classification accepted by Ramp on-ramp flows.

Available options:
crypto,
stablecoin
to_method
string
required

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

Required string length: 1 - 128
to_network
string

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

Required string length: 1 - 128
to_address
string

Optional destination wallet address for the crypto withdrawal.

Required string length: 1 - 512
to_memo
string

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

Required string length: 1 - 256
affiliate_fee_bps
string

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.

Required string length: 1 - 5
Pattern: ^(10000|[0-9]{1,4})$
country
string
required

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

Required string length: 2
Pattern: ^[A-Za-z]{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.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9-]+$
redirect_url
string

URL to redirect the user after completing checkout successfully.

Required string length: 1 - 255
failure_url
string

URL to redirect the user after a failed checkout.

Required string length: 1 - 255
external_user_id
string

Optional partner-supplied user identifier.

Required string length: 1 - 64
external_partner_id
string

Optional partner-supplied partner identifier.

Required string length: 1 - 64
external_transaction_id
string

Optional partner transaction identifier.

Required string length: 1 - 64
external_metadata
string

Optional metadata to store alongside the checkout.

Required string length: 1 - 1000

Response

Successful response

data
RampCheckoutData · object
required

Checkout details for the requested Ramp route.