Beneficiaries

Get Beneficiaries

GEThttps://secure.tell.systems/algbra/open-banking/v3.1/aisp/accounts/{AccountId}/beneficiaries

Authorization

PSUOAuth2Security

Path parameters

AccountId*string

AccountId

Header parameters

Response

200400401403404405406429500

Beneficiaries Read

Headers

Body

application/json; charset=utf-8

Data*object

Links*Links (object)

Links relevant to the payload

Meta*MetaData

Meta Data relevant to the payload

Request

JavaScriptCurlPython

const response = await fetch('https://secure.tell.systems/algbra/open-banking/v3.1/aisp/accounts/{AccountId}/beneficiaries', {
    method: 'GET',
    headers: {
      "x-fapi-financial-id": "ea01566d-f21d-49af-9d0c-b74fbe36911f"
    },
});
const data = await response.json();

Response

200400500

{
  "Data": {
    "Beneficiary": [
      {
        "AccountId": "text",
        "BeneficiaryId": "text",
        "Reference": "text",
        "CreditorAgent": {
          "SchemeName": [
            "UK.OBIE.BICFI"
          ],
          "Identification": "text",
          "Name": "text",
          "PostalAddress": {
            "AddressType": "Business",
            "Department": "text",
            "SubDepartment": "text",
            "StreetName": "text",
            "BuildingNumber": "text",
            "PostCode": "text",
            "TownName": "text",
            "CountrySubDivision": "text",
            "Country": "text",
            "AddressLine": [
              "text"
            ]
          }
        },
        "CreditorAccount": {
          "SchemeName": [
            "UK.OBIE.BBAN",
            "UK.OBIE.IBAN",
            "UK.OBIE.PAN",
            "UK.OBIE.Paym",
            "UK.OBIE.SortCodeAccountNumber"
          ],
          "Identification": "text",
          "Name": "text",
          "SecondaryIdentification": "text"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://example.com",
    "First": "https://example.com",
    "Prev": "https://example.com",
    "Next": "https://example.com",
    "Last": "https://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-12-22T11:30:15.674Z",
    "LastAvailableDateTime": "2024-12-22T11:30:15.674Z"
  }
}