The List Mandates request allows you to view a collection of mandates/DDIs 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/DDIs.
When working with our APIs, please use the Sandbox URI when testing and the Live URI when you move to Production.
LIVE https://api.nuapay.com SANDBOX https://sandbox.nuapay.com/
If you haven't done so already and would like to do some testing, please Request Sandbox Access
Important: Endpoints and Webhooks may be extended from time to time and any changes we make will follow our Versioning and Backward Compatibility rules. This means that the code that you write today must be designed to be robust enough to handle any future changes (where a new object is added to (or removed from) a specific API response, for example).
schemeIdin your request and not the actual creditor scheme ID or SUN. This identifier will be similar to this: abxq9kq52l - so in this case you would call GET /schemes/abxq9kq52l/mandates. See List Schemes for more on this.