API Details
In a Fixed-Length schedule the Cancel Payment Schedule request will set the status of any READY_FOR_EXPORT Direct Debit transactions in that schedule to REVOKED.
In an Open-Ended schedule the current READY_FOR_EXPORT payment is updated to CANCELLED and no additional payments will be added.
(See Direct Debit Statuses for more information on the various payment statuses that are possible).
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
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/ mandateId/ paymentScheduleId in your requests and not the actual creditor scheme ID/SUN or Unique Mandate Reference or payment schedule identifier. Resource identifiers are short alphanumeric strings, similar to this: abxq9kq52l. Depending on the request you may need 1, 2 or all 3 of these resource identifiers in your URI.