Skip to main content
POST
Create a new Autoramp

Authorizations

X-API-Key
string
header
required

API Key

Headers

IDEMPOTENCY-KEY
string
required

a UUID ensuring an Autoramp operation is only processed once

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the autoramp will be created 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.

Body

application/json; charset=utf-8

The request parameters for creating an autoramp

Either a set of market parameters or a signed quote. Optionally include a type field (market | quote) to get precise validation errors.

customer_id
string<uuid>
required

The customer id

destination_currency
Crypto · object
required

Currency

Can be either crypto or fiat

Example:
recipient_account
FiatAccount · object
required

Account

The account for the autoramp

source_currencies
(Crypto · object | Fiat · object)[]
required

The list of source currencies

Currency

Can be either crypto or fiat

Example:
ach_payment_reference
string

reference message attached to outgoing ACH transfers (max 10 chars)

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

The additional partner fee in bips. This will be added to the fee. This is deprecated, use the partner fee configs instead.

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.

external_id
string

External ID for the autoramp, provided by the partner

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

reference message attached to outgoing FPS transfers (max 18 chars)

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

The name of the autoramp

pay_by_reference
boolean

If true, a payment reference will be generated for the autoramp. Defaults to false if not provided.

sepa_payment_reference
string

reference message attached to outgoing SEPA transfers (max 140 chars)

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

The source should be third party. E.g. a fiat account that allows receiving 3pp payments.

swift_payment_reference
string

reference message attached to outgoing SWIFT transfers (max 4 lines, 35 chars per line)

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

reference message attached to outgoing wire transfers (max 4 lines, 35 chars per line)

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

Optional discriminator. When present, the body is parsed as this variant and validation errors point at the offending field instead of the whole payload.

Available options:
market

Response

Create autoramp 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