The identity and technical contract details declared by the specification.
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
DepositAccount_MobileMoneyDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
BankAccountIdentifier_BankAccountWireIdentifier
Recipient_RecipientPix
Recipient The recipient of the payment
Crypto
object
A cryptocurrency
2 properties
2 required
DepositRail_SwiftDepositInfo
Fee
object
Fee The fee for a given currency pair
12 properties
9 required
FiatAddress
object
Fiat Address Response containing fiat address details
13 properties
12 required
BankAccountIdentifier_BankAccountFPSIdentifier
CryptoWallet
object
Crypto Wallet The crypto wallet for the autoramp
2 properties
2 required
DepositAccount
object
DepositAccount DEPRECATED: please use the depositrails field instead
AutorampQuote
object
Autoramp Quote The autoramp quote used to create an autoramp
11 properties
10 required
SpeiDepositInfo
object
2 properties
2 required
FeeSettlement
string
Fee Settlement The settlement type for the fee
BusinessName
object
1 property
1 required
ApiBankAccountSource
object
A bank account source of an autoramp transaction
7 properties
4 required
BankAccountIdentifier_Iban
Country
object
A country
1 property
1 required
DepositRail_RtpDepositInfo
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.
IdentificationStepStatus
object
DepositAccount_SpeiDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
BankAccountIdentifier_BankAccountFedNowIdentifier
Currency
object
Currency Can be either crypto or fiat
Blockchain
string
Blockchain A type of blockchain
Currency_Fiat
Currency Can be either crypto or fiat
DepositAccount_IbanDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
Autoramp
object
Autoramp The autoramp response A Autoramp response
26 properties
14 required
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_AchWireDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
BankAccountIdentifier_BankAccountSWIFTIdentifier
Recipient
object
Recipient The recipient of the payment
NetworkFee
object
Network Fee The network fee for a given currency. This is deprecated and will be removed in the future. Use NetworkFeeWithSettlement instead.
SandboxSandboxTransaction
object
9 properties
9 required
PixEvpKey
object
PixEvpKey A random PIX DICT key (EVP) generated by the recipient's bank.
1 property
1 required
PixCnpjKey
object
PixCnpjKey A PIX DICT key that is the recipient's CNPJ.
1 property
1 required
EmailAddress
object
EmailAddress An email address An email address
1 property
1 required
UpdateRampTransactionStateParams
object
1 property
1 required
PixEmailKey
object
PixEmailKey A PIX DICT key that is the recipient's email address.
1 property
1 required
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.
PixAccountType
string
PixAccountType The type of a Brazilian bank account.
PixPhoneKey
object
PixPhoneKey A PIX DICT key that is the recipient's phone number.
1 property
1 required
AfricanBankTransferDepositInfo
object
8 properties
BankAccountSWIFTIdentifier
object
3 properties
2 required
BankPostalAddress
object
BankPostalAddress The bank's address. Only required for SWIFT accounts.
5 properties
5 required
RecipientWallet
object
RecipientWallet An on-chain wallet address
2 properties
2 required
RtpDepositInfo
object
6 properties
6 required
FpsDepositInfo
object
5 properties
2 required
Iban
object
1 property
1 required
DepositRail_WireDepositInfo
DepositAccount_PixDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
Recipient_RecipientBankAccount
Recipient The recipient of the payment
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
UpdatePendingIdentificationParams
object
1 property
1 required
Amount
object
An amount of money
2 properties
2 required
Currency_Crypto
Currency Can be either crypto or fiat
BankAccountFPSIdentifier
object
2 properties
2 required
CreateSandboxTransactionParams
object
10 properties
2 required
AutorampType
string
Autoramp type The type (onramp, offramp, swap) of an autoramp
RecipientBankAccount
object
RecipientBankAccount A recipient fiat bank account
9 properties
6 required
ChapsFpsDepositInfo
object
5 properties
2 required
RecipientPix
object
RecipientPix A PIX payout recipient.
3 properties
3 required
BankAccountWireIdentifier
object
2 properties
2 required
BankAccountCHAPSIdentifier
object
2 properties
2 required
DepositRail_ChapsDepositInfo
IdentificationStatus
string
The Process status of the identification The various state transitions an identification can go through.
FedNowDepositInfo
object
Available from API version 2026-07-01.
6 properties
6 required
RateExpiryPolicy
string
Rate Expiry Policy The policy for the rate expiry
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.
BankAccountIdentifier
object
IbanDepositInfo
object
6 properties
1 required
RecipientPostalAddress
object
RecipientPostalAddress The account holder's address.
5 properties
5 required
DepositRail_ACHDepositInfo
ACHDepositInfo
object
6 properties
6 required
DepositRail_AfricanBankTransferDepositInfo
DepositAccount_CryptoWallet
DepositAccount DEPRECATED: please use the depositrails field instead
DepositAccount_AfricanBankTransferDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
ChapsDepositInfo
object
5 properties
2 required
SwiftDepositInfo
object
7 properties
6 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.
BankAccountIdentifier_BankAccountACHIdentifier
PaymentNetwork
string
PaymentNetwork A payment network
DepositAccount_ChapsFpsDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
BankAccountRTPIdentifier
object
2 properties
2 required
Recipient_RecipientWallet
Recipient The recipient of the payment
DepositRail_IbanDepositInfo
SandboxTransactionState
string
PersonIdentificationStepStatus
object
4 properties
AchWireDepositInfo
object
6 properties
6 required
IndividualName
object
2 properties
2 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.
RecipientName_BusinessName
DepositRail_SpeiDepositInfo
DepositRail_FpsDepositInfo
NetworkFeeType
string
Network Fee Type The type of network fee
AutorampSource
string
Autoramp Source The source of the autoramp
BankAccountIdentifier_BankAccountRTPIdentifier
DepositRail_FedNowDepositInfo
Available from API version 2026-07-01.
FiatAddressStatus
string
Verification Status The status of the verification of a fiat address
VerificationStepDetail
object
3 properties
2 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.
MobileMoneyDepositInfo
object
2 properties
1 required
BankAccountFedNowIdentifier
object
2 properties
2 required
Fiat
object
A fiat currency
1 property
1 required
BusinessIdentificationStepStatus
object
4 properties
Identification
object
Identification The entity wrapping our KYC/KYB process and underlying providers
11 properties
4 required
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.
DepositRail_MobileMoneyDepositInfo
BankAccountACHIdentifier
object
2 properties
2 required
PixDepositInfo
object
2 properties
2 required
RecipientName_IndividualName
BankAccountIdentifier_BankAccountCHAPSIdentifier
DepositRail_PixDepositInfo
ApiWalletDepositSource
object
A wallet deposit source of an autoramp transaction
3 properties
2 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
WireDepositInfo
object
6 properties
6 required
NetworkFeeWithSettlement
object
Network Fee with Settlement The network fee with settlement for a given currency
3 properties
2 required
PartnerFee
object
Partner Fee A partner fee
3 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Unstoppable Finance (Iron) publishes across the network.