Fordefi Transactions API

These endpoints allow you to manage transactions on the Fordefi platform. A transaction represents an operation that can be one of the following: An on-chain action that modifies blockchain state An off-chain cryptographically signed message or data Consult the developer guide for more information on creating, monitoring, and simulating tranasctions.

OpenAPI Specification

fordefi-transactions-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Fordefi Address Book Transactions API
  version: 0.2.0
  description: These endpoints allow you to list the contacts in your address book.<br><br>To add/remove contacts, visit the Fordefi web console. See the <a href='https://docs.fordefi.com/user-guide/address-book'>user guide</a> for more info.
servers:
- url: https://api.fordefi.com/
  description: Production
security:
- bearerAuth: []
tags:
- name: Transactions
  description: "These endpoints allow you to manage transactions on the Fordefi platform.\n        <br><br>\n        A transaction represents an operation that can be one of the following:\n        <ul>\n        <li>An on-chain action that modifies blockchain state</li>\n        <li>An off-chain cryptographically signed message or data</li>\n        </ul>\n        Consult the developer guide for more information on\n        <a href='https://docs.fordefi.com/developers/getting-started/create-and-authenticate-transactions'>creating</a>,\n        <a href='https://docs.fordefi.com/developers/monitor-transactions'>monitoring</a>,\n        and <a href='https://docs.fordefi.com/developers/simulate-transactions'>simulating</a> tranasctions."
