API Details
As outlined in Create Payment Schedule, before you can add a schedule of Direct Debit payments for a payer you must first have an ACTIVE mandate/DDI in place; so two separate requests are required: one to create and activate a mandate and a second to add the schedule of payments.
The Create Payment Schedule and Mandate service allows you to combine these two request so that you can create a mandate/DDI and a payment schedule in a single request.
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.