Skip to main content
POST
Attach a quote to an existing autoramp

Authorizations

X-API-Key
string
header
required

API Key

Headers

IDEMPOTENCY-KEY
string
required

a UUID ensuring the operation is only processed once

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.

Path Parameters

autoramp_id
string<uuid>
required

Body

application/json; charset=utf-8

Signed rate quote for an existing autoramp.

Contains only pricing fields — the autoramp's currencies, recipient, etc. are already known.

Deposits are matched to the newest active quote whose amount_in value and currency equal the deposit. Attaching a quote that overlaps an existing one on those fields supersedes it for new deposits; all of the newer quote's terms apply (rate lock, expiry policy, slippage tolerance, fees).

amount_in
Amount · object
required

An amount of money

Example:
amount_out
Amount · object
required

An amount of money

Example:
autoramp_id
string<uuid>
required

The autoramp this quote is for

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
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
rate_lock_valid_until
string<date-time>
required

The rate lock valid until

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

payment_reference
string

An optional payout reference used when paying out transactions matched to this quote. Overrides the autoramp's payment reference.

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

The slippage tolerance in bips

Response

Attach quote successful

Autoramp

The autoramp response

A Autoramp response

batch_payout
boolean
required

Whether payouts for this autoramp are batched daily

created_at
string<date-time>
required

The created at timestamp

customer_id
string<uuid>
required

The id of the customer that owns the autoramp

deposit_rails
(IbanDepositInfo · object | AfricanBankTransferDepositInfo · object | PixDepositInfo · object | SpeiDepositInfo · object | MobileMoneyDepositInfo · object | CryptoWallet · object | FpsDepositInfo · object | ChapsDepositInfo · object | ACHDepositInfo · object | WireDepositInfo · object | RtpDepositInfo · object | FedNowDepositInfo · object | SwiftDepositInfo · object)[]
required
Example:
destination_currency
Crypto · object
required

Currency

Can be either crypto or fiat

Example:
fee_profile_id
string<uuid>
required

The fee profile id used for the autoramp

id
string<uuid>
required

The id of the autoramp

is_third_party
boolean
required

Is this a third party payment (3pp) autoramp

kind
enum<string>
required

Autoramp type

The type (onramp, offramp, swap) of an autoramp

Available options:
Onramp,
Offramp,
Swap,
Mint,
Redeem
quotes
AutorampQuote · object[]
required

Active (non-expired) quotes associated with this autoramp. Deposits are matched to the newest active quote with matching amount_in value and currency.

recipient
RecipientBankAccount · object
required

Recipient

The recipient of the payment

Example:
source
enum<string>
required

Autoramp Source

The source of the autoramp

Available options:
Standalone,
Quote
source_currencies
(Crypto · object | Fiat · object)[]
required

The source currencies

Currency

Can be either crypto or fiat

Example:
status
enum<string>
required
Available options:
Created,
EditPending,
Authorized,
DepositAccountAdded,
Approved,
Rejected,
Cancelled
additional_partner_fee_in_bips
string<decimal>

The additional partner fee in bips

deposit_account
IbanDepositInfo · object
deprecated

Deprecated, please use the information in the deposit_rails field instead

Example:
external_id
string

External ID for the autoramp, provided by the partner

fps_payment_reference
string

reference message for outgoing FPS transfers

inbound_payment_reference
string

System-generated inbound memo that senders must include on transfers to the shared VA. None for autoramps that don't use pay-by-reference.

name
string

The name of the autoramp

payment_reference
string

The payment reference for the autoramp

quote
AutorampQuote · object
deprecated

Deprecated: use the quotes field instead. Returns the newest active (non-expired) quote if any.

sepa_payment_reference
string

reference message for outgoing SEPA transfers

swift_payment_reference
string

reference message for outgoing SWIFT transfers

travel_address
string

The travel rule address for compliance

wire_message
string

reference message for outgoing wire transfers