Path parameters

• company_id string Required

  The Company ID given by Fipto.

  Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

Query parameters

• page_number number

  The page number retrieved in the paginated results. The default value is 1.

• page_size number

  The number of items to include in each page of the paginated results. The default value is 100.

• sort string

  The sort field used to filter data.

  Values are created_at, amount, or status. Default value is created_at.

• transaction_types array[string]

  Filter for specific transaction types.

  Values are payin, payout, or fee.

• wallet_id string

  Filter for a specific wallet_id.

  Format should match the following pattern: [0-9a-zA-Z]{22}.

Responses

• 200

  Retrieve list of transactions

  Hide response attributes Show response attributes object

  • meta object Required
    Hide meta attributes Show meta attributes object

    • request_id string Required

      Unique identifier generated by the server.

      Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

    • query_parameters object

      Information about the parameters in the request. All query string parameters provided (or implicit/with default value) will be returned

  • data array[object]

    One of:

    payin_data array[object] payout_data array[object]

    Fields required on all objects.

    Hide attributes Show attributes

    • type string Required

      Value is payin.

    • attributes object Required
      Hide attributes attributes Show attributes attributes object

      • wallet object

        Wallet information in a transaction

        Hide wallet attributes Show wallet attributes object

        • wallet_id string Required

          Unique identifier generated by Fipto product on base62 format.

          Format should match the following pattern: [0-9a-zA-Z]{22}.

        • wallet_name string Required

          The name of the wallet.

      • amount string

        Strictly positive amount expressed in the currency of the transaction.

        Format should match the following pattern: ^(0*[1-9]\d*(\.\d+)?|0*\.\d*[1-9]\d*)$.

      • valuations array[object]

        Valuation of an asset

        Hide valuations attributes Show valuations attributes array[object]

        • asset string

          The quote asset of the provided valuation.

          Values are EUR or USD.

        • value string

          The estimated value of the asset (based on the quote asset).

      • booked_at string(date-time)

        The specific date on which the transaction has been booked.

      • valued_at string(date-time)

        The specific date on which the transaction has been valued.

      • created_at string(date-time)

        The specific date on which the transaction has been created.

      • source string

        The external wallet address that initiated the payment.

      • wallet_details object

        Minimal info in common about Wallet Details

        Hide wallet_details attributes Show wallet_details attributes object

        • asset string Required

          The symbol/ticker of the crypto asset.

          Format should match the following pattern: ([A-Z_]){3,}.

        • address string Required

          The public address associated with a wallet details on the blockchain.

        • name string

          The wallet details name

        • tag string
      • status string

        Status of the payin.

        Values are in transit, completed, or returned.

      • transaction_id string

        Unique identifier generated by Fipto product on base62 format.

        Format should match the following pattern: [0-9a-zA-Z]{22}.

      • blockchain_data object

        Data from the blockchain

        Hide blockchain_data attributes Show blockchain_data attributes object

        • transaction_hash string Required

          The hash of the transaction.

        • block_explorer_link string Required

          The link to the transaction on the block explorer.

    • id string

      Unique identifier generated by Fipto product on base62 format.

      Format should match the following pattern: [0-9a-zA-Z]{22}.

    Fields required on all objects.

    Hide attributes Show attributes

    • type string Required

      Value is payout.

    • attributes object Required
      Hide attributes attributes Show attributes attributes object

      • wallet object

        Wallet information in a transaction

        Hide wallet attributes Show wallet attributes object

        • wallet_id string Required

          Unique identifier generated by Fipto product on base62 format.

          Format should match the following pattern: [0-9a-zA-Z]{22}.

        • wallet_name string Required

          The name of the wallet.

      • beneficiary object

        Information of beneficiary into a transaction

        Hide beneficiary attributes Show beneficiary attributes object

        • beneficiary_id string Required

          Unique identifier generated by the server.

          Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

        • beneficiary_description string

          The description given to the beneficiary.

      • amount string

        Strictly positive amount expressed in the currency of the transaction.

        Format should match the following pattern: ^(0*[1-9]\d*(\.\d+)?|0*\.\d*[1-9]\d*)$.

      • status string

        Status of the payout.

        Values are pending, rejected, completed, awaiting co-signer, insufficient funds, in process, or submitted.

      • valuations array[object]

        Valuation of an asset

        Hide valuations attributes Show valuations attributes array[object]

        • asset string

          The quote asset of the provided valuation.

          Values are EUR or USD.

        • value string

          The estimated value of the asset (based on the quote asset).

      • transaction_id string

        Unique identifier generated by Fipto product on base62 format.

        Format should match the following pattern: [0-9a-zA-Z]{22}.

      • created_at string(date-time)

        The specific date on which the transaction has been created.

      • asset_code string

        The symbol/ticker of the crypto asset.

        Format should match the following pattern: ([A-Z_]){3,}.

      • created_by string

        The id of the user that initiated the payout.

        Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

      • signature object

        Data of signature

        Hide signature attributes Show signature attributes object

        • quorum integer

          The required number of signatories.

        • mfa array[string]

          Value is totp.

        • signatories array[object]
          Hide signatories attribute Show signatories attribute array[object]

          • user_id string

            Unique identifier generated by the server.

            Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

      • blockchain_data object

        Data from the blockchain

        Hide blockchain_data attributes Show blockchain_data attributes object

        • transaction_hash string Required

          The hash of the transaction.

        • block_explorer_link string Required

          The link to the transaction on the block explorer.

    • id string

      Unique identifier generated by Fipto product on base62 format.

      Format should match the following pattern: [0-9a-zA-Z]{22}.