Skip to main content
GET
/
autoramp-transactions
List autoramp transactions
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/autoramp-transactions \
  --header 'X-API-Key: <api-key>'
{
  "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>",
      "fee_settlement": "deductedImmediately",
      "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_amount": {
        "amount": "100.5",
        "currency": {
          "code": "USD",
          "type": "Fiat"
        }
      },
      "state": "Pending",
      "status": "FundsReviewInProgress",
      "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"
              }
            },
            "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"
      },
      "payment_tracking": {
        "ach_trace_number": "<string>",
        "imad": "<string>",
        "omad": "<string>",
        "swift_payment_reference": "<string>",
        "wire_message": "<string>"
      },
      "payout_crypto_transaction": {
        "transaction_hash": "5J9qvKhKqYbpjhCkqDnKXSp7QqLDBU5iT4VWshsqRdWKHjKdqZqKqYbpjhCkqDnKXSp"
      },
      "source": {
        "blockchain": "Solana",
        "wallet_address": "7QqLDBU5iT4VWshsqRdWKHjKdqZqKqYbpjhCkqDnKXSp"
      }
    }
  ],
  "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prev_cursor": null
}

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

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 <= 100
​
search_term
string

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

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

Response

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

​
cursor
string<uuid>

The cursor used to fetch the next page

​
prev_cursor
string<uuid>

The cursor used to fetch the previous page