The List Mandates request allows you to view a collection of mandates linked to a:
- Specific Scheme
- All schemes (i.e. all mandates)
Use an appropriate URI (as described below) to return the required collection of Mandates.
|API Reference||List Mandates|
|Usage||You can return all mandates or filter based on scheme|
The following are optional arguments:
|createdatefrom||Use this value to filter your query to return details of mandates created from this date. Format is yyyy-mm-dd.|
Use this value to filter your query to return details of mandates created up to this date.
Format is yyyy-mm-dd.
|debtoriban||Allows you to filter based on a specific IBAN|
|debtorname||Allows you to filter based on a specific payer name|
|mandateid||The mandate reference (this is the actual mandate Identifier or Unique Mandate Reference - UMR and not the resource identifier)|
|mandatestatus||Use to further filter the mandates returned by your request (see Mandate Statuses for more information on the various statuses)|
A successful request will return a 200 OK response code
The response includes:
|id||A resource identifier that uniquely identifies the mandate in Nuapay|
|uri||A resolvable path containing the resource identifier of the merchant scheme and the mandate.|
|mandateId||A unique identifier for each mandate returned in the collection.|
|debtorIBAN||The payer's account|
|mandateStatus||The status of each mandate|
Additional data may be returned in the response based on the optional fields provided in the request. See the Mandate List Object in the API Reference for a full list of potential values.