OPopenpayd

List Beneficiaries

Get a list of all parent beneficiaries filtered by various params.

get/beneficiaries

Request

  • Base URL
    https://sandbox.openpayd.com/api
  • URL
    https://sandbox.openpayd.com/api/beneficiaries
  • Auth
    API key in header Authorization

Query parameters

beneficiaryTypestring

Type of the beneficiary.<br>CORPORATE, RETAIL

companyNamestring
titlestring
firstNamestring
lastNamestring
tagstring

Indicates if the beneficiary is the account holder or a third party.<br>THIRD_PARTY, SELF

querystring

First name or last name of the parent beneficiary.

pageinteger
sizeinteger
sortstring

Sort by a parameter on the object. e.g. firstName,asc or firstName,desc

Response

200

totalPagesinteger
totalElementsinteger
lastboolean
firstboolean
numberOfElementsinteger
sizeinteger
numberinteger
emptyboolean

Example response

{
  "content": [
    {
      "beneficiaryType": "RETAIL",
      "id": "676c1be9-cab9-4b23-bd20-b30daa77ed9d",
      "accountHolderId": "71a32bf6-f190-4c19-8afa-6a1679829cb7",
      "title": "Mr.",
      "firstName": "Daniel",
      "lastName": "Smith",
      "friendlyName": "Personal Account"
    }
  ],
  "pageable": {
    "sort": {
      "unsorted": true,
      "empty": true
    },
    "pageSize": 20,
    "paged": true
  },
  "totalPages": 1,
  "totalElements": 3,
  "last": true,
  "first": true,
  "sort": {
    "unsorted": true,
    "empty": true
  },
  "numberOfElements": 3,
  "size": 20
}

Changes

No recorded changes to this operation across all 1 revision of this API.