Unstoppable Finance (Iron) Autoramp API
Operations on Autoramp
Unstoppable Finance (Iron) Autoramp API is one of 9 APIs that Unstoppable Finance (Iron) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Autoramp. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 17 operations across 13 paths, and defines 141 schemas. It is described by OpenAPI 3.1.0, at version 1.0-16988.
Requests are made against a single base URL, https://api.sandbox.iron.xyz/api.
17 operations
13 paths
141 schemas
1 DELETE11 GET1 PATCH4 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Unstoppable Finance (Iron) Autoramp API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-API-Key (ApiKeyAuth).
ApiKeyAuth— API Key
Paths & Operations 17
Across 13 paths, the API surfaces 17 operations — 1 DELETE, 11 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Autoramp 17
Operations on Autoramp
GET
/autoramp-transactions
List autoramp transactions
GET
/autoramp-transactions/ids
Get autoramp transactions by transaction IDs
GET
/autoramps
List Autoramps for a Customer
POST
/autoramps
Create a new Autoramp
GET
/autoramps/check-limit
Check if a customer can create more autoramps
GET
/autoramps/payments/open-banking/{payment_id}
Get the autoramp open banking payment for existing payment
GET
/autoramps/quote
Get a quote for an autoramp
GET
/autoramps/quotes-preview
Get autoramp quote preview
DELETE
/autoramps/{autoramp_id}
Cancel an Autoramp
GET
/autoramps/{autoramp_id}
Get an Autoramp by ID
PATCH
/autoramps/{autoramp_id}
Patch an autoramp market
GET
/autoramps/{autoramp_id}/payments/open-banking
List open banking payments for an autoramp
POST
/autoramps/{autoramp_id}/payments/open-banking
Create an open banking payment link
GET
/autoramps/{autoramp_id}/quote
Get a rate quote for an existing autoramp
POST
/autoramps/{autoramp_id}/quotes
Attach a quote to an existing autoramp
POST
/autoramps/{autoramp_id}/retry-authdeprecated
Retry authentication
GET
/autoramps/{external_id}/external
Get an Autoramp by external ID
Schemas 141
The contract defines 141 schemas that model the data the API accepts and returns. The most detailed are SignedAutorampQuote (27 properties), Autoramp (26 properties), AutorampTransaction (22 properties), CreateAutorampParameters (16 properties). Each schema is shown below with its type and property counts.
Country
object
A country
1 property
1 required
PagedList_Autoramp
object
PagedList A list of items with cursors used to fetch the next or previous page
3 properties
1 required
BankAccountCHAPSIdentifier
object
2 properties
2 required
SwiftDepositInfo
object
7 properties
6 required
DepositAccount_MobileMoneyDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
Account_CryptoWallet
Account The account for the autoramp
PixEvpKey
object
PixEvpKey A random PIX DICT key (EVP) generated by the recipient's bank.
1 property
1 required
Currency_Fiat
Currency Can be either crypto or fiat
RampTransactionSource
object
The source of the autoramp transaction
PixCpfKey
object
PixCpfKey A PIX DICT key that is the recipient's CPF.
1 property
1 required
PixAccountIdentifier
object
PixAccountIdentifier How the recipient's PIX account is identified: a DICT key of one of the five key types, or full bank account details.
PixPhoneKey
object
PixPhoneKey A PIX DICT key that is the recipient's phone number.
1 property
1 required
AutorampStatus
string
ApiBankAccountSource
object
A bank account source of an autoramp transaction
7 properties
4 required
SpeiDepositInfo
object
2 properties
2 required
AutorampTransactionState
string
Autoramp Transaction State The state of the autoramp transaction
AuthenticationCode
object
An authentication code used to confirm a 2FA action
5 properties
5 required
DepositAccountType
string
AchWireDepositInfo
object
6 properties
6 required
DepositRail_SpeiDepositInfo
PartnerFee
object
Partner Fee A partner fee
3 properties
3 required
AutorampQuote
object
Autoramp Quote The autoramp quote used to create an autoramp
11 properties
10 required
RateExpiryPolicy
string
Rate Expiry Policy The policy for the rate expiry
DepositAccount_IbanDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
BankAccountIdentifier_BankAccountSWIFTIdentifier
FpsDepositInfo
object
5 properties
2 required
ACHDepositInfo
object
6 properties
6 required
ApiAutorampQuotePreview
object
Autoramp Quote Preview A recipient-free pricing preview, shaped like a signed quote but not submittable: no quoteid, signature, or validity window.
10 properties
9 required
Recipient_RecipientBankAccount
Recipient The recipient of the payment
DepositAccount_SpeiDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
BankAccountIdentifier_BankAccountFedNowIdentifier
RecipientPostalAddress
object
RecipientPostalAddress The account holder's address.
5 properties
5 required
PixAccountIdentifier_PixCnpjKey
PixAccountIdentifier How the recipient's PIX account is identified: a DICT key of one of the five key types, or full bank account details.
PixAccount
object
PIX Account References a previously-registered PIX destination by its id.
1 property
1 required
DepositRail_MobileMoneyDepositInfo
BankAccountIdentifier_BankAccountACHIdentifier
Currency
object
Currency Can be either crypto or fiat
Crypto
object
A cryptocurrency
2 properties
2 required
DepositRail_FedNowDepositInfo
Available from API version 2026-07-01.
RecipientName_IndividualName
DepositRail
object
DepositRail_AfricanBankTransferDepositInfo
NetworkFee
object
Network Fee The network fee for a given currency. This is deprecated and will be removed in the future. Use NetworkFeeWithSettlement instead.
IbanDepositInfo
object
6 properties
1 required
BankAccountIdentifier_BankAccountCHAPSIdentifier
ApiAutorampOpenBankingPayment
object
Autoramp Open Banking Payment with link to initiate flow One payment attempt against a provider for an autoramp's open-banking flow.
5 properties
3 required
BankAccountIdentifier_BankAccountFPSIdentifier
DepositRail_RtpDepositInfo
CryptoWallet
object
Crypto Wallet The crypto wallet for the autoramp
2 properties
2 required
DepositRail_ACHDepositInfo
AutorampType
string
Autoramp type The type (onramp, offramp, swap) of an autoramp
AfricanBankTransferDepositInfo
object
8 properties
PixEmailKey
object
PixEmailKey A PIX DICT key that is the recipient's email address.
1 property
1 required
NetworkFee_Amount
Network Fee The network fee for a given currency. This is deprecated and will be removed in the future. Use NetworkFeeWithSettlement instead.
DepositAccount_ChapsFpsDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
PixDepositInfo
object
2 properties
2 required
RecipientName
object
BankAccountFPSIdentifier
object
2 properties
2 required
PagedList_AutorampTransaction
object
PagedList A list of items with cursors used to fetch the next or previous page
3 properties
1 required
ApiCanCreateAutorampResponse
object
Can Create Autoramp Response Indicates whether a customer can create a new autoramp.
1 property
1 required
Bank
string
DepositAccount_AchWireDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
SortOrder
string
RecipientBankAccount
object
RecipientBankAccount A recipient fiat bank account
9 properties
6 required
RtpDepositInfo
object
6 properties
6 required
DepositAccount_PixDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
CreateAutoramp
Either a set of market parameters or a signed quote. Optionally include a type field (market | quote) to get precise validation errors.
BankAccountWireIdentifier
object
2 properties
2 required
Blockchain
string
Blockchain A type of blockchain
NetworkFeeWithSettlement
object
Network Fee with Settlement The network fee with settlement for a given currency
3 properties
2 required
ChapsDepositInfo
object
5 properties
2 required
PixAccountIdentifier_PixCpfKey
PixAccountIdentifier How the recipient's PIX account is identified: a DICT key of one of the five key types, or full bank account details.
NetworkFeeType
string
Network Fee Type The type of network fee
AuthenticationCodeStatus
string
The status of the Authentication Code
PagedList_ApiAutorampOpenBankingPayment
object
PagedList A list of items with cursors used to fetch the next or previous page
3 properties
1 required
RecipientName_BusinessName
ApiError
object
Standard error response returned to API clients for server errors. Includes a traceid that clients can reference when reporting issues.
2 properties
2 required
Recipient_RecipientPix
Recipient The recipient of the payment
EmailAddress
object
EmailAddress An email address An email address
1 property
1 required
FiatAccount
object
Fiat Account The fiat account for the autoramp
1 property
1 required
BankAccountIdentifier_BankAccountWireIdentifier
BankAccountIdentifier_Iban
DepositAccount
object
DepositAccount DEPRECATED: please use the depositrails field instead
BankAccountFedNowIdentifier
object
2 properties
2 required
DepositRail_SwiftDepositInfo
DepositRail_IbanDepositInfo
PixAccountIdentifier_PixEmailKey
PixAccountIdentifier How the recipient's PIX account is identified: a DICT key of one of the five key types, or full bank account details.
BankAccountACHIdentifier
object
2 properties
2 required
SignedAutorampRateQuote
object
Signed rate quote for an existing autoramp. Contains only pricing fields — the autoramp's currencies, recipient, etc. are already known. Deposits are matched t…
15 properties
13 required
MobileMoneyDepositInfo
object
2 properties
1 required
DepositAccount_CryptoWallet
DepositAccount DEPRECATED: please use the depositrails field instead
DepositRail_ChapsDepositInfo
Fee
object
Fee The fee for a given currency pair
12 properties
9 required
PixCnpjKey
object
PixCnpjKey A PIX DICT key that is the recipient's CNPJ.
1 property
1 required
BankAccountSWIFTIdentifier
object
3 properties
2 required
FeeSettlement
string
Fee Settlement The settlement type for the fee
ApiAutorampOpenBankingPaymentSettlementStatus
string
RecipientWallet
object
RecipientWallet An on-chain wallet address
2 properties
2 required
BankAccountIdentifier
object
Iban
object
1 property
1 required
ApiThirdPartyClassification
string
Account_PixAccount
Account The account for the autoramp
Autoramp
object
Autoramp The autoramp response A Autoramp response
26 properties
14 required
DepositRail_FpsDepositInfo
Fiat
object
A fiat currency
1 property
1 required
Recipient_RecipientWallet
Recipient The recipient of the payment
IndividualName
object
2 properties
2 required
CreateAutorampOpenBankingPayment
object
Create Autoramp Payment Link Payload The parameters for creating an autoramp payment link
2 properties
2 required
FedNowDepositInfo
object
Available from API version 2026-07-01.
6 properties
6 required
SignedAutorampQuote
object
Signed Autoramp Quote The signed autoramp quote
27 properties
14 required
ApiAutorampOpenBankingPaymentStatus
string
Autoramp Payment Link Status The status of the autoramp payment link
ChapsFpsDepositInfo
object
5 properties
2 required
BankAccountRTPIdentifier
object
2 properties
2 required
BankPostalAddress
object
BankPostalAddress The bank's address. Only required for SWIFT accounts.
5 properties
5 required
PixBankDetails
object
PixBankDetails Full Brazilian bank account details identifying the recipient's account, for recipients without a registered PIX key.
4 properties
4 required
BankAccountIdentifier_BankAccountRTPIdentifier
AutorampTransaction
object
Autoramp Transaction The autoramp transaction response A Payment response
22 properties
14 required
Account_FiatAccount
Account The account for the autoramp
RecipientPix
object
RecipientPix A PIX payout recipient.
3 properties
3 required
ApiWalletDepositSource
object
A wallet deposit source of an autoramp transaction
3 properties
2 required
Amount
object
An amount of money
2 properties
2 required
Recipient
object
Recipient The recipient of the payment
PayoutCryptoTransaction
object
Payout Transaction Details Details about the blockchain transaction used for crypto payouts
1 property
1 required
DepositRail_PixDepositInfo
DepositRail_CryptoWallet
Currency_Crypto
Currency Can be either crypto or fiat
CreateAutorampParameters
object
Create Autoramp Parameters The parameters required to create a autoramp
16 properties
4 required
PaymentNetwork
string
PaymentNetwork A payment network
PixAccountIdentifier_PixBankDetails
PixAccountIdentifier How the recipient's PIX account is identified: a DICT key of one of the five key types, or full bank account details.
DepositRail_WireDepositInfo
WireDepositInfo
object
6 properties
6 required
AutorampTransactionStatus
string
Autoramp Transaction Status The status of the autoramp transaction
PaymentTracking
object
Tracking information for this transactions' payout. Only populated for completed transactions
9 properties
BusinessName
object
1 property
1 required
PixAccountIdentifier_PixPhoneKey
PixAccountIdentifier How the recipient's PIX account is identified: a DICT key of one of the five key types, or full bank account details.
PixAccountIdentifier_PixEvpKey
PixAccountIdentifier How the recipient's PIX account is identified: a DICT key of one of the five key types, or full bank account details.
DepositAccount_AfricanBankTransferDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
PatchAutorampMarketParameters
object
Patch Autoramp Market Parameters The parameters for patching the autoramp market
4 properties
1 required
PixAccountType
string
PixAccountType The type of a Brazilian bank account.
AutorampSource
string
Autoramp Source The source of the autoramp
Account
object
Account The account for the autoramp
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Unstoppable Finance (Iron) 8
Other APIs Unstoppable Finance (Iron) publishes across the network.
Unstoppable Finance (Iron) Addresses API
Unstoppable Finance (Iron) Currencies API
Unstoppable Finance (Iron) Customer API
Unstoppable Finance (Iron) ExchangeRate API
Unstoppable Finance (Iron) FeeProfiles API
Unstoppable Finance (Iron) Sandbox API
Unstoppable Finance (Iron) TermsAndConditions API
Unstoppable Finance (Iron) Webhooks API
#Autoramp
Where this information came from
This is an independent, third-party profile of Unstoppable Finance (Iron) Autoramp API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.