curl --request GET \
--url https://api.sandbox.iron.xyz/api/autoramps \
--header 'X-API-Key: <api-key>'{
"items": [
{
"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>",
"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"
}
},
"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>"
},
"swift_payment_reference": "<string>",
"travel_address": "<string>",
"wire_message": "<string>"
}
],
"cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prev_cursor": null
}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
curl --request GET \
--url https://api.sandbox.iron.xyz/api/autoramps \
--header 'X-API-Key: <api-key>'{
"items": [
{
"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>",
"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"
}
},
"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>"
},
"swift_payment_reference": "<string>",
"travel_address": "<string>",
"wire_message": "<string>"
}
],
"cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prev_cursor": null
}API Key
Optional sub-partner UUID, if provided, the autoramps will be filtered for the sub-partner
The optional Customer ID to filter autoramps by. If not provided, returns autoramps for all customers
The status of the autoramps to get. If not provided, returns all autoramps
Created, EditPending, Authorized, DepositAccountAdded, Approved, Rejected, Cancelled autoramp type filter Autoramp type
The type (onramp, offramp, swap) of an autoramp
Onramp, Offramp, Swap, Mint, Redeem Paging: the cursor field from previous page
Paging: the cursor field for backward pagination
Paging: the requested page size
x <= 100Get autoramps successful
Was this page helpful?