You are here: Payments > Direct Debits > Direct Debit Payment APIs > Create Direct Debit

Create Direct Debit

The Create Direct Debit request must:

  • Include the resource identifier Creditor Scheme ID (CSID) (see here)
  • Reference an active mandate (its resource ID)

A successful request will result in a Direct Debit being set up in READY_FOR_EXPORT status: the payment is created but has not yet been forwarded to ClearingThe Clearing and Settlement Mechanism (CSM) that processes SEPA payments (The EBA's STEP-2 system allows banks across Europe to use one channel to send and receive their SEPA Credit Transfer and SEPA Direct Debit transactions) for processing (see Payment Statuses for more information).

Nuapay allows you to create a mandate and a Direct Debit payment in a single API request. For more details on this see the Create Direct Debit and Mandate request.
REQUEST
API Reference Create Direct Debit
Usage You must reference an ACTIVE mandate
Method POST
URI /schemes/{CS_ID}/mandates/{MANDATE_ID}/directdebits

The following are required arguments:

requestedCollectionDate The required settlement date. Note that you must specify a date in the future (typically 2 business days from today)
paymentAmount The payment amount.

Additional optional arguments may be provided (see the Create Direct Debit API reference for full details)

RESPONSE

A successful request will return a 201 Created response code

If you do not see a 201, see the HTTP Response Codes section of the API Reference to assist you to troubleshoot the issue.

At a minimum we recommend that you store the following data:

id A resource identifier that uniquely identifies the payment in Nuapay
uri A resolvable path containing the resource identifier of the merchant scheme, the mandate and the direct debit. This value is used in other direct debit requests
endToEndId A unique identifier for the payment. You may provide an end-to-end in your request if required and it will be returned in the response; alternatively if not provided in your request, Nuapay will automatically generate one.
exportDate The date on which the payment will be passed from Nuapay to Clearing for further processing; on this date the status of the payment moves from READY FOR EXPORT to EXPORTED
paymentStatus The current status of the payment (initially READY FOR EXPORT)