Create Direct Debit & Mandate/DDI | Nuapay Developer Hub

Create Direct Debit & Mandate RESTful API - generate a mandate and a payment in a single API call.

API Details

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 ACTIVE status
A Direct Debit payment is created and linked to the new mandate/DDI

Note: A successful request will result in a new mandate and direct debit being created. If the request is unsuccessful neither a mandate/DDI nor a direct debit will be created.

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

Idempotency

Tip: We recommend that you use a unique idempotency key when working with this endpoint. The Idempotency-Key is a Header parameter in this API.

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:

401
403
404
408
500
501
503

Tip: In Bacs, because the DDI will need to be registered with the scheme (via an AUDDIS submission) before the first Direct Debit payment can be made, if the requestedCollectionDate is not set beyond the 3 business days into the future, the date will be automatically shifted.

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/ mandateId/ directDebitId in 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.