Skip to main content
POST
/
autoramps
Create a new Autoramp
curl --request POST \
  --url https://api.sandbox.iron.xyz/api/autoramps \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'IDEMPOTENCY-KEY: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "destination_currency": {
    "blockchain": "Solana",
    "token": "USDC"
  },
  "recipient_account": {
    "type": "Fiat",
    "account_identifier": {
      "iban": "DE89370400440532013000"
    }
  },
  "source_currencies": [
    {
      "blockchain": "Solana",
      "token": "USDC"
    }
  ],
  "ach_payment_reference": "<string>",
  "additional_partner_fee_in_bips": "<string>",
  "batch_payout": true,
  "external_id": "<string>",
  "fee_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fps_payment_reference": "<string>",
  "name": "<string>",
  "sepa_payment_reference": "<string>",
  "source_is_third_party": true,
  "swift_payment_reference": "<string>",
  "wire_message": "<string>"
}
'
{
  "batch_payout": true,
  "created_at": "2023-11-07T05:31:56Z",
  "deposit_rails": [
    {
      "address": "10 Downing Street, London, SW1A 2AA, GB",
      "beneficiary_name": "Alan Turing",
      "bic": "COBADEFFXXX",
      "iban": "DE89370400440532013000",
      "name": "Iron Bank",
      "phone": "+44-20-1234-5678"
    }
  ],
  "destination_currency": {
    "blockchain": "Solana",
    "token": "USDC"
  },
  "fee_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_third_party": true,
  "kind": "Onramp",
  "recipient": {
    "account_identifier": {
      "iban": "DE89370400440532013000",
      "type": "SEPA"
    },
    "address": {
      "city": "London",
      "country": {
        "code": "GB"
      },
      "postal_code": "SW1A 2AA",
      "state": "England",
      "street": "10 Downing Street"
    },
    "bank_address": null,
    "email_address": {
      "email": "john.doe@example.com"
    },
    "is_third_party": false,
    "phone_number": "+49-30-12345678",
    "provider_country": {
      "code": "DE"
    },
    "provider_name": "Iron Bank",
    "recipient": {
      "name": "Aperture Science",
      "type": "Business"
    }
  },
  "source": "Standalone",
  "source_currencies": [
    {
      "blockchain": "Solana",
      "token": "USDC"
    }
  ],
  "status": "Created",
  "additional_partner_fee_in_bips": "<string>",
  "deposit_account": {
    "address": "10 Downing Street, London, SW1A 2AA, GB",
    "beneficiary_name": "Alan Turing",
    "bic": "COBADEFFXXX",
    "iban": "DE89370400440532013000",
    "name": "Iron Bank",
    "phone": "+44-20-1234-5678"
  },
  "external_id": "<string>",
  "fps_payment_reference": "<string>",
  "name": "<string>",
  "quote": {
    "amount_in": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "amount_out": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "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"
        }
      },
      "banking_fee_network": "Sepa",
      "deducted_fee": {
        "amount": "100.5",
        "currency": {
          "code": "USD",
          "type": "Fiat"
        }
      },
      "iron_fee_settlement": "deductedImmediately"
    },
    "fee_settlement": "deductedImmediately",
    "partner_fee_settlement": "deductedImmediately",
    "quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rate": "<string>",
    "rate_expiry_policy": "Return",
    "rate_lock_valid_until": "2023-11-07T05:31:56Z",
    "valid_until": "2023-11-07T05:31:56Z",
    "slippage_tolerance_in_bips": "<string>"
  },
  "sepa_payment_reference": "<string>",
  "swift_payment_reference": "<string>",
  "travel_address": "<string>",
  "wire_message": "<string>"
}

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

Body

application/json; charset=utf-8

The request parameters for creating an autoramp

Create Autoramp Parameters

The parameters required to create a autoramp

​
customer_id
string<uuid>
required

The customer id

​
destination_currency
Crypto · object
required

Currency

Can be either crypto or fiat

Example:
{ "blockchain": "Solana", "token": "USDC" }
​
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:
{ "blockchain": "Solana", "token": "USDC" }
​
ach_payment_reference
string

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

Maximum string length: 10
​
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)

Maximum string length: 18
​
name
string

The name of the autoramp

​
sepa_payment_reference
string

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

Maximum string length: 140
​
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)

​
wire_message
string

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

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

​
deposit_rails
(IbanDepositInfo · object | AfricanBankTransferDepositInfo · object | PixDepositInfo · object | SpeiDepositInfo · object | MobileMoneyDepositInfo · object | CryptoWallet · object | FpsDepositInfo · object | ChapsDepositInfo · object | ACHDepositInfo · object | WireDepositInfo · object | RtpDepositInfo · object | SwiftDepositInfo · object)[]
required
Example:
{
  "address": "10 Downing Street, London, SW1A 2AA, GB",
  "beneficiary_name": "Alan Turing",
  "bic": "COBADEFFXXX",
  "iban": "DE89370400440532013000",
  "name": "Iron Bank",
  "phone": "+44-20-1234-5678"
}
​
destination_currency
Crypto · object
required

Currency

Can be either crypto or fiat

Example:
{ "blockchain": "Solana", "token": "USDC" }
​
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
​
recipient
RecipientBankAccount · object
required

Recipient

The recipient of the payment

Example:
{
  "account_identifier": {
    "iban": "DE89370400440532013000",
    "type": "SEPA"
  },
  "address": {
    "city": "London",
    "country": { "code": "GB" },
    "postal_code": "SW1A 2AA",
    "state": "England",
    "street": "10 Downing Street"
  },
  "bank_address": null,
  "email_address": { "email": "john.doe@example.com" },
  "is_third_party": false,
  "phone_number": "+49-30-12345678",
  "provider_country": { "code": "DE" },
  "provider_name": "Iron Bank",
  "recipient": {
    "name": "Aperture Science",
    "type": "Business"
  }
}
​
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:
{ "blockchain": "Solana", "token": "USDC" }
​
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:
{
  "address": "10 Downing Street, London, SW1A 2AA, GB",
  "beneficiary_name": "Alan Turing",
  "bic": "COBADEFFXXX",
  "iban": "DE89370400440532013000",
  "name": "Iron Bank",
  "phone": "+44-20-1234-5678"
}
​
external_id
string

External ID for the autoramp, provided by the partner

​
fps_payment_reference
string

reference message for outgoing FPS transfers

​
name
string

The name of the autoramp

​
quote
AutorampQuote · object

Autoramp Quote

The autoramp quote used to create an autoramp

​
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