Skip to main content
GET
Get a quote for an autoramp

Authorizations

X-API-Key
string
header
required

API Key

Headers

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the autoramps will be filtered for the sub-partner

X-API-Version
string

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

customer_id
string<uuid>
required

The parameters for the quote The customer id

source_currency_code
string
required

The source currency code

Maximum string length: 32
source_currency_chain
enum<string>

The source currency chain Blockchain

A type of blockchain

Available options:
Solana,
Ethereum,
Polygon,
Arbitrum,
Base,
Stellar,
Citrea,
Plasma,
Avalanche,
Moca,
Tempo,
Tron,
Bsc
destination_currency_code
string
required

The destination currency code

Maximum string length: 32
destination_currency_chain
enum<string>

The destination currency chain Blockchain

A type of blockchain

Available options:
Solana,
Ethereum,
Polygon,
Arbitrum,
Base,
Stellar,
Citrea,
Plasma,
Avalanche,
Moca,
Tempo,
Tron,
Bsc
recipient_account_id
string<uuid>

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.

recipient_account
string

DEPRECATED: The recipient account, either a fiat iban or a crypto wallet address Use recipient_account_id instead

Maximum string length: 256
amount_in
string<decimal>

The source amount

amount_out
string<decimal>

The destination amount

rate_lock_duration_minutes
integer<int64>

The rate lock duration in minutes

rate_expiry_policy
enum<string>
required

The rate expiry policy Rate Expiry Policy

The policy for the rate expiry

Available options:
Return,
Slippage
slippage_tolerance_in_bips
string<decimal>

The slippage tolerance in bips

expiry_in_hours
integer<int64>
required

The autoramp expiry time in hours. Maximum is 24 hours. It is limited to rate lock duration if rate expiry policy is Return

is_third_party
boolean
required

Is this a third party autoramp

sender_account_number
string

Sender Account Number is required when the source currency is African & payment type is Bank transfer

Maximum string length: 256
sender_mobile_number
string

Sender Mobile Number is required when the source currency is African & payment type is Mobile Money

Maximum string length: 256
sender_bank
string

Sender Account Financial Institution/Bank is required when the source currency is African

external_id
string

The external id

wire_message
string

wire_message

swift_payment_reference
string

swift_payment_reference

sepa_payment_reference
string

sepa_payment_reference

ach_payment_reference
string

ach_payment_reference

fps_payment_reference
string

fps_payment_reference

fee_profile_id
string<uuid>

The fee profile id to use for the autoramp

batch_payout
boolean

Whether payouts for this autoramp are batched daily

additional_in_currency_codes
string[]

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.

Maximum array length: 16
additional_in_currency_chains
enum<string>[]

Chains for each entry in additional_in_currency_codes, index-aligned. Must have the same length as additional_in_currency_codes.

Maximum array length: 16

Blockchain

A type of blockchain

Available options:
Solana,
Ethereum,
Polygon,
Arbitrum,
Base,
Stellar,
Citrea,
Plasma,
Avalanche,
Moca,
Tempo,
Tron,
Bsc
pay_by_reference
boolean

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

amount_in
Amount · object
required

An amount of money

Example:
amount_out
Amount · object
required

An amount of money

Example:
customer_id
string<uuid>
required

The customer id

destination_currency
Crypto · object
required

Currency

Can be either crypto or fiat

Example:
fee
Fee · object
required

Fee

The fee for a given currency pair

fee_settlement
enum<string>
required

Fee Settlement

The settlement type for the fee

Available options:
deductedImmediately,
settledLater
is_third_party
boolean
required

Is this a third party autoramp

quote_id
string<uuid>
required

The id of the quote

rate
string<decimal>
required

The rate

rate_expiry_policy
enum<string>
required

Rate Expiry Policy

The policy for the rate expiry

Available options:
Return,
Slippage
recipient_account
FiatAccount · object
required

Account

The account for the autoramp

signature
string
required

The signature

source_currency
Crypto · object
required

Currency

Can be either crypto or fiat

Example:
valid_until
string<date-time>
required

The valid until

ach_payment_reference
string

a message to include in outgoing ACH transfers (max 10 characters)

Required string length: 1 - 10
Pattern: ^[A-Za-z0-9 /\-?:().+]*$
additional_in_currencies
(Crypto · object | Fiat · object)[]

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

Example:
batch_payout
boolean

If true, payouts for this autoramp will be batched and sent once per day instead of individually. Only supported for fiat destination currencies.

deposit_account_type
enum<string>
Available options:
Iban,
Wallet,
AchWire,
Pix,
Spei,
AfricanBankTransfer,
MobileMoney,
ChapsFps
external_id
string

The external id

fee_profile_id
string<uuid>

The fee profile id to use for the autoramp. If not provided, the default fee profile for the partner will be used.

fps_payment_reference
string

a message to include in outgoing FPS transfers (max 18 characters)

Required string length: 6 - 18
Pattern: ^[A-Za-z]*$
pay_by_reference
boolean

If true, a payment reference will be generated for the autoramp on inbound matching (pay-by-reference). Defaults to false if not provided.

rate_lock_valid_until
string<date-time>

The rate lock valid until

sepa_payment_reference
string

a message to include in outgoing SEPA transfers (max 140 characters)

Required string length: 6 - 140
Pattern: ^[A-Za-z0-9 /\-?:().+]*$
slippage_tolerance_in_bips
string<decimal>

The slippage tolerance in bips

swift_payment_reference
string

a message to include in outgoing SWIFT transfers (max 4 lines, 35 chars per line)

Required string length: 1 - 140
Pattern: ^[A-Za-z0-9 /\-?:().+]*$
wire_message
string

a message to include in outgoing wire transfers (max 4 lines, 35 chars per line)

Required string length: 1 - 140
Pattern: ^[A-Za-z0-9 /\-?:().+]*$