Skip to main content
GET
/
autoramps
/
quote
Get a quote for an autoramp
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/autoramps/quote \
  --header 'X-API-Key: <api-key>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>'
{
  "amount_in": {
    "amount": "100.5",
    "currency": {
      "code": "USD",
      "type": "Fiat"
    }
  },
  "amount_out": {
    "amount": "100.5",
    "currency": {
      "code": "USD",
      "type": "Fiat"
    }
  },
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "destination_currency": {
    "blockchain": "Solana",
    "token": "USDC"
  },
  "fee": {
    "banking_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "iron_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "network_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "network_fees": [
      {
        "amount": "100.5",
        "currency": {
          "code": "USD",
          "type": "Fiat"
        }
      }
    ],
    "network_fees_with_settlement": [
      {
        "fee_amount": {
          "amount": "100.5",
          "currency": {
            "code": "USD",
            "type": "Fiat"
          }
        },
        "fee_type": "SepaIn",
        "settlement": "deductedImmediately"
      }
    ],
    "partner_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "partner_fees": [
      {
        "fee": {
          "amount": "100.5",
          "currency": {
            "code": "USD",
            "type": "Fiat"
          }
        },
        "label": "<string>",
        "settlement": "deductedImmediately"
      }
    ],
    "total_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "transaction_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "deducted_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "iron_fee_settlement": "deductedImmediately"
  },
  "fee_settlement": "deductedImmediately",
  "is_third_party": true,
  "quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rate": "<string>",
  "rate_expiry_policy": "Return",
  "recipient_account": {
    "type": "Fiat",
    "account_identifier": {
      "iban": "DE89370400440532013000"
    }
  },
  "signature": "<string>",
  "source_currency": {
    "blockchain": "Solana",
    "token": "USDC"
  },
  "valid_until": "2023-11-07T05:31:56Z",
  "deposit_account_type": "Iban",
  "external_id": "<string>",
  "rate_lock_valid_until": "2023-11-07T05:31:56Z",
  "slippage_tolerance_in_bips": "<string>",
  "wire_message": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
X-SUB-PARTNER-ID
string
required

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

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
​
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
​
recipient_account
string
required

The recipient account, either a fiat iban or a crypto wallet address

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
enum<string>

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

