Sign in
Merchants

Exports 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/export

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/merchants/{merchantID}/beneficiaries/export
  • 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.

Response

Returns a CSV file containing the list of beneficiaries.

Changes

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