v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

beneficiaries

Retrieve all beneficiaries for a user

Requires beneficiaries:read scope. Optional scope beneficiaries_detail:read is needed for some extra fields such as postal address.

get/beneficiaries

Query parameters

limitinteger

The total number of records to retrieve

offsetinteger

The offset at which to start retrieving records

isUniqueboolean

Whether the beneficiaries returned include duplicates with differing references

Response

Successful Beneficiaries Response

metaobject

Example response

{
  "data": [
    {
      "id": "d372d09b-f50a-4114-9c83-687828fa8ac2",
      "name": "Bob",
      "reference": "Payment",
      "accountNumber": "12345678",
      "sortCode": "123456",
      "providerAccountId": "provider-account-id1",
      "providerBeneficiaryId": "provider-beneficiary-id1",
      "connectionId": "1ffe704d39629a929c8e293880fb449a:c1ef4ce6-c1d6-4900-9288-228fb21f5dc4",
      "accountId": "fc9bd177-d01e-449c-9f29-d3656d2edc2e"
    },
    {
      "id": "d372d09b-f50a-4614-9c83-687828fa8ac2",
      "name": "Alice",
      "reference": "Payment",
      "accountNumber": "87654321",
      "sortCode": "654321",
      "providerAccountId": "provider-account-id1",
      "providerBeneficiaryId": "provider-beneficiary-id2",
      "connectionId": "1ffe704d39629a929c8e293880fb449a:c1ef4ce6-c1d6-4900-9288-228fb21f5dc4",
      "accountId": "fc9bd177-d01e-449c-9f29-d3656d2edc2e"
    }
  ]
}