List autoramp transactions

Returns a list of transactions, optionally filtered by autoramp ID or customer ID

An optional search_term parameter can be provided that will search the following fields:

• Bank Account Name
• Bank Account Provider Name
• Wallet Address
• Transaction ID

GET /autoramp-transactions

List autoramp transactions

cURL

curl --request GET \
  --url https://api.sandbox.iron.xyz/api/autoramp-transactions \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.sandbox.iron.xyz/api/autoramp-transactions"

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/autoramp-transactions', 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/autoramp-transactions",
  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/autoramp-transactions"

	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/autoramp-transactions")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.iron.xyz/api/autoramp-transactions")

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

200

{
  "items": [
    {
      "autoramp_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "destination_amount": {
        "amount": "100.5",
        "currency": {
          "code": "USD",
          "type": "Fiat"
        }
      },
      "exchange_rate": "<string>",
      "fee": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_third_party": true,
      "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": "[e-mail]"
        },
        "is_third_party": false,
        "phone_number": "[phone]",
        "provider_country": {
          "code": "DE"
        },
        "provider_name": "Iron Bank",
        "recipient": {
          "name": "Aperture Science",
          "type": "Business"
        }
      },
      "source_amount": {
        "amount": "100.5",
        "currency": {
          "code": "USD",
          "type": "Fiat"
        }
      },
      "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fee_breakdown": {
        "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"
          }
        }
      },
      "inbound_payment_reference": "<string>",
      "ob_payment_id": "<string>",
      "payment_tracking": {
        "ach_payment_reference": "<string>",
        "ach_trace_number": "<string>",
        "fps_payment_reference": "<string>",
        "imad": "<string>",
        "omad": "<string>",
        "sepa_payment_reference": "<string>",
        "swift_payment_reference": "<string>",
        "uetr": "<string>",
        "wire_message": "<string>"
      },
      "payout_crypto_transaction": {
        "transaction_hash": "5J9qvKhKqYbpjhCkqDnKXSp7QqLDBU5iT4VWshsqRdWKHjKdqZqKqYbpjhCkqDnKXSp"
      },
      "source": {
        "blockchain": "Solana",
        "deposit_tx_hash": "45E89p7aRyUzsqbqstCkKqxaaeYXgagbq8ccHCZWMRN1E8KAqoEPACDasVjkMMbDJGwrwFHz5RDT67kUN3p5Rk81",
        "wallet_address": "7QqLDBU5iT4VWshsqRdWKHjKdqZqKqYbpjhCkqDnKXSp"
      }
    }
  ],
  "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prev_cursor": null
}

"<string>"

"<string>"

{
  "message": "<string>",
  "trace_id": "<string>"
}

Authorizations

X-API-Key · string · header · required

API Key

Headers

X-SUB-PARTNER-ID · string

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

X-API-Version · string

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

autoramp_id · string<uuid>

Optional autoramp ID

customer_id · string<uuid>

Optional customer ID

cursor · string<uuid>

Paging: the cursor field from previous page

prev_cursor · string<uuid>

Paging: the cursor field for backward pagination

page_size · integer<uint32> · default: 10

Paging: the requested page size

Required range: x <= 500

search_term · string

A search term to filter the transactions (searches bank account name, provider, wallet address, transaction ID, deposit transaction hash)

Maximum string length: 256

ramp_type · enum<string>

Type of the autoramp (onramp, offramp or crypto-to-crypto swap) Autoramp type

The type (onramp, offramp, swap) of an autoramp

Available options: Onramp, Offramp, Swap, Mint, Redeem

from_date · string<date-time>

Filter by start date (inclusive). Only transactions created on or after this date will be returned.

to_date · string<date-time>

Filter by end date (inclusive). Only transactions created on or before this date will be returned.

status · enum<string>[]

Filter by transaction status. Multiple statuses can be provided as comma-separated values.

Autoramp Transaction Status

The status of the autoramp transaction

Available options: FundsReviewInProgress, ConversionInProgress, PayoutInProgress, Completed, Failed, RejectedAml, RejectedFraud, RejectedMinAmount

sort_order · enum<string>

Sort order for results. "asc" for oldest first, "desc" for newest first (default).

Available options: asc, desc

is_batch_payout · boolean

Filter by batch payout flag. If true, only batch payout transactions are returned. If false, only non-batch payout. If omitted, all transactions are returned.

Response

200

application/json; charset=utf-8

Autoramp Transaction List

PagedList

A list of items with cursors used to fetch the next or previous page

items · AutorampTransaction · object[] · required

The list of items

Show child attributes

cursor · string<uuid>

The cursor used to fetch the next page

prev_cursor · string<uuid>

The cursor used to fetch the previous page