Documentation

Gets all mandates from a specific merchant with the supplied parameters.

get
https://api-sandbox.nofrixion.com/api/v1/mandates

Authorization: End user or Merchant token is required.

User permissions required: CanViewMandates

Query Params
uuid

ID of the merchant to retrieve mandates for.

int32
Defaults to 1

The page number from where records are retrieved. Note that the paging starts from page 1. If a 0 is supplied it will be treated as a 1 and the first page is returned.

int32
Defaults to 20

The number of records to be retrieved from a page.

date-time

The date filter to apply to retrieve mandates created after this date.

date-time

The date filter to apply to retrieve mandates created up until this date.

string
enum

The status filter to apply to retrieve mandates with this status

Allowed:
string

The text filter to apply to retrieve mandates with similar customer, bank account or mandate information.

string
enum

The currency filter to apply to retrieve mandates with this currency.

double

The amount filter to apply to retrieve mandates that exceed this amount.

double

The amount filter to apply to retrieve mandates that don't exceed this amount.

string

Optional expression to sort the order of the mandates. Example "Amount desc,Inserted asc".

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

403

Unauthorized error.

Updated 9 months ago

Language
Credentials
Header
LoadingLoading…
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