Skip to content
Explore Class APIs/Beneficiary Data/
Beneficiary accounts

Beneficiary accounts

Request

Retrieves a list of all beneficiary accounts in the Fund including account balance, type, status, and associated beneficiary information.

Security
Class_oAuth(Required scopes: fund.read)
Path
businessCodestringrequired

Class business code

Example:demo-business
fundCodestringrequired

Class entity code

Example:demo-fund
curl -i -X GET \
  https://api.class-pie.com.au/api/1.0/f/demo-business/demo-fund/beneficiary-data/list-beneficiary-accounts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success (Ok)

Bodyapplication/json
Dataobjectrequired

Represents a beneficiary's account within an Fund including balance and status information

ErrorsArray of objects
Response
{
  "Data": {
    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Description": "Accumulation Account - John Smith",
    "Type": "Accumulation",
    "Balance": 485000.5,
    "Status": "Active",
    "BeneficiaryName": "John William Smith",
    "BeneficiaryId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  },
  "Errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}