Get exchange rate

Authorizations

X-API-Key

string

header

required

API Key

Query Parameters

customer_id

string<uuid>

required

customer id

source_currency_code

string

required

source currency code

Maximum string length: 32

source_currency_type

enum<string>

required

source currency type Currency Type

The type of currency

Available options:

fiat,

crypto

source_currency_chain

enum<string>

source currency chain Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

destination_currency_code

string

required

destination currency code

Maximum string length: 32

destination_currency_type

enum<string>

required

destination currency type Currency Type

The type of currency

Available options:

fiat,

crypto

destination_currency_chain

enum<string>

destination currency chain Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

amount

string<decimal>

required

amount

_partner_fee_in_bips

integer<uint64>

partner fee in bips

Response

The exchange rate response

Exchange Rate

The exchange rate for a given currency pair

effective_rate

string<decimal>

required

The effective rate

fee

Fee · object

required

Fee

The fee for a given currency pair

Show child attributes

fee.banking_fee

Amount · object

required

An amount of money

Show child attributes

fee.banking_fee.amount

string<decimal>

required

The amount, a decimal number

fee.banking_fee.currency

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

fee.banking_fee.currency.type

enum<string>

required

Available options:

Crypto

Example:

"Crypto"

fee.banking_fee.currency.blockchain

enum<string>

required

Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

fee.banking_fee.currency.token

string

required

The ticker of the token e.g. 'USDC'

Example:

{ "blockchain": "Solana", "token": "USDC" }

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

fee.iron_fee

Amount · object

required

An amount of money

Show child attributes

fee.iron_fee.amount

string<decimal>

required

The amount, a decimal number

fee.iron_fee.currency

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

fee.iron_fee.currency.type

enum<string>

required

Available options:

Crypto

Example:

"Crypto"

fee.iron_fee.currency.blockchain

enum<string>

required

Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

fee.iron_fee.currency.token

string

required

The ticker of the token e.g. 'USDC'

Example:

{ "blockchain": "Solana", "token": "USDC" }

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

fee.network_fee

Amount · object

required

An amount of money

Show child attributes

fee.network_fee.amount

string<decimal>

required

The amount, a decimal number

fee.network_fee.currency

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

fee.network_fee.currency.type

enum<string>

required

Available options:

Crypto

Example:

"Crypto"

fee.network_fee.currency.blockchain

enum<string>

required

Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

fee.network_fee.currency.token

string

required

The ticker of the token e.g. 'USDC'

Example:

{ "blockchain": "Solana", "token": "USDC" }

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

fee.network_fees

Amount · object[]

required

deprecated

The network fees in source currency

Network Fee

The network fee for a given currency. This is deprecated and will be removed in the future. Use NetworkFeeWithSettlement instead.

Amount
Amount
Amount
Amount
Amount
Amount
Amount

Show child attributes

fee.network_fees.type

enum<string>

required

Available options:

SwiftOut

Example:

"SwiftOut"

fee.network_fees.amount

string<decimal>

required

The amount, a decimal number

fee.network_fees.currency

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

fee.network_fees.currency.type

enum<string>

required

Available options:

Crypto

Example:

"Crypto"

fee.network_fees.currency.blockchain

enum<string>

required

Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

fee.network_fees.currency.token

string

required

The ticker of the token e.g. 'USDC'

Example:

{ "blockchain": "Solana", "token": "USDC" }

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

fee.network_fees_with_settlement

NetworkFeeWithSettlement · object[]

required

The network fees with settlement

Show child attributes

fee.network_fees_with_settlement.fee_amount

Amount · object

required

An amount of money

Show child attributes

fee.network_fees_with_settlement.fee_amount.amount

string<decimal>

required

The amount, a decimal number

fee.network_fees_with_settlement.fee_amount.currency

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

fee.network_fees_with_settlement.fee_amount.currency.type

enum<string>

required

Available options:

Crypto

Example:

"Crypto"

fee.network_fees_with_settlement.fee_amount.currency.blockchain

enum<string>

required

Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

fee.network_fees_with_settlement.fee_amount.currency.token

string

required

The ticker of the token e.g. 'USDC'

Example:

{ "blockchain": "Solana", "token": "USDC" }

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

fee.network_fees_with_settlement.fee_type

enum<string>

required

Network Fee Type

The type of network fee

Available options:

SepaIn,

SepaOut,

EthereumGas,

SolanaTransactionFee,

StellarTransactionFee,

RailFee,

AchIn,

AchOut,

WireIn,

WireOut,

SwiftIn,

SwiftOut,

FpsIn,

