The identity and technical contract details declared by the specification.
Country
object
A country
1 property
1 required
BankAccountCHAPSIdentifier
object
2 properties
2 required
SandboxSandboxTransaction
object
9 properties
9 required
SwiftDepositInfo
object
7 properties
6 required
DepositAccount_MobileMoneyDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
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
CreateSandboxTransactionParams
object
10 properties
2 required
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
SandboxTransactionState
string
Identification
object
Identification The entity wrapping our KYC/KYB process and underlying providers
11 properties
4 required
ApiBankAccountSource
object
A bank account source of an autoramp transaction
7 properties
4 required
SpeiDepositInfo
object
2 properties
2 required
AchWireDepositInfo
object
6 properties
6 required
DepositRail_SpeiDepositInfo
AutorampQuote
object
Autoramp Quote The autoramp quote used to create an autoramp
11 properties
10 required
PartnerFee
object
Partner Fee A partner fee
3 properties
3 required
RateExpiryPolicy
string
Rate Expiry Policy The policy for the rate expiry
DepositAccount_IbanDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
FpsDepositInfo
object
5 properties
2 required
ACHDepositInfo
object
6 properties
6 required
BankAccountIdentifier_BankAccountSWIFTIdentifier
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.
DepositRail_MobileMoneyDepositInfo
DepositRail_FedNowDepositInfo
Available from API version 2026-07-01.
BankAccountIdentifier_BankAccountACHIdentifier
Currency
object
Currency Can be either crypto or fiat
Crypto
object
A cryptocurrency
2 properties
2 required
RecipientName_IndividualName
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
BankAccountIdentifier_BankAccountFPSIdentifier
IdentificationStepStatus
object
DepositRail_RtpDepositInfo
DepositRail_ACHDepositInfo
CryptoWallet
object
Crypto Wallet The crypto wallet for the autoramp
2 properties
2 required
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
BankAccountFPSIdentifier
object
2 properties
2 required
DepositAccount_AchWireDepositInfo
DepositAccount DEPRECATED: please use the depositrails field instead
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
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
BusinessIdentificationStepStatus
object
4 properties
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
BankAccountIdentifier_BankAccountWireIdentifier
BankAccountIdentifier_Iban
FiatAddress
object
Fiat Address Response containing fiat address details
13 properties
12 required
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
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
FiatAddressStatus
string
Verification Status The status of the verification of a fiat address
BankAccountSWIFTIdentifier
object
3 properties
2 required
FeeSettlement
string
Fee Settlement The settlement type for the fee
RecipientWallet
object
RecipientWallet An on-chain wallet address
2 properties
2 required
BankAccountIdentifier
object
Iban
object
1 property
1 required
Autoramp
object
Autoramp The autoramp response A Autoramp response
26 properties
14 required
DepositRail_FpsDepositInfo
Recipient_RecipientWallet
Recipient The recipient of the payment
Fiat
object
A fiat currency
1 property
1 required
IndividualName
object
2 properties
2 required
FedNowDepositInfo
object
Available from API version 2026-07-01.
6 properties
6 required
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
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
DepositRail_PixDepositInfo
Currency_Crypto
Currency Can be either crypto or fiat
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.
IdentificationStatus
string
The Process status of the identification The various state transitions an identification can go through.
UpdatePendingIdentificationParams
object
1 property
1 required
UpdateRampTransactionStateParams
object
1 property
1 required
PersonIdentificationStepStatus
object
4 properties
DepositRail_WireDepositInfo
VerificationStepDetail
object
3 properties
2 required
WireDepositInfo
object
6 properties
6 required
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
PixAccountType
string
PixAccountType The type of a Brazilian bank account.
AutorampSource
string
Autoramp Source The source of the autoramp
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Unstoppable Finance (Iron) publishes across the network.