Fipto - OpenAPI 3.0
1.2.2

This is a REST API specifications based on OpenAPI 3.0 for Fipto solution.

This is the documentation for version 1.2.2 of the API. Last update on Aug 30, 2023.

Base URL 
https://api.fipto.app

Create wallet

POST /companies/{company_id}/wallets

Create a new wallet for your company.

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

application/json

Body

  • data object Required

    Fields required on all objects.

    Hide data attributes Show data attributes
    • type string Required

      Default value is wallet.

    • attributes object Required
      Hide attributes attributes Show attributes attributes
      • 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,}.

Responses

  • • 201

    Wallet successfully created

    Hide response attributes Show response attributes object
    • meta object Required
      Hide meta attributes Show meta attributes
      • 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
      • type string Required

        Default value is wallet.

      • attributes object Required
        Hide attributes attributes Show attributes attributes
        • 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
          • available string Required

            The current available balance of assets for the wallet.

          • forecasted string Required

            The forecasted balance of assets for the wallet.

      • id string Required

        Unique identifier generated by Fipto product on base62 format.

        Format should match the following pattern: [0-9a-zA-Z]{22}.
POST /companies/{company_id}/wallets 
curl \
 -X POST https://api.fipto.app/companies/9de0691c-bc8d-409b-8f40-75d4f45db2f3/wallets \
 -H "Content-Type: application/json" \
 -d '{"data":{"type":"wallet","attributes":{"name":"string","asset":"BTC"}}}'
Request example 
{
  "data": {
    "type": "wallet",
    "attributes": {
      "name": "string",
      "asset": "BTC"
    }
  }
}
Response examples (201) 
{
  "meta": {
    "request_id": "string",
    "query_parameters": {}
  },
  "data": {
    "type": "wallet",
    "attributes": {
      "name": "string",
      "asset": "BTC",
      "subtype": "primary",
      "balances": {
        "available": "string",
        "forecasted": "string"
      }
    },
    "id": "string"
  }
}