Sign in
Mandates

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

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

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

get/api/v1/mandates

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/mandates
  • Auth: API key in header Authorization

Query parameters

merchantIDstring uuid

ID of the merchant to retrieve mandates for.

pageinteger

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.

sizeinteger

The number of records to be retrieved from a page.

fromDatestring date-time

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

toDatestring date-time

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

status'Unknown' | 'Pending' | 'Active' | 'Expired' | 'Failed'

The status filter to apply to retrieve mandates with this status

searchstring

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

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 to apply to retrieve mandates with this currency.

minAmountnumber double

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

maxAmountnumber double

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

mandateIDsstring[]

Optional list of mandate IDs to filter by. When supplied, only mandates whose ID is in this list are returned.

sortstring

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

Response

Mandate collection paged result.

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.