> ## Documentation Index > Fetch the complete documentation index at: https://dev.enterprise.moonpay.com/llms.txt > Use this file to discover all available pages before exploring further. # 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 ## OpenAPI ````yaml https://api.sandbox.iron.xyz/spec/2026-10-01/docs get /autoramp-transactions/ids openapi: 3.2.0 info: description: The Stablecoin Payment Network title: Iron API - Sandbox version: '2026-10-01' servers: - url: https://api.sandbox.iron.xyz/api security: [] tags: - description: Operations on Customers kind: nav name: Customer - description: Verifying a customer's identity or business kind: nav name: Identifications parent: Customer - description: The legal agreements and consents a customer signs kind: nav name: Signings parent: Customer - description: Compliance requests for documents or answers from a customer kind: nav name: Requests for information parent: Customer - description: Codes that authorize an autoramp or bank account awaiting authorization kind: nav name: Authentication codes parent: Customer - description: >- Wallet and bank account registration Every wallet address that interacts with Iron must be registered (linked) to a customer **before** it can be used in any flow — onramp, offramp, or swap. This is a regulatory requirement under the **Travel Rule**, which obliges Virtual Asset Service Providers to exchange originator and beneficiary information for crypto transfers. Iron supports two wallet types: - **Self-hosted wallets** — the customer controls the private key. Registration requires a signed proof-of-ownership message. - **Hosted wallets** — the wallet is custodied by another VASP (e.g. Coinbase, Kraken). Registration requires the VASP's DID so Iron can exchange travel-rule data with the custodian. Similarly, fiat bank accounts must be registered before they can receive offramp payouts. kind: nav name: Addresses - description: Bank accounts that receive offramp payouts kind: nav name: Bank accounts parent: Addresses - description: Self-hosted and hosted wallets kind: nav name: Wallets parent: Addresses - description: Pix keys that receive BRL payouts kind: nav name: Pix parent: Addresses - description: Operations on Autoramp kind: nav name: Autoramp - description: Prices for an autoramp's conversion kind: nav name: Quotes parent: Autoramp - description: Paying into an autoramp by open banking or Pix kind: nav name: Payments parent: Autoramp - description: The transactions autoramps execute kind: nav name: Transactions parent: Autoramp - description: Operations on Currencies kind: nav name: Currencies - description: Operations on Exchange Rate kind: nav name: ExchangeRate - description: Operations on Fee Profiles kind: nav name: FeeProfiles - description: Operations on Webhooks kind: nav name: Webhooks - description: Operations on Terms and Conditions kind: nav name: TermsAndConditions - description: Operations for Sandbox Testing kind: nav name: Sandbox paths: /autoramp-transactions/ids: get: tags: - Transactions summary: Get autoramp transactions by transaction IDs description: >- 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 operationId: getAutorampTransactionsByIds parameters: - deprecated: false description: Ids of the transactions to get explode: false in: query name: ids required: false schema: default: [] items: format: uuid type: string type: array - $ref: '#/components/parameters/XApiVersion' responses: '200': content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/PagedList_AutorampTransaction' description: Autoramp Transaction List '400': content: application/json; charset=utf-8: schema: type: string description: Bad Request '401': content: application/json; charset=utf-8: schema: type: string description: Unauthorized '500': content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ApiError' description: Internal Error security: - ApiKeyAuth: [] components: parameters: XApiVersion: description: >- Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01, 2026-08-01, 2026-10-01, 2026-10-15. in: header name: X-API-Version required: false schema: type: string x-default: '2026-10-01' schemas: PagedList_AutorampTransaction: description: | PagedList A list of items with cursors used to fetch the next or previous page properties: cursor: description: The cursor used to fetch the next page type: string items: description: The list of items items: $ref: '#/components/schemas/AutorampTransaction' type: array prev_cursor: default: null description: The cursor used to fetch the previous page type: string required: - items title: PagedList_AutorampTransaction type: object ApiError: description: |- Standard error response returned to API clients for server errors. Includes a trace_id that clients can reference when reporting issues. properties: message: description: Human-readable error message type: string trace_id: description: Trace ID that can be used to look up request details in logs type: string required: - message - trace_id title: ApiError type: object AutorampTransaction: description: |- Autoramp Transaction The autoramp transaction response A Payment response properties: autoramp_id: description: The ID of the autoramp this transaction belongs to format: uuid type: string batch_id: description: The batch ID if this transaction was part of a batch payout format: uuid type: string created_at: description: Date of transaction creation format: date-time type: string customer_fees: $ref: '#/components/schemas/QuoteCustomerFees' customer_id: description: The ID of the customer two whom this transaction belongs format: uuid type: string destination_amount: $ref: '#/components/schemas/Amount' exchange_rate: description: The exchange rate format: decimal type: string fee: description: The total fee charged format: decimal type: string fee_breakdown: allOf: - $ref: '#/components/schemas/Fee' - deprecated: true description: >- The fee breakdown for the transaction that contains the iron fee, additional partner fee, and network fees in source currency. Deprecated: use `customer_fees`/`invoiced_fees` instead. Will be removed in the future. deprecated: true description: >- The fee breakdown for the transaction that contains the iron fee, additional partner fee, and network fees in source currency. Deprecated: use `customer_fees`/`invoiced_fees` instead. Will be removed in the future. fee_profile_id: description: |- The fee profile this transaction was priced against. `None` for transactions created before this field was added. format: uuid type: string fee_settlement: $ref: '#/components/schemas/FeeSettlement' id: description: The ID of the transaction format: uuid type: string inbound_payment_reference: description: reference of this transaction's pay-in transfer type: string invoiced_fees: $ref: '#/components/schemas/QuoteInvoicedFees' is_third_party: description: >- Whether the parent autoramp is configured to accept third-party payments, copied from the autoramp. This is a configuration flag, not a finding about this transaction. Use `third_party_classification` to see whether this specific payment came from the customer. type: boolean kind: $ref: '#/components/schemas/AutorampType' ob_payment_id: description: |- The id of the open-banking payment that initiated this transaction, if any. Use this to look up the ob_payment via the `getAutorampOpenBankingPayment` endpoint family. type: string outstanding_rfi_ids: description: >- Outstanding RFIs referencing this transaction directly or through a question in any round. Includes requests awaiting response or review, newest first; empty when none exist. items: format: uuid type: string type: array payment_tracking: $ref: '#/components/schemas/PaymentTracking' payout_crypto_transaction: $ref: '#/components/schemas/PayoutCryptoTransaction' quote_id: description: >- The ID of the autoramp quote this transaction was matched to. Absent for transactions on market autoramps. format: uuid type: string recipient: $ref: '#/components/schemas/Recipient' source: $ref: '#/components/schemas/RampTransactionSource' source_amount: $ref: '#/components/schemas/Amount' state: allOf: - $ref: '#/components/schemas/AutorampTransactionState' - deprecated: true description: 'The current state of the transaction. DEPRECATED: use ''status''' deprecated: true description: 'The current state of the transaction. DEPRECATED: use ''status''' status: $ref: '#/components/schemas/AutorampTransactionStatus' third_party_classification: $ref: '#/components/schemas/ApiThirdPartyClassification' required: - outstanding_rfi_ids - id - customer_id - autoramp_id - state - status - source_amount - destination_amount - recipient - fee - exchange_rate - created_at - fee_settlement - is_third_party - kind title: AutorampTransaction type: object QuoteCustomerFees: description: What the customer actually pays on this quote/transaction, right now. properties: banking_fee: $ref: '#/components/schemas/RailFeeAmount' network_fee: $ref: '#/components/schemas/Amount' total: $ref: '#/components/schemas/Amount' transaction_fee: $ref: '#/components/schemas/Amount' required: - transaction_fee - banking_fee - network_fee - total title: QuoteCustomerFees type: object Amount: description: | An amount of money example: amount: '100.5' currency: code: USD type: Fiat properties: amount: description: The amount, a decimal number format: decimal type: string currency: $ref: '#/components/schemas/Currency' required: - amount - currency title: Amount type: object Fee: description: | Fee The fee for a given currency pair properties: banking_fee: $ref: '#/components/schemas/Amount' banking_fee_network: $ref: '#/components/schemas/PaymentNetwork' deducted_fee: allOf: - $ref: '#/components/schemas/Amount' - deprecated: true description: >- 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. deprecated: true description: >- 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. iron_fee: $ref: '#/components/schemas/Amount' iron_fee_settlement: $ref: '#/components/schemas/FeeSettlement' network_fee: $ref: '#/components/schemas/Amount' network_fees: deprecated: true description: The network fees in source currency items: $ref: '#/components/schemas/NetworkFee' type: array network_fees_with_settlement: description: The network fees with settlement items: $ref: '#/components/schemas/NetworkFeeWithSettlement' type: array partner_fee: $ref: '#/components/schemas/Amount' partner_fees: description: The partner fees items: $ref: '#/components/schemas/PartnerFee' type: array total_fee: allOf: - $ref: '#/components/schemas/Amount' - deprecated: true description: >- The total fee, including fees not deducted from the customer (invoiced to the partner separately). Deprecated: silently mixes deducted and invoiced amounts — use `customer_fees`/`invoiced_fees` on the quote/transaction/autoramp response instead. Will be removed in the future. deprecated: true description: >- The total fee, including fees not deducted from the customer (invoiced to the partner separately). Deprecated: silently mixes deducted and invoiced amounts — use `customer_fees`/`invoiced_fees` on the quote/transaction/autoramp response instead. Will be removed in the future. transaction_fee: $ref: '#/components/schemas/Amount' required: - total_fee - iron_fee - partner_fee - network_fees - network_fees_with_settlement - partner_fees - transaction_fee - banking_fee - network_fee title: Fee type: object FeeSettlement: description: | Fee Settlement The settlement type for the fee enum: - deductedImmediately - settledLater type: string QuoteInvoicedFees: description: >- What Iron will invoice the partner separately for this quote/transaction. properties: banking_fee: $ref: '#/components/schemas/RailFeeAmount' network_fee: $ref: '#/components/schemas/Amount' platform_fee: $ref: '#/components/schemas/Amount' total: $ref: '#/components/schemas/Amount' required: - platform_fee - banking_fee - network_fee - total title: QuoteInvoicedFees type: object AutorampType: description: |- Autoramp type The type (onramp, offramp, swap) of an autoramp enum: - Onramp - Offramp - Swap - Mint - Redeem type: string PaymentTracking: description: >- Tracking information for this transactions' payout. Only populated for completed transactions properties: ach_payment_reference: type: string ach_trace_number: type: string fps_payment_reference: type: string imad: type: string omad: type: string sepa_payment_reference: type: string swift_payment_reference: type: string uetr: type: string wire_message: type: string title: PaymentTracking type: object PayoutCryptoTransaction: description: | Payout Transaction Details Details about the blockchain transaction used for crypto payouts example: transaction_hash: 5J9qvKhKqYbpjhCkqDnKXSp7QqLDBU5iT4VWshsqRdWKHjKdqZqKqYbpjhCkqDnKXSp properties: transaction_hash: description: The blockchain transaction hash type: string required: - transaction_hash title: PayoutCryptoTransaction type: object Recipient: anyOf: - $ref: '#/components/schemas/Recipient_RecipientBankAccount' - $ref: '#/components/schemas/Recipient_RecipientWallet' - $ref: '#/components/schemas/Recipient_RecipientPix' description: | Recipient The recipient of the payment discriminator: mapping: BankAccount: '#/components/schemas/Recipient_RecipientBankAccount' Pix: '#/components/schemas/Recipient_RecipientPix' Wallet: '#/components/schemas/Recipient_RecipientWallet' propertyName: type type: object RampTransactionSource: anyOf: - $ref: '#/components/schemas/ApiWalletDepositSource' - $ref: '#/components/schemas/ApiBankAccountSource' description: The source of the autoramp transaction type: object AutorampTransactionState: description: | Autoramp Transaction State The state of the autoramp transaction enum: - Pending - PayoutPending - Payout - PayoutCompleted - Completed - Failed - InAmlReview - AmlRejected - AmountRejected - FraudRejected type: string AutorampTransactionStatus: description: | Autoramp Transaction Status The status of the autoramp transaction enum: - FundsReviewInProgress - ConversionInProgress - PayoutInProgress - Completed - Failed - RejectedAml - RejectedFraud - RejectedMinAmount type: string ApiThirdPartyClassification: description: > Third Party Classification Whether the payer who funded a transaction was the customer themselves. Determined when the deposit arrives, by comparing the payer name on the incoming payment against the customer's verified name. - `FirstParty`: the names match. The customer paid from their own account. - `ThirdParty`: the names do not match. Someone other than the customer paid. - `Inconclusive`: a partial match we will not call either way, for example a missing middle name or a joint account. - `Unknown`: no payer name was supplied with the payment, so there was nothing to compare. Always set for EUR and GBP bank deposits. On other rails it is only evaluated when the parent autoramp was created with `source_is_third_party`, and it is never set in sandbox. Treat an absent value as "not evaluated", not as `FirstParty`. enum: - FirstParty - ThirdParty - Inconclusive - Unknown type: string RailFeeAmount: description: >- A banking fee actually assessed on a quote or transaction. `rail` is absent when the trade has no banking leg at all (e.g. crypto-to-crypto). properties: amount: $ref: '#/components/schemas/Amount' rail: $ref: '#/components/schemas/PaymentNetwork' required: - amount title: RailFeeAmount type: object Currency: anyOf: - $ref: '#/components/schemas/Currency_Crypto' - $ref: '#/components/schemas/Currency_Fiat' description: | Currency Can be either crypto or fiat discriminator: mapping: Crypto: '#/components/schemas/Currency_Crypto' Fiat: '#/components/schemas/Currency_Fiat' propertyName: type type: object PaymentNetwork: description: | PaymentNetwork A payment network enum: - Sepa - Swift - Fps - Chats - Ach - Wire - Rtp - Fednow - Pix - Spei - CbuCvu - AfricanBankTransfer - MobileMoney - Chaps type: string NetworkFee: anyOf: - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' description: > Network Fee The network fee for a given currency. This is deprecated and will be removed in the future. Use NetworkFeeWithSettlement instead. discriminator: mapping: AchIn: '#/components/schemas/NetworkFee_Amount' AchOut: '#/components/schemas/NetworkFee_Amount' CitreaGas: '#/components/schemas/NetworkFee_Amount' EthereumGas: '#/components/schemas/NetworkFee_Amount' RailFee: '#/components/schemas/NetworkFee_Amount' SepaIn: '#/components/schemas/NetworkFee_Amount' SepaOut: '#/components/schemas/NetworkFee_Amount' SolanaTransactionFee: '#/components/schemas/NetworkFee_Amount' StellarTransactionFee: '#/components/schemas/NetworkFee_Amount' SwiftIn: '#/components/schemas/NetworkFee_Amount' SwiftOut: '#/components/schemas/NetworkFee_Amount' WireIn: '#/components/schemas/NetworkFee_Amount' WireOut: '#/components/schemas/NetworkFee_Amount' propertyName: type type: object NetworkFeeWithSettlement: description: | Network Fee with Settlement The network fee with settlement for a given currency properties: fee_amount: $ref: '#/components/schemas/Amount' fee_type: $ref: '#/components/schemas/NetworkFeeType' settlement: $ref: '#/components/schemas/FeeSettlement' required: - fee_type - fee_amount title: NetworkFeeWithSettlement type: object PartnerFee: description: | Partner Fee A partner fee properties: fee: $ref: '#/components/schemas/Amount' label: description: The label of the partner fee type: string settlement: $ref: '#/components/schemas/FeeSettlement' required: - label - fee - settlement title: PartnerFee type: object Recipient_RecipientBankAccount: allOf: - properties: type: enum: - BankAccount example: BankAccount type: string required: - type type: object - $ref: '#/components/schemas/RecipientBankAccount' description: | Recipient The recipient of the payment Recipient_RecipientWallet: allOf: - properties: type: enum: - Wallet example: Wallet type: string required: - type type: object - $ref: '#/components/schemas/RecipientWallet' description: | Recipient The recipient of the payment Recipient_RecipientPix: allOf: - properties: type: enum: - Pix example: Pix type: string required: - type type: object - $ref: '#/components/schemas/RecipientPix' description: | Recipient The recipient of the payment ApiWalletDepositSource: description: A wallet deposit source of an autoramp transaction example: blockchain: Solana deposit_tx_hash: >- 45E89p7aRyUzsqbqstCkKqxaaeYXgagbq8ccHCZWMRN1E8KAqoEPACDasVjkMMbDJGwrwFHz5RDT67kUN3p5Rk81 wallet_address: 7QqLDBU5iT4VWshsqRdWKHjKdqZqKqYbpjhCkqDnKXSp properties: blockchain: description: The blockchain type: string deposit_tx_hash: description: The deposit transaction hash type: string wallet_address: description: The wallet address type: string required: - wallet_address - blockchain title: ApiWalletDepositSource type: object ApiBankAccountSource: description: A bank account source of an autoramp transaction example: account_number: null bank_name: Iron Bank bic: COBADEFFXXX iban: DE89370400440532013000 name: Alan Turing routing_number: null sort_code: null properties: account_number: description: The account number for US accounts type: string bank_name: description: The bank name type: string bic: description: The bic type: string iban: description: The iban type: string name: description: The name of the account holder type: string routing_number: description: The routing number of the bank, for US accounts type: string sort_code: description: The sort code of the bank, for UK accounts type: string required: - bank_name - iban - bic - name title: ApiBankAccountSource type: object Currency_Crypto: allOf: - properties: type: enum: - Crypto example: Crypto type: string required: - type type: object - $ref: '#/components/schemas/Crypto' description: | Currency Can be either crypto or fiat Currency_Fiat: allOf: - properties: type: enum: - Fiat example: Fiat type: string required: - type type: object - $ref: '#/components/schemas/Fiat' description: | Currency Can be either crypto or fiat NetworkFee_Amount: allOf: - properties: type: enum: - SwiftOut example: SwiftOut type: string required: - type type: object - $ref: '#/components/schemas/Amount' description: > Network Fee The network fee for a given currency. This is deprecated and will be removed in the future. Use NetworkFeeWithSettlement instead. NetworkFeeType: description: | Network Fee Type The type of network fee enum: - SepaIn - SepaOut - EthereumGas - CitreaGas - SolanaTransactionFee - StellarTransactionFee - PolygonGas - BaseGas - AvalancheGas - TronGas - BscGas - SeismicExecutionFee - RailFee - AchIn - AchOut - WireIn - WireOut - SwiftIn - SwiftOut - FpsIn - FpsOut - ChapsIn - ChapsOut - RtpIn - RtpOut - FednowIn - FednowOut type: string RecipientBankAccount: description: | RecipientBankAccount A recipient fiat bank account example: 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 properties: account_identifier: $ref: '#/components/schemas/BankAccountIdentifier' address: $ref: '#/components/schemas/RecipientPostalAddress' bank_address: $ref: '#/components/schemas/BankPostalAddress' email_address: $ref: '#/components/schemas/EmailAddress' is_third_party: description: Is this a users fiat bank account or a third party fiat bank account type: boolean local_routing: $ref: '#/components/schemas/LocalBankRouting' phone_number: description: The recipient's phone number. type: string provider_country: $ref: '#/components/schemas/Country' provider_name: description: The name of the provider of the recipient's account type: string recipient: $ref: '#/components/schemas/RecipientName' required: - recipient - provider_name - provider_country - account_identifier - address - is_third_party title: RecipientBankAccount type: object RecipientWallet: description: | RecipientWallet An on-chain wallet address properties: address: description: The wallet address type: string blockchain: $ref: '#/components/schemas/Blockchain' required: - blockchain - address title: RecipientWallet type: object RecipientPix: description: |- RecipientPix A PIX payout recipient. example: account: key: '+5511987654321' type: PHONE recipient: family_name: Turing given_name: Alan type: Individual properties: account: $ref: '#/components/schemas/PixAccountIdentifier' recipient: $ref: '#/components/schemas/RecipientName' required: - recipient - account title: RecipientPix type: object Crypto: description: A cryptocurrency example: blockchain: Solana token: USDC properties: blockchain: $ref: '#/components/schemas/Blockchain' token: description: The ticker of the token e.g. 'USDC' type: string required: - token - blockchain title: Crypto type: object Fiat: description: A fiat currency example: code: USD properties: code: description: The code of the currency e.g. 'USD' type: string required: - code title: Fiat type: object BankAccountIdentifier: anyOf: - $ref: '#/components/schemas/BankAccountIdentifier_Iban' - $ref: '#/components/schemas/BankAccountIdentifier_BankAccountACHIdentifier' - $ref: '#/components/schemas/BankAccountIdentifier_BankAccountWireIdentifier' - $ref: '#/components/schemas/BankAccountIdentifier_BankAccountRTPIdentifier' - $ref: >- #/components/schemas/BankAccountIdentifier_BankAccountFedNowIdentifier - $ref: >- #/components/schemas/BankAccountIdentifier_BankAccountSWIFTIdentifier - $ref: >- #/components/schemas/BankAccountIdentifier_BankAccountCHAPSIdentifier - $ref: '#/components/schemas/BankAccountIdentifier_BankAccountFPSIdentifier' - $ref: '#/components/schemas/BankAccountIdentifier_BankAccountCBUIdentifier' - $ref: '#/components/schemas/BankAccountIdentifier_BankAccountCVUIdentifier' discriminator: mapping: ACH: '#/components/schemas/BankAccountIdentifier_BankAccountACHIdentifier' CBU: '#/components/schemas/BankAccountIdentifier_BankAccountCBUIdentifier' CHAPS: >- #/components/schemas/BankAccountIdentifier_BankAccountCHAPSIdentifier CVU: '#/components/schemas/BankAccountIdentifier_BankAccountCVUIdentifier' FEDNOW: >- #/components/schemas/BankAccountIdentifier_BankAccountFedNowIdentifier FPS: '#/components/schemas/BankAccountIdentifier_BankAccountFPSIdentifier' RTP: '#/components/schemas/BankAccountIdentifier_BankAccountRTPIdentifier' SEPA: '#/components/schemas/BankAccountIdentifier_Iban' SWIFT: >- #/components/schemas/BankAccountIdentifier_BankAccountSWIFTIdentifier Wire: '#/components/schemas/BankAccountIdentifier_BankAccountWireIdentifier' propertyName: type type: object RecipientPostalAddress: description: |- RecipientPostalAddress The account holder's address. properties: city: description: The city maxLength: 100 minLength: 2 type: string country: $ref: '#/components/schemas/Country' postal_code: description: The postal code maxLength: 20 minLength: 3 type: string state: description: The state type: string street: description: The street address maxLength: 256 minLength: 2 type: string required: - street - city - state - country - postal_code title: RecipientPostalAddress type: object BankPostalAddress: description: |- BankPostalAddress The bank's address. Only required for SWIFT accounts. properties: city: description: The city maxLength: 100 minLength: 2 type: string country: $ref: '#/components/schemas/Country' postal_code: description: The postal code maxLength: 20 minLength: 3 type: string state: description: The state type: string street: description: The street address maxLength: 256 minLength: 2 type: string required: - street - city - state - country - postal_code title: BankPostalAddress type: object EmailAddress: description: | EmailAddress An email address An email address example: email: john.doe@example.com properties: email: description: The email address type: string required: - email title: EmailAddress type: object LocalBankRouting: anyOf: - $ref: '#/components/schemas/LocalBankRouting_CaRouting' discriminator: mapping: CA_ROUTING: '#/components/schemas/LocalBankRouting_CaRouting' propertyName: type type: object Country: description: A country example: code: DE properties: code: description: The ISO_3166-1 Alpha-2 country code, e.g. "DE" maxLength: 2 minLength: 2 type: string required: - code title: Country type: object RecipientName: anyOf: - $ref: '#/components/schemas/RecipientName_IndividualName' - $ref: '#/components/schemas/RecipientName_BusinessName' discriminator: mapping: Business: '#/components/schemas/RecipientName_BusinessName' Individual: '#/components/schemas/RecipientName_IndividualName' propertyName: type type: object Blockchain: description: | Blockchain A type of blockchain enum: - Solana - Ethereum - Polygon - Arbitrum - Base - Stellar - Citrea - Plasma - Avalanche - Moca - Monad - Tempo - Tron - Bsc - Seismic - Arc - Optimism - ZeroG type: string PixAccountIdentifier: anyOf: - $ref: '#/components/schemas/PixAccountIdentifier_PixCpfKey' - $ref: '#/components/schemas/PixAccountIdentifier_PixCnpjKey' - $ref: '#/components/schemas/PixAccountIdentifier_PixEmailKey' - $ref: '#/components/schemas/PixAccountIdentifier_PixPhoneKey' - $ref: '#/components/schemas/PixAccountIdentifier_PixEvpKey' - $ref: '#/components/schemas/PixAccountIdentifier_PixBankDetails' description: |- PixAccountIdentifier How the recipient's PIX account is identified: a DICT key of one of the five key types, or full bank account details. discriminator: mapping: BANK_DETAILS: '#/components/schemas/PixAccountIdentifier_PixBankDetails' CNPJ: '#/components/schemas/PixAccountIdentifier_PixCnpjKey' CPF: '#/components/schemas/PixAccountIdentifier_PixCpfKey' EMAIL: '#/components/schemas/PixAccountIdentifier_PixEmailKey' EVP: '#/components/schemas/PixAccountIdentifier_PixEvpKey' PHONE: '#/components/schemas/PixAccountIdentifier_PixPhoneKey' propertyName: type type: object BankAccountIdentifier_Iban: allOf: - properties: type: enum: - SEPA example: SEPA type: string required: - type type: object - $ref: '#/components/schemas/Iban' BankAccountIdentifier_BankAccountACHIdentifier: allOf: - properties: type: enum: - ACH example: ACH type: string required: - type type: object - $ref: '#/components/schemas/BankAccountACHIdentifier' BankAccountIdentifier_BankAccountWireIdentifier: allOf: - properties: type: enum: - Wire example: Wire type: string required: - type type: object - $ref: '#/components/schemas/BankAccountWireIdentifier' BankAccountIdentifier_BankAccountRTPIdentifier: allOf: - properties: type: enum: - RTP example: RTP type: string required: - type type: object - $ref: '#/components/schemas/BankAccountRTPIdentifier' BankAccountIdentifier_BankAccountFedNowIdentifier: allOf: - properties: type: enum: - FEDNOW example: FEDNOW type: string required: - type type: object - $ref: '#/components/schemas/BankAccountFedNowIdentifier' BankAccountIdentifier_BankAccountSWIFTIdentifier: allOf: - properties: type: enum: - SWIFT example: SWIFT type: string required: - type type: object - $ref: '#/components/schemas/BankAccountSWIFTIdentifier' BankAccountIdentifier_BankAccountCHAPSIdentifier: allOf: - properties: type: enum: - CHAPS example: CHAPS type: string required: - type type: object - $ref: '#/components/schemas/BankAccountCHAPSIdentifier' BankAccountIdentifier_BankAccountFPSIdentifier: allOf: - properties: type: enum: - FPS example: FPS type: string required: - type type: object - $ref: '#/components/schemas/BankAccountFPSIdentifier' BankAccountIdentifier_BankAccountCBUIdentifier: allOf: - properties: type: enum: - CBU example: CBU type: string required: - type type: object - $ref: '#/components/schemas/BankAccountCBUIdentifier' BankAccountIdentifier_BankAccountCVUIdentifier: allOf: - properties: type: enum: - CVU example: CVU type: string required: - type type: object - $ref: '#/components/schemas/BankAccountCVUIdentifier' LocalBankRouting_CaRouting: allOf: - properties: type: enum: - CA_ROUTING example: CA_ROUTING type: string required: - type type: object - $ref: '#/components/schemas/CaRouting' RecipientName_IndividualName: allOf: - properties: type: enum: - Individual example: Individual type: string required: - type type: object - $ref: '#/components/schemas/IndividualName' RecipientName_BusinessName: allOf: - properties: type: enum: - Business example: Business type: string required: - type type: object - $ref: '#/components/schemas/BusinessName' PixAccountIdentifier_PixCpfKey: allOf: - properties: type: enum: - CPF example: CPF type: string required: - type type: object - $ref: '#/components/schemas/PixCpfKey' description: |- 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_PixCnpjKey: allOf: - properties: type: enum: - CNPJ example: CNPJ type: string required: - type type: object - $ref: '#/components/schemas/PixCnpjKey' description: |- 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_PixEmailKey: allOf: - properties: type: enum: - EMAIL example: EMAIL type: string required: - type type: object - $ref: '#/components/schemas/PixEmailKey' description: |- 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_PixPhoneKey: allOf: - properties: type: enum: - PHONE example: PHONE type: string required: - type type: object - $ref: '#/components/schemas/PixPhoneKey' description: |- 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: allOf: - properties: type: enum: - EVP example: EVP type: string required: - type type: object - $ref: '#/components/schemas/PixEvpKey' description: |- 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_PixBankDetails: allOf: - properties: type: enum: - BANK_DETAILS example: BANK_DETAILS type: string required: - type type: object - $ref: '#/components/schemas/PixBankDetails' description: |- PixAccountIdentifier How the recipient's PIX account is identified: a DICT key of one of the five key types, or full bank account details. Iban: example: iban: DE89370400440532013000 properties: iban: type: string required: - iban title: Iban type: object BankAccountACHIdentifier: example: account_number: '123456789' routing_number: '021000021' properties: account_number: description: US account number (4-17 alphanumeric characters) pattern: ^[0-9A-Z]{4,17}$ type: string routing_number: description: US routing number (exactly 9 digits) pattern: ^[0-9]{9}$ type: string required: - routing_number - account_number title: BankAccountACHIdentifier type: object BankAccountWireIdentifier: example: account_number: '987654321' routing_number: '021000021' properties: account_number: description: US account number (4-17 alphanumeric characters) pattern: ^[0-9A-Z]{4,17}$ type: string routing_number: description: US routing number (exactly 9 digits) pattern: ^[0-9]{9}$ type: string required: - routing_number - account_number title: BankAccountWireIdentifier type: object BankAccountRTPIdentifier: example: account_number: '456789123' routing_number: '021000021' properties: account_number: description: US account number (4-17 alphanumeric characters) pattern: ^[0-9A-Z]{4,17}$ type: string routing_number: description: US routing number (exactly 9 digits) pattern: ^[0-9]{9}$ type: string required: - routing_number - account_number title: BankAccountRTPIdentifier type: object BankAccountFedNowIdentifier: example: account_number: '456789123' routing_number: '021000021' properties: account_number: description: US account number (4-17 alphanumeric characters) pattern: ^[0-9A-Z]{4,17}$ type: string routing_number: description: US routing number (exactly 9 digits) pattern: ^[0-9]{9}$ type: string required: - routing_number - account_number title: BankAccountFedNowIdentifier type: object BankAccountSWIFTIdentifier: example: account_number: '1234567890' bic: CHASUS33XXX properties: account_number: maxLength: 34 minLength: 1 pattern: ^[a-zA-Z0-9 ]*[a-zA-Z0-9]+$ type: string bic: pattern: ^[A-Z0-9]+$ type: string intermediary_bic: description: >- BIC of an intermediary correspondent bank in the SWIFT routing chain, when the sender wants to override the auto-selected intermediary. Optional — most senders leave this unset and let their provider pick. type: string required: - bic - account_number title: BankAccountSWIFTIdentifier type: object BankAccountCHAPSIdentifier: example: account_number: '12345678' sort_code: 20-00-00 properties: account_number: type: string sort_code: type: string required: - sort_code - account_number title: BankAccountCHAPSIdentifier type: object BankAccountFPSIdentifier: example: account_number: '55779911' sort_code: 20-00-00 properties: account_number: type: string sort_code: type: string required: - sort_code - account_number title: BankAccountFPSIdentifier type: object BankAccountCBUIdentifier: example: account_number: '0170099220000067797370' properties: account_number: description: >- CBU (exactly 22 digits, with valid check digits). Bank aliases are not accepted. pattern: ^[0-9]{22}$ type: string required: - account_number title: BankAccountCBUIdentifier type: object BankAccountCVUIdentifier: example: account_number: '0000003100012345678901' properties: account_number: description: CVU (exactly 22 digits). Bank aliases are not accepted. pattern: ^[0-9]{22}$ type: string required: - account_number title: BankAccountCVUIdentifier type: object CaRouting: properties: institution_number: description: 3-digit financial institution number. pattern: ^[0-9]{3}$ type: string transit_number: description: 5-digit branch transit number. pattern: ^[0-9]{5}$ type: string required: - institution_number - transit_number title: CaRouting type: object IndividualName: example: family_name: Turing given_name: Alan properties: family_name: maxLength: 50 minLength: 1 type: string given_name: maxLength: 50 minLength: 1 type: string required: - given_name - family_name title: IndividualName type: object BusinessName: example: name: Aperture Science properties: name: maxLength: 50 minLength: 1 type: string required: - name title: BusinessName type: object PixCpfKey: description: |- PixCpfKey A PIX DICT key that is the recipient's CPF. example: key: '12345678909' properties: key: description: 11-digit CPF, with or without the `XXX.XXX.XXX-XX` formatting pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ type: string required: - key title: PixCpfKey type: object PixCnpjKey: description: |- PixCnpjKey A PIX DICT key that is the recipient's CNPJ. example: key: '12345678000195' properties: key: description: 14-digit CNPJ, with or without the `XX.XXX.XXX/XXXX-XX` formatting pattern: ^([0-9]{14}|[0-9]{2}\.[0-9]{3}\.[0-9]{3}/[0-9]{4}-[0-9]{2})$ type: string required: - key title: PixCnpjKey type: object PixEmailKey: description: |- PixEmailKey A PIX DICT key that is the recipient's email address. example: key: joao.silva@example.com properties: key: maxLength: 77 pattern: ^[^@\s]+@[^@\s]+$ type: string required: - key title: PixEmailKey type: object PixPhoneKey: description: |- PixPhoneKey A PIX DICT key that is the recipient's phone number. example: key: '+5511987654321' properties: key: description: International format with leading `+`, e.g. +5511987654321 pattern: ^\+[1-9][0-9]{1,14}$ type: string required: - key title: PixPhoneKey type: object PixEvpKey: description: |- PixEvpKey A random PIX DICT key (EVP) generated by the recipient's bank. example: key: 123e4567-e89b-12d3-a456-426614174000 properties: key: description: A lowercase UUID, e.g. 123e4567-e89b-12d3-a456-426614174000 pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ type: string required: - key title: PixEvpKey type: object PixBankDetails: description: |- PixBankDetails Full Brazilian bank account details identifying the recipient's account, for recipients without a registered PIX key. example: account_number: '5678901' account_type: CHECKING bank_code: '341' branch_code: '1234' tax_id: '12345678909' properties: account_number: description: |- Account number including the verification (check) digit, with no separator, e.g. `7140025418`. maxLength: 20 minLength: 1 type: string account_type: $ref: '#/components/schemas/PixAccountType' bank_code: description: 3-digit COMPE bank code or 8-digit ISPB, distinguished by length pattern: ^([0-9]{3}|[0-9]{8})$ type: string branch_code: description: Branch number without the verification digit pattern: ^[0-9]{1,4}$ type: string tax_id: description: |- The account holder's CPF (11 digits) or CNPJ (14 digits), with or without the usual `.`/`-`/`/` formatting. pattern: >- ^([0-9]{11}|[0-9]{14}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2}|[0-9]{2}\.[0-9]{3}\.[0-9]{3}/[0-9]{4}-[0-9]{2})$ type: string required: - tax_id - bank_code - branch_code - account_number - account_type title: PixBankDetails type: object PixAccountType: description: |- PixAccountType The type of a Brazilian bank account. enum: - CHECKING - SAVINGS - SALARY - TRANSACTION type: string securitySchemes: ApiKeyAuth: description: API Key in: header name: X-API-Key type: apiKey ````