Sign in
Merchants

Gets a list of all beneficiary groups.

<b>Authorization</b>: End user token is required.

<b>User permissions required</b>: CanViewBeneficiaries

get/api/v1/merchants/{merchantID}/beneficiarygroups

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/merchants/{merchantID}/beneficiarygroups
  • Auth: API key in header Authorization

Path parameters

merchantIDstring uuid required

The ID of the merchant to get the beneficiary groups for.

Query parameters

pageNumberinteger

The page number from where records are retrieved.

pageSizeinteger

The number of records to be retrieved from a page.

Response

A BeneficiaryGroupsPageResponse containing the list of beneficiary groups.

pageNumberinteger

Current page number. Its 1 based. i.e firstpage is 1, secondpage is 2

pageSizeinteger

Page size

totalPagesinteger

Total pages

totalSizeinteger

Total count

Changes

No recorded changes to this endpoint across all 2 revisions of this API.