> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iron.xyz/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 /spec.yaml get /autoramp-transactions/ids
openapi: 3.1.0
info:
  description: The Stablecoin Payment Network
  title: Iron API - Sandbox
  version: 1.0-17078
servers:
  - url: https://api.sandbox.iron.xyz/api
security: []
tags:
  - 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.
    name: Addresses
  - description: Operations on Autoramp
    name: Autoramp
  - description: Operations on Chronicle collateral
    name: ChronicleCollateral
  - description: Operations on Currencies
    name: Currencies
  - description: Operations on Customers
    name: Customer
  - description: Operations on Exchange Rate
    name: ExchangeRate
  - description: Operations on Fee Profiles
    name: FeeProfiles
  - description: Operations for Sandbox Testing
    name: Sandbox
  - description: Operations on SSE
    name: Sse
  - description: Operations on Terms and Conditions
    name: TermsAndConditions
  - description: Operations on Webhooks
    name: Webhooks
paths:
  /autoramp-transactions/ids:
    get:
      tags:
        - Autoramp
      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.
      in: header
      name: X-API-Version
      required: false
      schema:
        type: string
  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
          format: uuid
          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
          format: uuid
          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_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:
          $ref: '#/components/schemas/Fee'
        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
        is_third_party:
          description: Is this a third party payment (3pp) autoramp
          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
        payment_tracking:
          $ref: '#/components/schemas/PaymentTracking'
        payout_crypto_transaction:
          $ref: '#/components/schemas/PayoutCryptoTransaction'
        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:
        - 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
    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:
          $ref: '#/components/schemas/Amount'
        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
    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:
            $ref: '#/components/schemas/Recipient_RecipientBankAccount'
          Pix:
            $ref: '#/components/schemas/Recipient_RecipientPix'
          Wallet:
            $ref: '#/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:
      enum:
        - FirstParty
        - ThirdParty
        - Inconclusive
        - Unknown
      type: string
    Currency:
      anyOf:
        - $ref: '#/components/schemas/Currency_Crypto'
        - $ref: '#/components/schemas/Currency_Fiat'
      description: |
        Currency

        Can be either crypto or fiat
      discriminator:
        mapping:
          Crypto:
            $ref: '#/components/schemas/Currency_Crypto'
          Fiat:
            $ref: '#/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
        - 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:
            $ref: '#/components/schemas/NetworkFee_Amount'
          AchOut:
            $ref: '#/components/schemas/NetworkFee_Amount'
          CitreaGas:
            $ref: '#/components/schemas/NetworkFee_Amount'
          EthereumGas:
            $ref: '#/components/schemas/NetworkFee_Amount'
          RailFee:
            $ref: '#/components/schemas/NetworkFee_Amount'
          SepaIn:
            $ref: '#/components/schemas/NetworkFee_Amount'
          SepaOut:
            $ref: '#/components/schemas/NetworkFee_Amount'
          SolanaTransactionFee:
            $ref: '#/components/schemas/NetworkFee_Amount'
          StellarTransactionFee:
            $ref: '#/components/schemas/NetworkFee_Amount'
          SwiftIn:
            $ref: '#/components/schemas/NetworkFee_Amount'
          SwiftOut:
            $ref: '#/components/schemas/NetworkFee_Amount'
          WireIn:
            $ref: '#/components/schemas/NetworkFee_Amount'
          WireOut:
            $ref: '#/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
        - 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
        phone_number:
          description: The recipient's phone number. Required for USD accounts.
          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
        tax_id: '12345678909'
      properties:
        account:
          $ref: '#/components/schemas/PixAccountIdentifier'
        recipient:
          $ref: '#/components/schemas/RecipientName'
        tax_id:
          description: |-
            The recipient's CPF (11 digits) or CNPJ (14 digits), with or without
            the usual `.`/`-`/`/` formatting. The payout is rejected if the
            destination account is not registered to this tax ID.
          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:
        - recipient
        - tax_id
        - 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'
      discriminator:
        mapping:
          ACH:
            $ref: >-
              #/components/schemas/BankAccountIdentifier_BankAccountACHIdentifier
          CHAPS:
            $ref: >-
              #/components/schemas/BankAccountIdentifier_BankAccountCHAPSIdentifier
          FEDNOW:
            $ref: >-
              #/components/schemas/BankAccountIdentifier_BankAccountFedNowIdentifier
          FPS:
            $ref: >-
              #/components/schemas/BankAccountIdentifier_BankAccountFPSIdentifier
          RTP:
            $ref: >-
              #/components/schemas/BankAccountIdentifier_BankAccountRTPIdentifier
          SEPA:
            $ref: '#/components/schemas/BankAccountIdentifier_Iban'
          SWIFT:
            $ref: >-
              #/components/schemas/BankAccountIdentifier_BankAccountSWIFTIdentifier
          Wire:
            $ref: >-
              #/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
    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:
            $ref: '#/components/schemas/RecipientName_BusinessName'
          Individual:
            $ref: '#/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
        - Tempo
        - Tron
        - Bsc
      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:
            $ref: '#/components/schemas/PixAccountIdentifier_PixBankDetails'
          CNPJ:
            $ref: '#/components/schemas/PixAccountIdentifier_PixCnpjKey'
          CPF:
            $ref: '#/components/schemas/PixAccountIdentifier_PixCpfKey'
          EMAIL:
            $ref: '#/components/schemas/PixAccountIdentifier_PixEmailKey'
          EVP:
            $ref: '#/components/schemas/PixAccountIdentifier_PixEvpKey'
          PHONE:
            $ref: '#/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'
    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:
          type: string
        bic:
          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
    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'
      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
      required:
        - 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

````