Merchants

Gets a list of all beneficiaries.

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

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

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

Request

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

Path parameters

merchantIDstring uuid required

The ID of the merchant to get the beneficiaries for.

Query parameters

pageNumberinteger

The page number from where records are retrieved.

pageSizeinteger

The number of records to be retrieved from a page.

searchstring

The text filter used to retrieve the records..

currency'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC'

The currency filter used to retrieve the records..

includeDisabledboolean

If set to true will include disabled beneficiaries as well

sortstring

Optional expression to sort the order of the beneficiaries.

sourceAccountIDstring uuid

Optional source account ID to filter beneficiaries by their source account.

Response

A BeneficiaryPageResponse containing the list of beneficiaries.

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.