Create Direct Debit RESTful API

API Details

The Create Direct Debit request must:

  • Include the resource identifier Creditor Scheme ID (CSID) or Service User Number (SUN) (see the List Creditor Scheme request)
  • 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 SEPA Clearing or to Bacs Clearing for processing (see Direct Debit Statuses for more information).

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:

  • 401
  • 403
  • 404
  • 408
  • 500
  • 501
  • 503

A Note on Payment References in the Bacs Scheme

When creating a Direct Debit against a Bacs DDI, please note:

  • Your payment must include a reference that includes your DDI (the Core Reference). Note that the reference you provide:
    • IMPORTANT! Must include the mandateId i.e. the DDI reference as its initial characters; so if your DDI Reference (mandateId) is ABCDEF123 then valid reference values would be ABCDEF123-01, ABCDEF12302, ABCDEF123/456, for example. If required you may simply always provide the same reference: ABCDEF123.
    • Must be at least 6 alphanumeric characters in length and cannot exceed a total of 18 characters.
    • Cannot begin with DDIC (this is reserved for PSP use).
    • Should only be composed of upper-case characters.
  • If you don’t pass a reference, Nuapay will automatically generate one for you and store the DDI Reference as the structuredRemittanceInformation.reference. A unique endToEndId is also generated.
  • If you you provide an endToEndId this will be saved as the structuredRemittanceInformation.reference subject to a duplicate check.
  • If an endToEndId and a structuredRemittanceInformation.reference are provided in your request, the structuredRemittanceInformation.reference is used as the DDI (Core) Reference.
  • If you only provide a structuredRemittanceInformation.reference, Nuapay will generate an endToEndId and the structuredRemittanceInformation.reference is used as the Core Reference.
  • The following non-alphanumeric characters are supported and may be used in the endToEndId identifier:
    • Full stop(.)
    • Slash (/)
    • Hyphen (-)
    • Blank space ( )