As outlined in the Create Direct Debit service, you must have an
ACTIVE mandate/DDI before you can begin to collect Direct Debit payments. Typically you would use the Create Mandate endpoint and then reference the successfully activated mandate/DDI when you create the Direct Debit payment.
The Create Direct Debit and Mandate call allows you to combine these separate requests into a single call; the request performs two operations:
- A mandate/DDI is created in
- A Direct Debit payment is created and linked to the new mandate/DDI
The Create Direct Debit and Mandate request must include:
- A requested collection date for the Direct Debit payment
- The payment amount
- The payer’s name
- The payer’s account details
- The Merchant’s Nuapay IBAN
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:
requestedCollectionDateis not set beyond the 3 business days into the future, the date will be automatically shifted.
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).
directDebitIdin your requests and not the actual creditor scheme ID/SUN or Unique Mandate Reference or Direct Debit 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.