API Details
All Mandates/DDIs include a PDF representation of the mandate/DDI data. If required you may upload a different representation of a mandate (PDF, JPG and GIF formats are all supported).
The Retrieve Mandate Document call allows you to access the file representation of the mandate.
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).
schemeId
in your request and not the actual creditor scheme ID or SUN. This identifier will be similar to this: abxq9kq52l. Similarly, the mandate identifier is the resource identifier (e.g., rtsxq8kaby5) and is not the actual unique mandate reference - so in this case you would call GET /schemes/abxq9kq52l/mandates/rtsxq8kaby5/document