List All Recipients

Retrieve all Recipient Accounts created within a Business Account.

Use the state and search query parameters to filter the results. Use the sort query parameter to sort the results, and use the page and size query parameters to limit the number of results returned.

Note Recipient Accounts will be retrieved for the Business Account associated with the request access token.

Endpoint

GET /v1/recipients

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

state

string enum, values: ACTIVE, SUSPENDED

Filter the results by the state of the Recipient Account. Possible values are ACTIVE (account is active) and SUSPENDED (account is inactive).

string

Limit the results based on the following fields.

firstName

string, max length: 40, min length: 1

Recipient’s first name.

middleName

string, max length: 40, min length: 1

Recipient’s middle name.

lastName

string, max length: 40, min length: 1

Recipient’s last name.

string, max length: 320

Recipient’s email address.

sort

array [string]

Sort the response by any field in ascending or descending order. For details, see Sorting and Pagination. The default sort order is createdAt,DESC.

page

integer (int32)

Page number to return, based on zero-based page index.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of Recipient objects.

SAMPLE RESPONSE

				
					{
  "totalElements": 100,
  "totalPages": 50,
  "number": 1,
  "numberOfElements": 2,
  "hasNext": true,
  "content": [
    {
      "id": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
      "businessAccountId": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
      "businessRefId": "RECIP001",
      "firstName": "John",
      "middleName": "",
      "lastName": "Smith",
      "secondLastName": "",
      "email": "jsmith@xyz.com",
      "phoneNumber": "9055621258",
      "nationality": "Canadian",
      "dateOfBirth": "1970-07-08",
      "additionalInformation": "",
      "recipientType": "INDIVIDUAL",
      "businessName": "",
      "state": "ACTIVE",
      "createdBy": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "employee"
      },
      "createdAt": "2021-09-20T22:09:31.947Z",
      "updatedBy": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "employee"
      },
      "updatedAt": "2021-10-20T22:09:31.947Z",
      "requestorId": "8th32z87-3845-9810-v7gu-1f827g98swk3"
    },
    {...},
    {...}
  ]
}