FpsOut,

ChapsIn,

ChapsOut

fee.network_fees_with_settlement.settlement

enum<string>

Fee Settlement

The settlement type for the fee

Available options:

deductedImmediately,

settledLater

fee.partner_fee

Amount · object

required

An amount of money

Show child attributes

fee.partner_fee.amount

string<decimal>

required

The amount, a decimal number

fee.partner_fee.currency

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

fee.partner_fee.currency.type

enum<string>

required

Available options:

Crypto

Example:

"Crypto"

fee.partner_fee.currency.blockchain

enum<string>

required

Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

fee.partner_fee.currency.token

string

required

The ticker of the token e.g. 'USDC'

Example:

{ "blockchain": "Solana", "token": "USDC" }

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

fee.partner_fees

PartnerFee · object[]

required

The partner fees

Show child attributes

fee.partner_fees.fee

Amount · object

required

An amount of money

Show child attributes

fee.partner_fees.fee.amount

string<decimal>

required

The amount, a decimal number

fee.partner_fees.fee.currency

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

fee.partner_fees.fee.currency.type

enum<string>

required

Available options:

Crypto

Example:

"Crypto"

fee.partner_fees.fee.currency.blockchain

enum<string>

required

Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

fee.partner_fees.fee.currency.token

string

required

The ticker of the token e.g. 'USDC'

Example:

{ "blockchain": "Solana", "token": "USDC" }

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

fee.partner_fees.label

string

required

The label of the partner fee

fee.partner_fees.settlement

enum<string>

required

Fee Settlement

The settlement type for the fee

Available options:

deductedImmediately,

settledLater

fee.total_fee

Amount · object

required

An amount of money

Show child attributes

fee.total_fee.amount

string<decimal>

required

The amount, a decimal number

fee.total_fee.currency

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

fee.total_fee.currency.type

enum<string>

required

Available options:

Crypto

Example:

"Crypto"

fee.total_fee.currency.blockchain

enum<string>

required

Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

fee.total_fee.currency.token

string

required

The ticker of the token e.g. 'USDC'

Example:

{ "blockchain": "Solana", "token": "USDC" }

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

fee.transaction_fee

Amount · object

required

An amount of money

Show child attributes

fee.transaction_fee.amount

string<decimal>

required

The amount, a decimal number

fee.transaction_fee.currency

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

fee.transaction_fee.currency.type

enum<string>

required

Available options:

Crypto

Example:

"Crypto"

fee.transaction_fee.currency.blockchain

enum<string>

required

Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

fee.transaction_fee.currency.token

string

required

The ticker of the token e.g. 'USDC'

Example:

{ "blockchain": "Solana", "token": "USDC" }

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

fee.deducted_fee

Amount · object

deprecated

The amount of the fee that was deducted immediately and charged to the end customer. This is deprecated and will be removed in the future. Use transaction_fee instead.

Show child attributes

fee.deducted_fee.amount

string<decimal>

required

The amount, a decimal number

fee.deducted_fee.currency

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

fee.deducted_fee.currency.type

enum<string>

required

Available options:

Crypto

Example:

"Crypto"

fee.deducted_fee.currency.blockchain

enum<string>

required

Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

fee.deducted_fee.currency.token

string

required

The ticker of the token e.g. 'USDC'

Example:

{ "blockchain": "Solana", "token": "USDC" }

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

fee.iron_fee_settlement

enum<string>

Fee Settlement

The settlement type for the fee

Available options:

deductedImmediately,

settledLater

from

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

from.type

enum<string>

required

Available options:

Crypto

Example:

"Crypto"

from.blockchain

enum<string>

required

Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

from.token

string

required

The ticker of the token e.g. 'USDC'

Example:

{ "blockchain": "Solana", "token": "USDC" }

out_amount

Amount · object

required

An amount of money

Show child attributes

out_amount.amount

string<decimal>

required

The amount, a decimal number

out_amount.currency

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

out_amount.currency.type

enum<string>

required

Available options:

Crypto

Example:

"Crypto"

out_amount.currency.blockchain

enum<string>

required

Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

out_amount.currency.token

string

required

The ticker of the token e.g. 'USDC'

Example:

{ "blockchain": "Solana", "token": "USDC" }

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

to.type

enum<string>

required

Available options:

Crypto

Example:

"Crypto"

to.blockchain

enum<string>

required

Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar

to.token

string

required

The ticker of the token e.g. 'USDC'

Example:

{ "blockchain": "Solana", "token": "USDC" }

Iron API - Sandbox

Authorizations

Query Parameters

Response