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}.

• wallet_id string Required

  The Wallet ID given by Fipto.

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

Query parameters

• valuation_asset string

  Specifies the asset used to value the resources retrieved by the endpoint.

  Values are EUR or USD. Default value is EUR.

Responses

• 200

  Retrieve a wallet

  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 object

    Fields required on all objects.

    Hide data attributes Show data attributes object

    • type string Required

      Default value is wallet.

    • attributes object Required
      Hide attributes attributes Show attributes attributes object

      • name string Required

        The name given to the wallet.

      • asset string Required

        The symbol/ticker of the crypto asset.

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

      • subtype string

        Subtype of a wallet

        Values are primary or fee.

      • balances object Required
        Hide balances attributes Show balances attributes object

        • available string Required

          The current available balance of assets for the wallet.

        • forecasted string Required

          The forecasted balance of assets for the wallet.

      • value string | null Required

        Amount expressed in a currency.

        Format should match the following pattern: ^-?\d*(\.\d+)?$.

      • valuation_asset string

        Specifies the asset used to value the wallet balance.

    • id string Required

      Unique identifier generated by Fipto product on base62 format.

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