Get a beneficiary

GET /companies/{company_id}/beneficiaries/{beneficiary_id}

Retrieve a specific beneficiary by its unique identifier.

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

  • beneficiary_id string Required

    The Beneficiary ID given by Fipto.

Responses

  • 200

    Retrieve a beneficiary

    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
      • 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 beneficiary.

      • attributes object Required
        Hide attributes attributes Show attributes attributes object
        • description string Required

          Description of the beneficiary that you want to add (e.g. "external wallet account").

        • wallet_details object Required

          Any of:
          wallet_details_digital object wallet_details_digital_tag object wallet_details_fiat_iban object

        • beneficiary_info object Required

          One of:
          beneficiary_info_natural object beneficiary_info_legal object beneficiary_is_self object
GET /companies/{company_id}/beneficiaries/{beneficiary_id} 
curl \
 -X GET https://api.fipto.app/companies/9de0691c-bc8d-409b-8f40-75d4f45db2f3/beneficiaries/g6e0622d-bc8d-409b-8f40-75d4f45db2f3
Response examples (200) 
{
  "meta": {
    "request_id": "string",
    "query_parameters": {}
  },
  "data": {
    "id": "string",
    "type": "beneficiary",
    "attributes": {
      "description": "string",
      "wallet_details": {
        "asset": "BTC",
        "address": "0x71C*",
        "name": "Acme - Payment Project X"
      },
      "beneficiary_info": {
        "type": "individual",
        "firstname": "Victor",
        "lastname": "Duponthieu",
        "address": {
          "street_address": "25 rue François 1er",
          "zip_code": "75008",
          "city": "Paris",
          "country_code": "FR"
        }
      }
    }
  }
}
Response examples (200) 
{
  "meta": {
    "request_id": "string",
    "query_parameters": {}
  },
  "data": {
    "id": "string",
    "type": "beneficiary",
    "attributes": {
      "description": "string",
      "wallet_details": {
        "asset": "BTC",
        "address": "0x71C*",
        "name": "Acme - Payment Project X"
      },
      "beneficiary_info": {
        "type": "individual",
        "firstname": "Victor",
        "lastname": "Duponthieu",
        "address": {
          "street_address": "25 rue François 1er",
          "zip_code": "75008",
          "city": "Paris",
          "country_code": "FR"
        }
      }
    }
  }
}