Available options:
9JAPAY MICROFINANCE,
ABSA Bank Botswana,
ACCESS BANK,
AFRICAN BANKING CORPORATION,
AIRTELMONEYTZ,
AZAMPESA,
Absa Bank,
Absa Bank Kenya Plc,
Absa Bank Tanzania Limited,
Access Bank,
Access Bank (Diamond),
AccessBank Tanzania,
African Bank,
Airtel,
Akiba Commercial Bank,
Albaraka Bank,
Amana Bank,
Azania Bank,
BANK OF AFRICA KENYA LTD,
BANK OF BARODA,
BANK OF INDIA,
BARCLAYS BANK,
BancABC Tanzania,
Bank Gaborone Limited,
Bank Of Baroda Botswana,
Bank Of Namibia,
Bank of Africa Tanzania Limited,
Bank of Athens,
Bank of Baroda Tanzania Limited,
Bank of Tanzania,
Barclays Bank,
Bidvest Bank,
CENTRAL BANK OF KENYA,
CHARTERHOUSE BANK LTD,
CITIBANK N.A.,
CO-OPERATIVE BANK,
COMMERCIAL BANK OF AFRICA LTD,
CONSOLIDATED BANK OF KENYA LTD,
CRDB Bank,
CREDIT BANK LTD,
Capitec Bank,
Central Bank Of Lesotho,
China Commercial Bank Limited,
Citi Bank,
Citibank Nigeria,
Citibank Tanzania Ltd,
DCB Commercial Bank,
DEVELOPMENT BANK OF KENYA,
DIAMOND TRUST BANK,
DUBAI BANK OF KENYA LTD,
Diamond Trust Bank Tanzania,
Discovery Bank Limited,
ECOBANK KENYA LTD,
EQUITORIAL COMMERCIAL BANK LTD,
EQUITY BANK,
Ecobank,
Ecobank Nigeria,
Enterprise Bank,
Equity Bank (Tanzania),
Exim Bank (Tanzania),
FAMILY BANK LTD,
FIDELITY COMMERCIAL BANK,
FIRST COMMUNITY BANK,
Fairmoney Microfinance Bank Ltd,
Fidelity Bank,
Finbond Mutual Bank,
First Bank of Nigeria,
First Capital Bank Botswana,
First City Monument Bank,
First National Bank,
First National Bank (South Africa),
First National Bank Lesotho,
First National Bank Namibia,
First National Bank Swaziland,
First National Bank of Tanzania,
FirstRand Bank Limited,
GIRO BANK LTD,
GT Bank,
GUARANTY TRUST (KENYA) LTD,
GUARDIAN BANK,
GULF AFRICAN BANK LTD,
GoMoney,
Grinrod Bank,
Guaranty Trust Bank,
Guaranty Trust Bank (Tanzania) Limited,
HABIB BANK A.G.,
HABIB BANK LTD,
HALOPESA,
HOUSING FINANCE CORPORATION OF KENYA,
Habib African Bank,
Heritage Bank,
Hsbc Bank,
I&M Bank (Tanzania),
IMPERIAL BANK LIMITED,
INVESTMENTS AND MORTGAGES,
International Commercial Bank Tanzania,
Investec Bank,
JAMII BORA BANK LTD,
Jaiz Bank,
Jp Morgan Chase Bank,
K-REP BANK,
KENYA COMMERCIAL BANK LTD,
Kcb Bank Tanzania Limited,
Keystone Bank,
Kuda Microfinance Bank,
Letshego Bank Tanzania,
Lotus Bank,
MIDDLE EAST BANK (K) LIMITED,
MTN,
Maendeleo Bank Ltd,
Mainstreet Bank,
Meeg Bank,
Mercantile Bank Limited,
Mkombozi Commercial Bank,
MoMo PSB,
Mobile Wallet,
Mobile Wallet (M-PESA),
Moniepoint Microfinance Bank,
Moov money,
Mtn Banking,
Mtn Mobile Money,
Mwalimu Commercial Bank,
NATIONAL BANK OF KENYA,
NCBA Bank,
NCBA Bank Tanzania,
NET MFB,
National Bank of Commerce (Tanzania),
National Microfinance Bank,
Nedbank (South Africa),
Nownow（Contec Global),
OPay,
ORIENTAL COMMERCIAL BANK,
Old Mutual,
Orange Money,
PARAMOUNT UNIVERSAL BANK LTD,
PRIME BANK LIMITED,
Paga,
PalmPay,
Peach,
People's Bank of Zanzibar,
Polaris Bank,
Postbank,
Premium Trust bank,
Providus Bank,
RMB Private Bank,
Rand Merchant Bank,
SA Post Bank (Post Office),
STANBIC BANK,
STANBIC BANK KENYA LIMITED,
STANDARD CHARTERED,
Sasfin Bank Limited,
South African Bank of Athens Limited,
Stanbic Bank Tanzania Limited,
Stanbic Ibtc Bank,
Standard Bank (South Africa),
Standard Bank Namibia,
Standard Chartered Bank,
Standard Chartered Bank Botswana Limited,
State Bank Of India,
Sterling Bank,
TIGO,
TNM,
TPB Bank Plc,
TRANS-NATIONAL BANK,
Taj Bank,
Titan-Paystack,
Tyme Bank,
UBA KENYA LTD,
Ubank,
Unibank,
Union Bank of Nigeria,
United Bank for Africa,
Unity Bank,
VFD Microfinance Bank,
VICTORIA COMMERCIAL BANK LTD,
VISA/MasterCard,
VODACOM,
Vbs Mutual Bank,
Wave,
Wema Bank,
Zamtel,
Zenith Bank
​
external_id
string

The external id

​
wire_message
string

wire_message

Response

Get Quote successful

Signed Autoramp Quote

The signed autoramp quote

​
amount_in
Amount · object
required

An amount of money

Example:
{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}
​
amount_out
Amount · object
required

An amount of money

Example:
{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}
​
customer_id
string<uuid>
required

The customer id

​
destination_currency
Crypto · object
required

Currency

Can be either crypto or fiat

  • Crypto
  • Fiat
Example:
{ "blockchain": "Solana", "token": "USDC" }
​
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

  • FiatAccount
  • CryptoWallet
​
signature
string
required

The signature

​
source_currency
Crypto · object
required

Currency

Can be either crypto or fiat

  • Crypto
  • Fiat
Example:
{ "blockchain": "Solana", "token": "USDC" }
​
valid_until
string<date-time>
required

The valid until

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

The external id

​
rate_lock_valid_until
string<date-time>

The rate lock valid until

​
slippage_tolerance_in_bips
string<decimal>

The slippage tolerance in bips

​
wire_message
string

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