v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

beneficiaries

Retrieve a single beneficiary

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

get/beneficiaries/{beneficiaryId}

Path parameters

beneficiaryIdstring uuid required

The Beneficiary Id

Response

Successful Beneficiary Response

metaobject

Example response

{
  "data": {
    "id": "ac9bd177-d01e-449c-9f29-d3656d2edc2e",
    "name": "Beneficiary",
    "reference": "Beneficiary reference",
    "accountNumber": "12345678",
    "sortCode": "123456",
    "iban": "GB2960161331926819",
    "pan": "1234567812345678",
    "accountId": "ac9bd177-d01e-449c-9f29-d3656d2edc2e",
    "createdAt": "2018-07-10T11:39:44.000Z",
    "modifiedAt": "2018-07-10T11:39:44.000Z"
  }
}