Retrieve Mandate RESTful API
API Details
Note that:
- The Retrieve Mandate endpoint allows you to view the details of a specific mandate/DDI stored in Nuapay.
- The request requires that you provide the Mandate/DDI resource identifier (as returned in the Create Mandate call service): the
mandateId.
Swagger Reference:
Direct Debits & Credit Transfers
Note:
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).
Tip: You must use the resource identifier of the
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