List Autoramps for a Customer
curl --request GET \
--url https://api.sandbox.iron.xyz/api/autoramps \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.sandbox.iron.xyz/api/autoramps"
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', 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",
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"
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")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.iron.xyz/api/autoramps")
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{
"items": [
{
"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,
"quotes": [
{
"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"
}
}
}
],
"partner_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"partner_fees": [
{
"fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"label": "<string>"
}
],
"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"
}
}
},
"quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rate": "<string>",
"rate_lock_valid_until": "2023-11-07T05:31:56Z",
"valid_until": "2023-11-07T05:31:56Z",
"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_currencies": [
{
"blockchain": "Solana",
"token": "USDC"
}
],
"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>",
"inbound_payment_reference": "<string>",
"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"
}
},
"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"
}
}
}
],
"partner_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"partner_fees": [
{
"fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"label": "<string>"
}
],
"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"
}
}
},
"quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rate": "<string>",
"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>"
}
],
"cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prev_cursor": null
}"<string>""<string>""<string>"{
"message": "<string>",
"trace_id": "<string>"
}Autoramp
List Autoramps for a Customer
Returns a paginated list of autoramps for all customers
If customer ID is provided, returns all autoramps for the specified customer
If status is provided, returns all autoramps with the specified status
GET
/
autoramps
List Autoramps for a Customer
curl --request GET \
--url https://api.sandbox.iron.xyz/api/autoramps \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.sandbox.iron.xyz/api/autoramps"
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', 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",
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"
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")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.iron.xyz/api/autoramps")
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{
"items": [
{
"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,
"quotes": [
{
"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"
}
}
}
],
"partner_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"partner_fees": [
{
"fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"label": "<string>"
}
],
"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"
}
}
},
"quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rate": "<string>",
"rate_lock_valid_until": "2023-11-07T05:31:56Z",
"valid_until": "2023-11-07T05:31:56Z",
"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_currencies": [
{
"blockchain": "Solana",
"token": "USDC"
}
],
"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>",
"inbound_payment_reference": "<string>",
"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"
}
},
"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"
}
}
}
],
"partner_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"partner_fees": [
{
"fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"label": "<string>"
}
],
"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"
}
}
},
"quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rate": "<string>",
"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>"
}
],
"cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prev_cursor": null
}"<string>""<string>""<string>"{
"message": "<string>",
"trace_id": "<string>"
}Authorizations
API Key
Headers
Optional sub-partner UUID, if provided, the autoramps will be filtered for the sub-partner
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.
Query Parameters
The optional Customer ID to filter autoramps by. If not provided, returns autoramps for all customers
Filter by autoramp status. Multiple statuses can be provided as comma-separated values.
Available options:
Created, EditPending, Authorized, DepositAccountAdded, Approved, Rejected, Cancelled autoramp type filter Autoramp type
The type (onramp, offramp, swap) of an autoramp
Available options:
Onramp, Offramp, Swap, Mint, Redeem Paging: the cursor field from previous page
Paging: the cursor field for backward pagination
Paging: the requested page size
Required range:
x <= 100Sort order for results. "asc" for oldest first, "desc" for newest first (default).
Available options:
asc, desc Filter by batch payout flag. If true, only batch payout autoramps are returned. If false, only non-batch payout. If omitted, all autoramps are returned.
Filter by autoramp source. "Standalone" returns only market autoramps (with no attached quotes). "Quote" returns only autoramps with at least one attached quote. If omitted, all sources are returned. Autoramp Source
The source of the autoramp
Available options:
Standalone, Quote Response
Get autoramps successful
Was this page helpful?
⌘I