paths:
  /api/v1/transactions/export:
    get:
      tags:
      - Transactions
      summary: Export Transactions
      description: Start the export process for filtered transactions using cursor pagination.
      operationId: export_transactions_api_v1_transactions_export_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          description: The amount of transactions to export, unlimited if not set.
          title: Limit
          type: integer
        description: The amount of transactions to export, unlimited if not set.
      - name: created_before
        in: query
        required: false
        schema:
          title: Created Before
          type: string
          format: date-time
      - name: created_after
        in: query
        required: false
        schema:
          title: Created After
          type: string
          format: date-time
      - name: modified_after
        in: query
        required: false
        schema:
          title: Modified After
          type: string
          format: date-time
      - name: vault_ids
        in: query
        required: false
        schema:
          description: 'The filter applies both to transactions that have been signed by the vault and also to transactions that have interacted with the vault. '
          title: Vault Ids
          type: array
          items:
            type: string
            format: uuid
        description: 'The filter applies both to transactions that have been signed by the vault and also to transactions that have interacted with the vault. '
      - name: chains
        in: query
        required: false
        schema:
          title: Chains
          type: array
          items:
            type: string
            minLength: 1
            description: The unique chain ID. </br>Can be either one of those supported by the default chains below or a custom numeric EVM chain ID `evm_<chain_id>` if one was added to your organization. <ul><li>`"aptos_mainnet"`</li><li>`"aptos_testnet"`</li><li>`"aptos_movement_mainnet"`</li><li>`"aptos_movement_testnet"`</li><li>`"arch_mainnet"`</li><li>`"arch_testnet"`</li><li>`"canton_mainnet"`</li><li>`"cosmos_agoric-3"`</li><li>`"cosmos_akashnet-2"`</li><li>`"cosmos_archway-1"`</li><li>`"cosmos_axelar-dojo-1"`</li><li>`"cosmos_bbn-1"`</li><li>`"cosmos_celestia"`</li><li>`"cosmos_cosmoshub-4"`</li><li>`"cosmos_dydx-mainnet-1"`</li><li>`"cosmos_dydx-testnet-4"`</li><li>`"cosmos_dymension_1100-1"`</li><li>`"cosmos_injective-1"`</li><li>`"cosmos_neutron-1"`</li><li>`"cosmos_nillion-1"`</li><li>`"cosmos_noble-1"`</li><li>`"cosmos_osmosis-1"`</li><li>`"cosmos_provider"`</li><li>`"cosmos_ssc-1"`</li><li>`"cosmos_pacific-1"`</li><li>`"cosmos_stride-1"`</li><li>`"cosmos_thorchain-1"`</li><li>`"cosmos_mantra-1"`</li><li>`"exchange_binance"`</li><li>`"exchange_bybit"`</li><li>`"exchange_coinbase_international"`</li><li>`"exchange_coinbase_us"`</li><li>`"exchange_okx"`</li><li>`"exchange_kraken"`</li><li>`"ripple_mainnet"`</li><li>`"solana_mainnet"`</li><li>`"solana_devnet"`</li><li>`"solana_eclipse_mainnet"`</li><li>`"solana_fogo_mainnet"`</li><li>`"solana_fogo_testnet"`</li><li>`"stacks_mainnet"`</li><li>`"starknet_mainnet"`</li><li>`"stellar_mainnet"`</li><li>`"sui_mainnet"`</li><li>`"sui_testnet"`</li><li>`"ton_mainnet"`</li><li>`"tron_mainnet"`</li><li>`"tron_shasta"`</li><li>`"bitcoin_mainnet"`</li><li>`"bitcoin_testnet"`</li><li>`"bitcoin_testnet_v4"`</li><li>`"dogecoin_mainnet"`</li><li>`"bitcoin_cash_mainnet"`</li><li>`"pearl_testnet"`</li><li>`"pearl_mainnet"`</li><li>`"evm_1"`</li><li>`"evm_5"`</li><li>`"evm_10"`</li><li>`"evm_14"`</li><li>`"evm_16"`</li><li>`"evm_30"`</li><li>`"evm_56"`</li><li>`"evm_100"`</li><li>`"evm_130"`</li><li>`"evm_137"`</li><li>`"evm_143"`</li><li>`"evm_146"`</li><li>`"evm_169"`</li><li>`"evm_196"`</li><li>`"evm_250"`</li><li>`"evm_324"`</li><li>`"evm_999"`</li><li>`"evm_1030"`</li><li>`"evm_1100"`</li><li>`"evm_1101"`</li><li>`"evm_1329"`</li><li>`"evm_1337"`</li><li>`"evm_1666"`</li><li>`"evm_1672"`</li><li>`"evm_1729"`</li><li>`"evm_2222"`</li><li>`"evm_4200"`</li><li>`"evm_4217"`</li><li>`"evm_4663"`</li><li>`"evm_5000"`</li><li>`"evm_7000"`</li><li>`"evm_7700"`</li><li>`"evm_8453"`</li><li>`"evm_8818"`</li><li>`"evm_8819"`</li><li>`"evm_9745"`</li><li>`"evm_16661"`</li><li>`"evm_17000"`</li><li>`"evm_80001"`</li><li>`"evm_80094"`</li><li>`"evm_42161"`</li><li>`"evm_43113"`</li><li>`"evm_43114"`</li><li>`"evm_57073"`</li><li>`"evm_59144"`</li><li>`"evm_81457"`</li><li>`"evm_421614"`</li><li>`"evm_534352"`</li><li>`"evm_660279"`</li><li>`"evm_747474"`</li><li>`"evm_810180"`</li><li>`"evm_11155111"`</li><li>`"evm_ethereum_mainnet"`</li><li>`"evm_ethereum_goerli"`</li><li>`"evm_optimism_mainnet"`</li><li>`"evm_flare_mainnet"`</li><li>`"evm_flare_testnet"`</li><li>`"evm_rootstock_mainnet"`</li><li>`"evm_bsc_mainnet"`</li><li>`"evm_gnosis_mainnet"`</li><li>`"evm_unichain_mainnet"`</li><li>`"evm_polygon_mainnet"`</li><li>`"evm_monad_mainnet"`</li><li>`"evm_sonic_mainnet"`</li><li>`"evm_manta_pacific_mainnet"`</li><li>`"evm_x_layer_mainnet"`</li><li>`"evm_fantom_mainnet"`</li><li>`"evm_zksync_era_mainnet"`</li><li>`"evm_hyperevm_mainnet"`</li><li>`"evm_conflux_mainnet"`</li><li>`"evm_dymension_mainnet"`</li><li>`"evm_polygon_zkevm_mainnet"`</li><li>`"evm_sei_mainnet"`</li><li>`"evm_hypercore_mainnet"`</li><li>`"evm_aster_mainnet"`</li><li>`"evm_pharos_mainnet"`</li><li>`"evm_reya_mainnet"`</li><li>`"evm_kava_mainnet"`</li><li>`"evm_merlin_mainnet"`</li><li>`"evm_tempo_mainnet"`</li><li>`"evm_robinhood_mainnet"`</li><li>`"evm_mantle_mainnet"`</li><li>`"evm_zeta_mainnet"`</li><li>`"evm_canto_mainnet"`</li><li>`"evm_base_mainnet"`</li><li>`"evm_clink_mainnet"`</li><li>`"evm_clink_testnet"`</li><li>`"evm_plasma_mainnet"`</li><li>`"evm_zero_gravity_mainnet"`</li><li>`"evm_ethereum_holesky"`</li><li>`"evm_polygon_mumbai"`</li><li>`"evm_berachain_mainnet"`</li><li>`"evm_arbitrum_mainnet"`</li><li>`"evm_avalanche_fuji"`</li><li>`"evm_avalanche_chain"`</li><li>`"evm_ink_mainnet"`</li><li>`"evm_linea_mainnet"`</li><li>`"evm_blast_mainnet"`</li><li>`"evm_arbitrum_sepolia"`</li><li>`"evm_scroll_mainnet"`</li><li>`"evm_xai_mainnet"`</li><li>`"evm_katana_mainnet"`</li><li>`"evm_zklink_nova_mainnet"`</li><li>`"evm_ethereum_sepolia"`</li></ul>
            title: ChainUniqueId
      - name: initiator_ids
        in: query
        required: false
        schema:
          title: Initiator Ids
          type: array
          items:
            type: string
            format: uuid
      - name: types
        in: query
        required: false
        schema:
          title: Types
          type: array
          items:
            $ref: '#/components/schemas/TransactionType'
      - name: sub_types
        in: query
        required: false
        schema:
          title: Sub Types
          type: array
          items:
            $ref: '#/components/schemas/TransactionSubType'
      - name: signer_types
        in: query
        required: false
        schema:
          title: Signer Types
          type: array
          items:
            $ref: '#/components/schemas/SignerType'
      - name: user_types
        in: query
        required: false
        schema:
          title: User Types
          type: array
          items:
            $ref: '#/components/schemas/UserType'
      - name: transaction_ids
        in: query
        required: false
        schema:
          title: Transaction Ids
          type: array
          items:
            type: string
            format: uuid
      - name: end_user_ids
        in: query
        required: false
        schema:
          title: End User Ids
          type: array
          items:
            type: string
            format: uuid
      - name: asset_ids
        in: query
        required: false
        schema:
          title: Asset Ids
          type: array
          items:
            type: string
            format: uuid
      - name: direction
        in: query
        required: false
        schema:
          title: Direction
          $ref: '#/components/schemas/TransactionDirection'
      - name: transaction_hashes
        in: query
        required: false
        schema:
          description: Transaction hashes to filter by. Will return transactions with any of the specified hashes. The format of the hash depends on the blockchain type.
          title: Transaction Hashes
          type: array
          items:
            type: string
        description: Transaction hashes to filter by. Will return transactions with any of the specified hashes. The format of the hash depends on the blockchain type.
      - name: search
        in: query
        required: false
        schema:
          description: String to search transactions by ID or hash.
          title: Search
          type: string
        description: String to search transactions by ID or hash.
      - name: frozen
        in: query
        required: false
        schema:
          description: Filter for frozen transactions or transactions that were unfrozen.
          title: Frozen
          type: boolean
        description: Filter for frozen transactions or transactions that were unfrozen.
      - name: claimed
        in: query
        required: false
        schema:
          description: Filter for transactions waiting for the receiver to claim or accept. `true` selects settled transfers (Stellar claimable balances that were claimed, Canton transfers that were accepted). `false` selects ones not yet settled — still pending receiver action, or (Canton) already expired.
          title: Claimed
          type: boolean
        description: Filter for transactions waiting for the receiver to claim or accept. `true` selects settled transfers (Stellar claimable balances that were claimed, Canton transfers that were accepted). `false` selects ones not yet settled — still pending receiver action, or (Canton) already expired.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Export Transactions Api V1 Transactions Export Get
                $ref: '#/components/schemas/Export'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreconditionFailedError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseError'
        '401':
          description: Unauthorized User
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseError'
        '403':
          description: Forbidden User
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseError'
        '408':
          description: Request Timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseError'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
        '204':
          description: No Content
  /api/v1/transactions/index-by-hash:
    post:
      tags:
      - Transactions
      summary: Index Transaction By Hash
      operationId: index_transaction_by_hash_api_v1_transactions_index_by_hash_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndexTransactionByHashRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexTransactionByHashResponse'
        '400':
          description: Invalid Argument
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArgumentError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseError'
        '401':
          description: Unauthorized User
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseError'
        '403':
          description: Forbidden User
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseError'
        '408':
          description: Request Timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseError'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceError'
  /api/v1/transactions/{id}:
    get:
      tags:
      - Transactions
      summary: Get Transaction
      description: Retrieve transaction details.
      operationId: get_transaction_api_v1_transactions__id__get
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: ID of the transaction to retrieve.
          title: Id
        description: ID of the transaction to retrieve.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTransactionResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreconditionFailedError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseError'
        '401':
          description: Unauthorized User
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseError'
        '403':
          description: Forbidden User
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseError'
        '408':
          description: Request Timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseError'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceError'
  /api/v1/transactions:
    get:
      tags:
      - Transactions
      summary: List Transactions
      description: Get a list of all transactions in an organization.
      operationId: list_transactions_api_v1_transactions_get
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page number to fetch.
          default: 1
          title: Page
        description: The page number to fetch.
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 0
          description: The number of items per page.
          default: 50
          title: Size
        description: The number of items per page.
      - name: skip_count
        in: query
        required: false
        schema:
          type: boolean
          description: Whether to skip counting the total number of items.
          default: false
          title: Skip Count
        description: Whether to skip counting the total number of items.
      - name: created_before
        in: query
        required: false
        schema:
          title: Created Before
          type: string
          format: date-time
      - name: created_after
        in: query
        required: false
        schema:
          title: Created After
          type: string
          format: date-time
      - name: modified_after
        in: query
        required: false
        schema:
          title: Modified After
          type: string
          format: date-time
      - name: vault_ids
        in: query
        required: false
        schema:
          description: 'The filter applies both to transactions that have been signed by the vault and also to transactions that have interacted with the vault. '
          title: Vault Ids
          type: array
          items:
            type: string
            format: uuid
        description: 'The filter applies both to transactions that have been signed by the vault and also to transactions that have interacted with the vault. '
      - name: chains
        in: query
        required: false
        schema:
          title: Chains
          type: array
          items:
            type: string
            minLength: 1
            description: The unique chain ID. </br>Can be either one of those supported by the default chains below or a custom numeric EVM chain ID `evm_<chain_id>` if one was added to your organization. <ul><li>`"aptos_mainnet"`</li><li>`"aptos_testnet"`</li><li>`"aptos_movement_mainnet"`</li><li>`"aptos_movement_testnet"`</li><li>`"arch_mainnet"`</li><li>`"arch_testnet"`</li><li>`"canton_mainnet"`</li><li>`"cosmos_agoric-3"`</li><li>`"cosmos_akashnet-2"`</li><li>`"cosmos_archway-1"`</li><li>`"cosmos_axelar-dojo-1"`</li><li>`"cosmos_bbn-1"`</li><li>`"cosmos_celestia"`</li><li>`"cosmos_cosmoshub-4"`</li><li>`"cosmos_dydx-mainnet-1"`</li><li>`"cosmos_dydx-testnet-4"`</li><li>`"cosmos_dymension_1100-1"`</li><li>`"cosmos_injective-1"`</li><li>`"cosmos_neutron-1"`</li><li>`"cosmos_nillion-1"`</li><li>`"cosmos_noble-1"`</li><li>`"cosmos_osmosis-1"`</li><li>`"cosmos_provider"`</li><li>`"cosmos_ssc-1"`</li><li>`"cosmos_pacific-1"`</li><li>`"cosmos_stride-1"`</li><li>`"cosmos_thorchain-1"`</li><li>`"cosmos_mantra-1"`</li><li>`"exchange_binance"`</li><li>`"exchange_bybit"`</li><li>`"exchange_coinbase_international"`</li><li>`"exchange_coinbase_us"`</li><li>`"exchange_okx"`</li><li>`"exchange_kraken"`</li><li>`"ripple_mainnet"`</li><li>`"solana_mainnet"`</li><li>`"solana_devnet"`</li><li>`"solana_eclipse_mainnet"`</li><li>`"solana_fogo_mainnet"`</li><li>`"solana_fogo_testnet"`</li><li>`"stacks_mainnet"`</li><li>`"starknet_mainnet"`</li><li>`"stellar_mainnet"`</li><li>`"sui_mainnet"`</li><li>`"sui_testnet"`</li><li>`"ton_mainnet"`</li><li>`"tron_mainnet"`</li><li>`"tron_shasta"`</li><li>`"bitcoin_mainnet"`</li><li>`"bitcoin_testnet"`</li><li>`"bitcoin_testnet_v4"`</li><li>`"dogecoin_mainnet"`</li><li>`"bitcoin_cash_mainnet"`</li><li>`"pearl_testnet"`</li><li>`"pearl_mainnet"`</li><li>`"evm_1"`</li><li>`"evm_5"`</li><li>`"evm_10"`</li><li>`"evm_14"`</li><li>`"evm_16"`</li><li>`"evm_30"`</li><li>`"evm_56"`</li><li>`"evm_100"`</li><li>`"evm_130"`</li><li>`"evm_137"`</li><li>`"evm_143"`</li><li>`"evm_146"`</li><li>`"evm_169"`</li><li>`"evm_196"`</li><li>`"evm_250"`</li><li>`"evm_324"`</li><li>`"evm_999"`</li><li>`"evm_1030"`</li><li>`"evm_1100"`</li><li>`"evm_1101"`</li><li>`"evm_1329"`</li><li>`"evm_1337"`</li><li>`"evm_1666"`</li><li>`"evm_1672"`</li><li>`"evm_1729"`</li><li>`"evm_2222"`</li><li>`"evm_4200"`</li><li>`"evm_4217"`</li><li>`"evm_4663"`</li><li>`"evm_5000"`</li><li>`"evm_7000"`</li><li>`"evm_7700"`</li><li>`"evm_8453"`</li><li>`"evm_8818"`</li><li>`"evm_8819"`</li><li>`"evm_9745"`</li><li>`"evm_16661"`</li><li>`"evm_17000"`</li><li>`"evm_80001"`</li><li>`"evm_80094"`</li><li>`"evm_42161"`</li><li>`"evm_43113"`</li><li>`"evm_43114"`</li><li>`"evm_57073"`</li><li>`"evm_59144"`</li><li>`"evm_81457"`</li><li>`"evm_421614"`</li><li>`"evm_534352"`</li><li>`"evm_660279"`</li><li>`"evm_747474"`</li><li>`"evm_810180"`</li><li>`"evm_11155111"`</li><li>`"evm_ethereum_mainnet"`</li><li>`"evm_ethereum_goerli"`</li><li>`"evm_optimism_mainnet"`</li><li>`"evm_flare_mainnet"`</li><li>`"evm_flare_testnet"`</li><li>`"evm_rootstock_mainnet"`</li><li>`"evm_bsc_mainnet"`</li><li>`"evm_gnosis_mainnet"`</li><li>`"evm_unichain_mainnet"`</li><li>`"evm_polygon_mainnet"`</li><li>`"evm_monad_mainnet"`</li><li>`"evm_sonic_mainnet"`</li><li>`"evm_manta_pacific_mainnet"`</li><li>`"evm_x_layer_mainnet"`</li><li>`"evm_fantom_mainnet"`</li><li>`"evm_zksync_era_mainnet"`</li><li>`"evm_hyperevm_mainnet"`</li><li>`"evm_conflux_mainnet"`</li><li>`"evm_dymension_mainnet"`</li><li>`"evm_polygon_zkevm_mainnet"`</li><li>`"evm_sei_mainnet"`</li><li>`"evm_hypercore_mainnet"`</li><li>`"evm_aster_mainnet"`</li><li>`"evm_pharos_mainnet"`</li><li>`"evm_reya_mainnet"`</li><li>`"evm_kava_mainnet"`</li><li>`"evm_merlin_mainnet"`</li><li>`"evm_tempo_mainnet"`</li><li>`"evm_robinhood_mainnet"`</li><li>`"evm_mantle_mainnet"`</li><li>`"evm_zeta_mainnet"`</li><li>`"evm_canto_mainnet"`</li><li>`"evm_base_mainnet"`</li><li>`"evm_clink_mainnet"`</li><li>`"evm_clink_testnet"`</li><li>`"evm_plasma_mainnet"`</li><li>`"evm_zero_gravity_mainnet"`</li><li>`"evm_ethereum_holesky"`</li><li>`"evm_polygon_mumbai"`</li><li>`"evm_berachain_mainnet"`</li><li>`"evm_arbitrum_mainnet"`</li><li>`"evm_avalanche_fuji"`</li><li>`"evm_avalanche_chain"`</li><li>`"evm_ink_mainnet"`</li><li>`"evm_linea_mainnet"`</li><li>`"evm_blast_mainnet"`</li><li>`"evm_arbitrum_sepolia"`</li><li>`"evm_scroll_mainnet"`</li><li>`"evm_xai_mainnet"`</li><li>`"evm_katana_mainnet"`</li><li>`"evm_zklink_nova_mainnet"`</li><li>`"evm_ethereum_sepolia"`</li></ul>
            title: ChainUniqueId
      - name: initiator_ids
        in: query
        required: false
        schema:
          title: Initiator Ids
          type: array
          items:
            type: string
            format: uuid
      - name: types
        in: query
        required: false
        schema:
          title: Types
          type: array
          items:
            $ref: '#/components/schemas/TransactionType'
      - name: sub_types
        in: query
        required: false
        schema:
          title: Sub Types
          type: array
          items:
            $ref: '#/components/schemas/TransactionSubType'
      - name: signer_types
        in: query
        required: false
        schema:
          title: Signer Types
          type: array
          items:
            $ref: '#/components/schemas/SignerType'
      - name: user_types
        in: query
        required: false
        schema:
          title: User Types
          type: array
          items:
            $ref: '#/components/schemas/UserType'
      - name: transaction_ids
        in: query
        required: false
        schema:
          title: Transaction Ids
          type: array
          items:
            type: string
            format: uuid
      - name: end_user_ids
        in: query
        required: false
        schema:
          title: End User Ids
          type: array
          items:
            type: string
            format: uuid
      - name: asset_ids
        in: query
        required: false
        schema:
          title: Asset Ids
          type: array
          items:
            type: string
            format: uuid
      - name: direction
        in: query
        required: false
        schema:
          title: Direction
          $ref: '#/components/schemas/TransactionDirection'
      - name: transaction_hashes
        in: query
        required: false
        schema:
          description: Transaction hashes to filter by. Will return transactions with any of the specified hashes. The format of the hash depends on the blockchain type.
          title: Transaction Hashes
          type: array
          items:
            type: string
        description: Transaction hashes to filter by. Will return transactions with any of the specified hashes. The format of the hash depends on the blockchain type.
      - name: search
        in: query
        required: false
        schema:
          description: String to search transactions by ID or hash.
          title: Search
          type: string
        description: String to search transactions by ID or hash.
      - name: frozen
        in: query
        required: false
        schema:
          description: Filter for frozen transactions or transactions that were unfrozen.
          title: Frozen
          type: boolean
        description: Filter for frozen transactions or transactions that were unfrozen.
      - name: claimed
        in: query
        required: false
        schema:
          description: Filter for transactions waiting for the receiver to claim or accept. `true` selects settled transfers (Stellar claimable balances that were claimed, Canton transfers that were accepted). `false` selects ones not yet settled — still pending receiver action, or (Canton) already expired.
          title: Claimed
          type: boolean
        description: Filter for transactions waiting for the receiver to claim or accept. `true` selects settled transfers (Stellar claimable balances that were claimed, Canton transfers that were accepted). `false` selects ones not yet settled — still pending receiver action, or (Canton) already expired.
      - name: states
        in: query
        required: false
        schema:
          description: State of the transaction. Can be one of the following:`aborted` `accelerated` `accelerating` `approved` `canceling` `cancelled` `completed` `completed_reverted` `dropped` `error_processing_by_exchange` `error_pushing_to_blockchain` `error_signing` `error_submitting_to_exchange` `error_submitting_to_provider` `finalized_for_signing` `insufficient_funds` `mined` `mined_reverted` `pending_exchange` `pushed_to_blockchain` `queued` `sent_to_provider` `signed` `stuck` `waiting_for_approval` `waiting_for_signing_trigger`, or an aggregation of states:<ul><li>`error`, which can be one of:</li><ul><li>`completed_reverted`</li><li>`dropped`</li><li>`error_processing_by_exchange`</li><li>`error_pushing_to_blockchain`</li><li>`error_signing`</li><li>`error_submitting_to_exchange`</li><li>`error_submitting_to_provider`</li><li>`insufficient_funds`</li></ul><li>`finalized`, which can be one of:</li><ul><li>`aborted`</li><li>`accelerated`</li><li>`cancelled`</li><li>`completed`</li><li>`completed_reverted`</li><li>`dropped`</li><li>`error_processing_by_exchange`</li><li>`error_pushing_to_blockchain`</li><li>`error_signing`</li><li>`error_submitting_to_exchange`</li><li>`error_submitting_to_provider`</li><li>`insufficient_funds`</li></ul><li>`pending`, which can be one of:</li><ul><li>`accelerating`</li><li>`approved`</li><li>`canceling`</li><li>`finalized_for_signing`</li><li>`finalized_for_signing`</li><li>`mined`</li><li>`mined_reverted`</li><li>`pending_exchange`</li><li>`pushed_to_blockchain`</li><li>`queued`</li><li>`sent_to_provider`</li><li>`signed`</li><li>`stuck`</li><li>`waiting_for_approval`</li><li>`waiting_for_signing_trigger`</li></ul></ul>
          title: States
          type: array
          items:
            anyOf:
            - $ref: '#/components/schemas/AggregatedTransactionState'
            - $ref: '#/components/schemas/PushableTransactionState'
            - $ref: '#/components/schemas/NonPushableTransactionState'
            - $ref: '#/components/schemas/ExchangeTransactionState'
        description: State of the transaction. Can be one of the following:`aborted` `accelerated` `accelerating` `approved` `canceling` `cancelled` `completed` `completed_reverted` `dropped` `error_processing_by_exchange` `error_pushing_to_blockchain` `error_signing` `error_submitting_to_exchange` `error_submitting_to_provider` `finalized_for_signing` `insufficient_funds` `mined` `mined_reverted` `pending_exchange` `pushed_to_blockchain` `queued` `sent_to_provider` `signed` `stuck` `waiting_for_approval` `waiting_for_signing_trigger`, or an aggregation of states:<ul><li>`error`, which can be one of:</li><ul><li>`completed_reverted`</li><li>`dropped`</li><li>`error_processing_by_exchange`</li><li>`error_pushing_to_blockchain`</li><li>`error_signing`</li><li>`error_submitting_to_exchange`</li><li>`error_submitting_to_provider`</li><li>`insufficient_funds`</li></ul><li>`finalized`, which can be one of:</li><ul><li>`aborted`</li><li>`accelerated`</li><li>`cancelled`</li><li>`completed`</li><li>`completed_reverted`</li><li>`dropped`</li><li>`error_processing_by_exchange`</li><li>`error_pushing_to_blockchain`</li><li>`error_signing`</li><li>`error_submitting_to_exchange`</li><li>`error_submitting_to_provider`</li><li>`insufficient_funds`</li></ul><li>`pending`, which can be one of:</li><ul><li>`accelerating`</li><li>`approved`</li><li>`canceling`</li><li>`finalized_for_signing`</li><li>`finalized_for_signing`</li><li>`mined`</li><li>`mined_reverted`</li><li>`pending_exchange`</li><li>`pushed_to_blockchain`</li><li>`queued`</li><li>`sent_to_provider`</li><li>`signed`</li><li>`stuck`</li><li>`waiting_for_approval`</li><li>`waiting_for_signing_trigger`</li></ul></ul>
      - name: is_hidden
        in: query
        required: false
        schema:
          title: Is Hidden
          type: boolean
      - name: include_full_response
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Include Full Response
      - name: batch_ids
        in: query
        required: false
        schema:
          title: Batch Ids
          type: array
          items:
            type: string
            format: uuid
      - name: include_blackbox
        in: query
        required: false
        schema:
          title: Include Blackbox
          type: boolean
      - name: policy_rule_ids
        in: query
        required: false
        schema:
          title: Policy Rule Ids
          type: array
          items:
            type: string
            format: uuid
      - name: sort_by
        in: query
        required: false
        schema:
          title: Sort By
          type: array
          items:
            $ref: '#/components/schemas/TransactionSortableFields'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTransactionResponse'
        '400':
          desc

# --- truncated at 32 KB (1074 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fordefi/refs/heads/main/openapi/fordefi-transactions-api-openapi.yml