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

Rename a wallet details

PATCH /companies/{company_id}/wallets/{wallet_id}/wallet-details/{wallet_details_id}

Update the name of a specific wallet details.

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

  • wallet_details_id string Required

    The Wallet details ID given by Fipto.

application/json

Body

  • data object Required

    Wallet details data that could be updated.

    Hide data attribute Show data attribute
    • attributes object Required
      Hide attributes attribute Show attributes attribute

Responses

  • • 200

    Retrieve an updated wallet details

    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 Required

      Fields required on all objects.

      Hide data attributes Show data attributes
      • 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}.

      • type string Required

        Default value is wallet_details.

      • attributes object Required
        Any of:
        wallet_details_digital object wallet_details_digital_tag object wallet_details_fiat_iban object
PATCH /companies/{company_id}/wallets/{wallet_id}/wallet-details/{wallet_details_id} 
curl \
 -X PATCH https://api.fipto.app/companies/9de0691c-bc8d-409b-8f40-75d4f45db2f3/wallets/3Qv67yjXEwB9SjmvkuG6Cp/wallet-details/fd095ab3-bc8d-409b-8f40-75d4f45db2f3 \
 -H "Content-Type: application/json" \
 -d '{"data":{"attributes":{"name":"My new wallet detail"}}}'
Request example 
{
  "data": {
    "attributes": {
      "name": "My new wallet detail"
    }
  }
}
Response examples (200) 
{
  "meta": {
    "request_id": "string",
    "query_parameters": {}
  },
  "data": {
    "id": "string",
    "type": "wallet_details",
    "attributes": {
      "asset": "BTC",
      "address": "0x71C*",
      "name": "Acme - Payment Project X"
    }
  }
}