DashboardGet an Autoramp by ID
curl --request GET \
--url https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"batch_payout": true,
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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",
"quotes": [
{
"amount_in": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"amount_out": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"customer_fees": {
"banking_fee": {
"amount": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"rail": "Sepa"
},
"network_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"total": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"transaction_fee": {
"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",
"invoiced_fees": {
"banking_fee": {
"amount": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"rail": "Sepa"
},
"network_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"platform_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"total": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
}
},
"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",
"fee_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slippage_tolerance_in_bips": "<string>"
}
],
"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>",
"customer_fees": {
"banking_fees": [
{
"amount": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"rail": "Sepa"
}
],
"min_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"network_fee": "Variable",
"transaction_fee_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>",
"fee_profile": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"fps_payment_reference": "<string>",
"inbound_payment_reference": "<string>",
"invoiced_fees": {
"banking_fees": [
{
"amount": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"rail": "Sepa"
}
],
"network_fee": "Variable",
"platform_fees": [
{
"destination_currency": {
"blockchain": "Solana",
"token": "USDC"
},
"platform_fee_bips": "<string>",
"source_currency": {
"blockchain": "Solana",
"token": "USDC"
}
}
]
},
"name": "<string>",
"payment_reference": "<string>",
"quote": {
"amount_in": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"amount_out": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"customer_fees": {
"banking_fee": {
"amount": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"rail": "Sepa"
},
"network_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"total": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"transaction_fee": {
"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",
"invoiced_fees": {
"banking_fee": {
"amount": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"rail": "Sepa"
},
"network_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"platform_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"total": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
}
},
"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",
"fee_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slippage_tolerance_in_bips": "<string>"
},
"sepa_payment_reference": "<string>",
"swift_payment_reference": "<string>",
"swift_purpose_code": "<string>",
"travel_address": "<string>",
"wire_message": "<string>"
}"<string>""<string>"{
"message": "<string>",
"trace_id": "<string>"
}Autoramp
Get an Autoramp by ID
Get a single autoramp by ID
GET
/
autoramps
/
{autoramp_id}
Get an Autoramp by ID
curl --request GET \
--url https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"batch_payout": true,
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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",
"quotes": [
{
"amount_in": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"amount_out": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"customer_fees": {
"banking_fee": {
"amount": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"rail": "Sepa"
},
"network_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"total": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"transaction_fee": {
"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",
"invoiced_fees": {
"banking_fee": {
"amount": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"rail": "Sepa"
},
"network_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"platform_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"total": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
}
},
"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",
"fee_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slippage_tolerance_in_bips": "<string>"
}
],
"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>",
"customer_fees": {
"banking_fees": [
{
"amount": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"rail": "Sepa"
}
],
"min_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"network_fee": "Variable",
"transaction_fee_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>",
"fee_profile": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"fps_payment_reference": "<string>",
"inbound_payment_reference": "<string>",
"invoiced_fees": {
"banking_fees": [
{
"amount": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"rail": "Sepa"
}
],
"network_fee": "Variable",
"platform_fees": [
{
"destination_currency": {
"blockchain": "Solana",
"token": "USDC"
},
"platform_fee_bips": "<string>",
"source_currency": {
"blockchain": "Solana",
"token": "USDC"
}
}
]
},
"name": "<string>",
"payment_reference": "<string>",
"quote": {
"amount_in": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"amount_out": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"customer_fees": {
"banking_fee": {
"amount": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"rail": "Sepa"
},
"network_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"total": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"transaction_fee": {
"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",
"invoiced_fees": {
"banking_fee": {
"amount": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"rail": "Sepa"
},
"network_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"platform_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"total": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
}
},
"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",
"fee_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slippage_tolerance_in_bips": "<string>"
},
"sepa_payment_reference": "<string>",
"swift_payment_reference": "<string>",
"swift_purpose_code": "<string>",
"travel_address": "<string>",
"wire_message": "<string>"
}"<string>""<string>"{
"message": "<string>",
"trace_id": "<string>"
}Authorizations
API Key
Headers
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, 2026-08-01, 2026-10-01, 2026-10-15.
Path Parameters
The autoramp ID
Response
Get autoramp successful
Autoramp
The autoramp response
A Autoramp response
Whether payouts for this autoramp are batched daily
The created at timestamp
The id of the customer that owns the autoramp
deposit_rails
(IbanDepositInfo · object | AfricanBankTransferDepositInfo · object | PixDepositInfo · object | SpeiDepositInfo · object | CvuDepositInfo · object | MobileMoneyDepositInfo · object | CryptoWallet · object | FpsDepositInfo · object | ChapsDepositInfo · object | ACHDepositInfo · object | WireDepositInfo · object | RtpDepositInfo · object | SwiftDepositInfo · object)[]
required
- IbanDepositInfo
- AfricanBankTransferDepositInfo
- PixDepositInfo
- SpeiDepositInfo
- CvuDepositInfo
- MobileMoneyDepositInfo
- CryptoWallet
- FpsDepositInfo
- ChapsDepositInfo
- ACHDepositInfo
- WireDepositInfo
- RtpDepositInfo
- SwiftDepositInfo
Show child attributes
Show child attributes
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"
}
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Example:
{ "blockchain": "Solana", "token": "USDC" }
The fee profile id used for the autoramp. Deprecated: duplicates fee_profile.id.
Use fee_profile instead. Will be removed in the future.
The id of the autoramp
Whether this autoramp accepts third-party payments (3pp), which
determines how its deposits are routed and screened. Set from
source_is_third_party at creation and fixed for the life of the
autoramp. It can also be enabled automatically for some currencies
depending on which rail the customer is eligible for, so true does not
mean any particular deposit came from a third party. For that, read
third_party_classification on the transaction.
Autoramp type
The type (onramp, offramp, swap) of an autoramp
Available options:
Onramp, Offramp, Swap, Mint, Redeem Active (non-expired) quotes associated with this autoramp. Deposits are
matched to the newest active quote with matching amount_in value and
currency.
Show child attributes
Show child attributes
Recipient
The recipient of the payment
- RecipientBankAccount
- RecipientWallet
- RecipientPix
Show child attributes
Show child attributes
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"
}
}
Autoramp Source
The source of the autoramp
Available options:
Standalone, Quote The source currencies
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Example:
{ "blockchain": "Solana", "token": "USDC" }
Available options:
Created, EditPending, Authorized, DepositAccountAdded, Approved, Rejected, Cancelled The additional partner fee in bips
The rates a customer will be charged on an autoramp, before any transaction exists.
Show child attributes
Show child attributes
Deprecated, please use the information in the deposit_rails field instead
- IbanDepositInfo
- AchWireDepositInfo
- AfricanBankTransferDepositInfo
- PixDepositInfo
- SpeiDepositInfo
- CvuDepositInfo
- MobileMoneyDepositInfo
- CryptoWallet
- ChapsFpsDepositInfo
Show child attributes
Show child attributes
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 for the autoramp, provided by the partner
A reference to the fee profile used to price a quote, autoramp, or transaction.
Show child attributes
Show child attributes
reference message for outgoing FPS transfers
System-generated inbound memo that senders must include on transfers
to the shared VA. None for autoramps that don't use pay-by-reference.
The fees Iron will invoice the partner separately for an autoramp, before any transaction exists.
Show child attributes
Show child attributes
The name of the autoramp
The payment reference for the autoramp
Deprecated: use the quotes field instead. Returns the newest active (non-expired) quote if any.
Show child attributes
Show child attributes
reference message for outgoing SEPA transfers
reference message for outgoing SWIFT transfers
destination purpose code for outgoing SWIFT transfers
The travel rule address for compliance
reference message for outgoing wire transfers
Was this page helpful?