API Details
You may need to make updates to mandates/DDIs at various points. Where a payer informs you that address details or an account has changed, for example, it is important to update this data so that Direct Debit payments will continue to be processed as normal.
You may need to re-send the mandate/DDI for signature depending on the update that is being made to the mandate/DDI.
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).
Idempotency
The Idempotency check is only against successful requests, so where a previous call has resulted in any of the following HTTP Response Codes, that Idempotency key may be reused without any issue:
401403404408500501503
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 PATCH /schemes/abxq9kq52l/mandates/rtsxq8kaby5