Documentation

Gets a list of all beneficiaries.

get
https://api-sandbox.nofrixion.com/api/v1/merchants//beneficiaries

Authorization: End user token is required.

User permissions required: CanViewBeneficiaries

Path Params
uuid
required

The ID of the merchant to get the beneficiaries for.

Query Params
int32

The page number from where records are retrieved.

int32

The number of records to be retrieved from a page.

string

The text filter used to retrieve the records..

string
enum

The currency filter used to retrieve the records..

boolean
Defaults to false

If set to true will include disabled beneficiaries as well

string

Optional expression to sort the order of the beneficiaries.

uuid

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Updated 9 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json
Updated 9 months ago