Get Ramp Checkout URL
Generate a hosted Ramp checkout URL for the provided transaction configuration. The response echoes the request parameters so the Ramp partner can confirm what was submitted.
Authorizations
Your public API key. Identifies the partner making the request.
Monotonically increasing nonce included in the request signature.
HMAC signature over the request, computed with your private key.
Query Parameters
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).
3 - 16"BTC"
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).
fiat, crypto, stablecoin, xstock Funding method used for the source side. Use GET /v1/ramp/payment-methods to discover supported payment methods.
Amount to spend, denominated in the source asset, as a decimal string.
1 - 64^-?[0-9]+(\.[0-9]+)?$"1.23"
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).
3 - 16"BTC"
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).
fiat, crypto, stablecoin, xstock Withdrawal method for the destination asset. Use GET /v1/ramp/buy/crypto to discover available withdrawal methods for each asset.
Optional withdrawal network identifier. Use GET /v1/ramp/buy/crypto to discover available networks for each destination asset.
Optional destination wallet address for the crypto withdrawal.
Optional memo/tag/note for the crypto withdrawal (used for certain assets).
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%.
^\d{1,5}$"250"
ISO 3166-1 alpha-2 country code. Use GET /v1/ramp/countries to discover supported values.
2ISO 3166-2 subdivision code suffix (e.g., CA for California when country is US). Use GET /v1/ramp/countries to discover supported values.
URL to redirect the user after completing checkout successfully.
URL to redirect the user after a failed checkout.
Optional partner-supplied user identifier.
64Optional partner-supplied partner identifier.
64Optional partner transaction identifier.
64Optional metadata to store alongside the checkout.
1000Response
Response