Iron API - Sandbox
- GETList autoramp transactions
- GETGet autoramp transactions by transaction IDs
- GETList Autoramps for a Customer
- POSTCreate a new Autoramp
- GETCheck if a customer can create more autoramps
- GETGet the autoramp open banking payment for existing payment
- GETGet a quote for an autoramp
- GETGet an Autoramp by ID
- DELCancel an Autoramp
- PATCHPatch an autoramp market
- POSTCreate an open banking payment link
- POSTRetry authentication
- GETGet an Autoramp by external ID
- GET
curl --request GET \
--url https://api.sandbox.iron.xyz/api/autoramp-transactions/ids \
--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,
"recipient": {
"account_identifier": {
"iban": "DE89370400440532013000",
"type": "SEPA"
},
"address": {
"city": "London",
"country": {
"code": "GB"
},
"postal_code": "SW1A 2AA",
"state": "England",
"street": "10 Downing Street"
},
"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"
}
},
"deducted_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"iron_fee_settlement": "deductedImmediately"
},
"payment_tracking": {
"imad": "<string>",
"omad": "<string>"
},
"payout_crypto_transaction": {
"transaction_hash": "5J9qvKhKqYbpjhCkqDnKXSp7QqLDBU5iT4VWshsqRdWKHjKdqZqKqYbpjhCkqDnKXSp"
},
"source": {
"blockchain": "Solana",
"wallet_address": "7QqLDBU5iT4VWshsqRdWKHjKdqZqKqYbpjhCkqDnKXSp"
}
}
],
"cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prev_cursor": null
}Get autoramp transactions by transaction IDs
Return a subset of transactions by ID. This can be used to query multiple transactions for updated states without having to go through all transactions.
You have to provide at least one transaction ID
Returns at most 100 transactions
curl --request GET \
--url https://api.sandbox.iron.xyz/api/autoramp-transactions/ids \
--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,
"recipient": {
"account_identifier": {
"iban": "DE89370400440532013000",
"type": "SEPA"
},
"address": {
"city": "London",
"country": {
"code": "GB"
},
"postal_code": "SW1A 2AA",
"state": "England",
"street": "10 Downing Street"
},
"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"
}
},
"deducted_fee": {
"amount": "100.5",
"currency": {
"code": "USD",
"type": "Fiat"
}
},
"iron_fee_settlement": "deductedImmediately"
},
"payment_tracking": {
"imad": "<string>",
"omad": "<string>"
},
"payout_crypto_transaction": {
"transaction_hash": "5J9qvKhKqYbpjhCkqDnKXSp7QqLDBU5iT4VWshsqRdWKHjKdqZqKqYbpjhCkqDnKXSp"
},
"source": {
"blockchain": "Solana",
"wallet_address": "7QqLDBU5iT4VWshsqRdWKHjKdqZqKqYbpjhCkqDnKXSp"
}
}
],
"cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prev_cursor": null
}Authorizations
API Key
Query Parameters
Ids of the transactions to get
Response
Autoramp Transaction List
PagedList
A list of items with cursors used to fetch the next or previous page
The list of items
Show child attributes
Show child attributes
The ID of the autoramp this transaction belongs to
Date of transaction creation
The ID of the customer two whom this transaction belongs
An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}The exchange rate
The total fee charged
Fee Settlement
The settlement type for the fee
deductedImmediately, settledLater The ID of the transaction
Is this a third party payment (3pp) autoramp
Recipient
The recipient of the payment
- RecipientBankAccount
- RecipientWallet
- RecipientPix
Show child attributes
Show child attributes
BankAccount "BankAccount"
- Iban
- BankAccountACHIdentifier
- BankAccountWireIdentifier
- BankAccountRTPIdentifier
- BankAccountSWIFTIdentifier
- BankAccountCHAPSIdentifier
- BankAccountFPSIdentifier
{ "iban": "DE89370400440532013000" }RecipientPostalAddress
The account holder's address.
Show child attributes
Show child attributes
The city
The postal code
The state
The street address
Is this a users fiat bank account or a third party fiat bank account
The name of the provider of the recipient's account
- IndividualName
- BusinessName
{
"family_name": "Turing",
"given_name": "Alan"
}The recipient's phone number. Required for USD accounts.
{
"account_identifier": {
"iban": "DE89370400440532013000",
"type": "SEPA"
},
"address": {
"city": "London",
"country": { "code": "GB" },
"postal_code": "SW1A 2AA",
"state": "England",
"street": "10 Downing Street"
},
"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"
}
}An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}The current state of the transaction. DEPRECATED: use 'status'
Pending, PayoutPending, Payout, PayoutCompleted, Completed, Failed, InAmlReview, AmlRejected, AmountRejected, FraudRejected Autoramp Transaction Status
The status of the autoramp transaction
FundsReviewInProgress, ConversionInProgress, PayoutInProgress, Completed, Failed, RejectedAml, RejectedFraud, RejectedMinAmount Fee
The fee for a given currency pair
Show child attributes
Show child attributes
An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}The network fees in source currency
Network Fee
The network fee for a given currency. This is deprecated and will be removed in the future. Use NetworkFeeWithSettlement instead.
- Amount
- Amount
- Amount
- Amount
- Amount
- Amount
- Amount
Show child attributes
Show child attributes
SwiftOut "SwiftOut"
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}The network fees with settlement
Show child attributes
Show child attributes
An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}Network Fee Type
The type of network fee
SepaIn, SepaOut, EthereumGas, SolanaTransactionFee, StellarTransactionFee, RailFee, AchIn, AchOut, WireIn, WireOut, SwiftIn, SwiftOut, FpsIn, FpsOut, ChapsIn, ChapsOut Fee Settlement
The settlement type for the fee
deductedImmediately, settledLater An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}The partner fees
Show child attributes
Show child attributes
An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}The label of the partner fee
Fee Settlement
The settlement type for the fee
deductedImmediately, settledLater An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}An amount of money
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}The amount of the fee that was deducted immediately and charged to the end customer. This is deprecated and will be removed in the future. Use transaction_fee instead.
Show child attributes
Show child attributes
The amount, a decimal number
Currency
Can be either crypto or fiat
- Crypto
- Fiat
Show child attributes
Show child attributes
Crypto "Crypto"
Blockchain
A type of blockchain
Solana, Ethereum, Polygon, Arbitrum, Base, Stellar The ticker of the token e.g. 'USDC'
{ "blockchain": "Solana", "token": "USDC" }{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}Fee Settlement
The settlement type for the fee
deductedImmediately, settledLater Payout Transaction Details
Details about the blockchain transaction used for crypto payouts
Show child attributes
Show child attributes
The blockchain transaction hash
{
"transaction_hash": "5J9qvKhKqYbpjhCkqDnKXSp7QqLDBU5iT4VWshsqRdWKHjKdqZqKqYbpjhCkqDnKXSp"
}The source of the autoramp transaction A wallet deposit source of an autoramp transaction
The cursor used to fetch the next page
The cursor used to fetch the previous page