---
title: "Get Beneficiaries"
method: GET
path: "/za/pb/v1/accounts/beneficiaries"
tags: ["Beneficiaries and Beneficiary payments"]
---

# Get Beneficiaries

`GET /za/pb/v1/accounts/beneficiaries`

## Request

- Base URL: `https://openapi.investec.com`
- URL: `https://openapi.investec.com/za/pb/v1/accounts/beneficiaries`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://openapi.investec.com/identity/v2/oauth2/token` scopes: `beneficiarypayments`

List of beneficiaries linked to the profile

## Response `200`

Resource has been retrieved

- object
  - `data` object[], required: Set of elements used to define the beneficiaries details.
    - `beneficiaryId` string: A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
    - `accountNumber` string: The beneficiary bank account number.
    - `code` string: The beneficiary bank code.
    - `bank` string: The beneficiary bank name.
    - `beneficiaryName` string: Beneficiary name.
    - `lastPaymentAmount` string: Last payment amount made to the beneficiary.
    - `lastPaymentDate` string: Last payment date to the beneficiary.
    - `cellNo` string: Notification cell no.
    - `emailAddress` string: Notification email address.
    - `name` string: Beneficiary name.
    - `referenceAccountNumber` string: Reference account number.
    - `referenceName` string: Reference name.
    - `categoryId` string: Beneficiary category id.
    - `profileId` string: Profile id.
    - `fasterPaymentAllowed` boolean: Faster Payment Allowed.
  - `meta` object, required: Meta Data relevant to the payload
    - `totalPages` integer
  - `links` object, required: Links relevant to the payload
    - `self` string, required

## Other responses

- `400`: Bad Request - The requested operation will not be carried out
- `401`: Unauthorized - The requested operation was refused access
- `403`: Forbidden - Not permitted to make this request
- `429`: Too Many Requests - To many requests in quick succession, Retry the request.
- `500`: Internal Server Error - The requested operation failed to execute

---

[API](https://skmtc.dev/rijnhardtkotze/apis/sa-pb-account-information.md) - [All operations](https://skmtc.dev/rijnhardtkotze/apis/sa-pb-account-information/llms.txt) - [OpenAPI document](https://skmtc.dev/rijnhardtkotze/apis/sa-pb-account-information/revisions/1ab926851d29?raw)
