Beneficiaries

List beneficiaries

Retrieves your saved beneficiaries, paginated. type=beneficiary is required — the same route serves customers, and the parameter is what separates them.

get/v2/parties

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/parties
  • Auth: API key in header Authorization

Query parameters

type'beneficiary' required

Must be beneficiary.

searchstring

Search beneficiaries by name, phone number, or email address.

pageinteger

Current page number. Default 1.

limitinteger

Number of records per page. Default 20.

sortBy'name' | 'createdAt'

Field to sort by. Default createdAt.

sortType1 | -1

Sorting direction: 1 = ascending, -1 = descending. Default -1.

startDatestring

Only return beneficiaries created after this date.

endDatestring

Only return beneficiaries created before this date.

labelsstring

Comma-separated label names to filter by.

branchIdsstring

Comma-separated branch ids to filter by, for branch-scoped merchants.

Response

A page of beneficiaries.

messagestring

Changes

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