Get a quote for an autoramp
Get a quote for an autoramp with fixed conversion rate, exact amount out or amount in
Authorizations
API Key
Headers
Optional sub-partner UUID, if provided, the autoramps will be filtered for the sub-partner
Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01.
Query Parameters
The parameters for the quote The customer id
The source currency code
32The source currency chain Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar, Citrea, Plasma, Avalanche, Moca, Tempo, Tron, Bsc The destination currency code
32The destination currency chain Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar, Citrea, Plasma, Avalanche, Moca, Tempo, Tron, Bsc The recipient account ID (fiat_address or verified_crypto_address ID) Use this parameter instead of recipient_account. This is the preferred way to provide the recipient account and will be used if both are provided.
DEPRECATED: The recipient account, either a fiat iban or a crypto wallet address Use recipient_account_id instead
256The source amount
The destination amount
The rate lock duration in minutes
The rate expiry policy Rate Expiry Policy
The policy for the rate expiry
Return, Slippage The slippage tolerance in bips
The autoramp expiry time in hours. Maximum is 24 hours. It is limited to rate lock duration if rate expiry policy is Return
Is this a third party autoramp
Sender Account Number is required when the source currency is African & payment type is Bank transfer
256Sender Mobile Number is required when the source currency is African & payment type is Mobile Money
256Sender Account Financial Institution/Bank is required when the source currency is African
The external id
wire_message
swift_payment_reference
sepa_payment_reference
ach_payment_reference
fps_payment_reference
The fee profile id to use for the autoramp
Whether payouts for this autoramp are batched daily
Additional input currency codes to allow on the autoramp beyond
source_currency_code. Used to enable later per-currency quotes via
POST /autoramps/:id/quotes on a quote-type autoramp.
Must have the same length as additional_in_currency_chains and be
index-aligned: the chain at position i describes the code at
position i.
16Chains for each entry in additional_in_currency_codes, index-aligned.
Must have the same length as additional_in_currency_codes.
16Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar, Citrea, Plasma, Avalanche, Moca, Tempo, Tron, Bsc If true, a payment reference will be generated for the autoramp on inbound matching (pay-by-reference). Defaults to false if not provided.
Response
Get Quote successful
Signed Autoramp Quote
The signed autoramp quote
An amount of money
An amount of money
The customer id
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Fee
The fee for a given currency pair
Fee Settlement
The settlement type for the fee
deductedImmediately, settledLater Is this a third party autoramp
The id of the quote
The rate
Rate Expiry Policy
The policy for the rate expiry
Return, Slippage Account
The account for the autoramp
- FiatAccount
- CryptoWallet
- PixAccount
The signature
Currency
Can be either crypto or fiat
- Crypto
- Fiat
The valid until
a message to include in outgoing ACH transfers (max 10 characters)
1 - 10^[A-Za-z0-9 /\-?:().+]*$Additional input currencies to allow on the autoramp beyond source_currency.
Each entry must share the same chain as source_currency and the list must
not include source_currency itself. After autoramp creation, further quotes
can be obtained for these currencies via POST /autoramps/:id/quotes.
Currency
Can be either crypto or fiat
- Crypto
- Fiat
If true, payouts for this autoramp will be batched and sent once per day instead of individually. Only supported for fiat destination currencies.
Iban, Wallet, AchWire, Pix, Spei, AfricanBankTransfer, MobileMoney, ChapsFps The external id
The fee profile id to use for the autoramp. If not provided, the default fee profile for the partner will be used.
a message to include in outgoing FPS transfers (max 18 characters)
6 - 18^[A-Za-z]*$If true, a payment reference will be generated for the autoramp on inbound matching (pay-by-reference). Defaults to false if not provided.
The rate lock valid until
a message to include in outgoing SEPA transfers (max 140 characters)
6 - 140^[A-Za-z0-9 /\-?:().+]*$The slippage tolerance in bips
a message to include in outgoing SWIFT transfers (max 4 lines, 35 chars per line)
1 - 140^[A-Za-z0-9 /\-?:().+]*$a message to include in outgoing wire transfers (max 4 lines, 35 chars per line)
1 - 140^[A-Za-z0-9 /\-?:().+]*$
