You are here: Payments > Direct Debits > Direct Debit Payments Overview

Direct Debit Payments Overview

See the Direct Debit Payments Overview for a high-level explanation of a Direct Debit payment.

Before you can set up any payments via the API please note that you must:

  • Reference active mandates in your request.
  • Have retrieved resource Creditor Scheme ID (see Your First API Request in the Basics section)

Nuapay currently offers the following API requests related to Direct Debit payments. Note that certain requests require that the direct debit that is being referenced is in a specific status. For more on statuses see Payment Statuses:

Request Description
Create Direct Debit Used to create a new Direct Debit payment
Retrieve Direct Debit A GET request to return details of an existing payment; the response will return details like the payment's status, end-to-end ID, remittance information, etc.
List Direct Debits A GET request that allows you to retrieve a collection of Direct Debits linked to a specific mandate, scheme or specific merchant.
List Failed Direct Debits A GET request that returns all rejected Direct Debits for a given date range. The request can be configured to return only those Direct Debits that were rejected by external Banks or to return all Bank Rejects and all Technical (or Nuapay internal) Rejects. Technical Rejects are rejections related to file imports where the payment has failed before being passed 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).
Revoke Direct Debit Where a Direct Debit is in 'Ready for Export' status it is possible to revoke the payment using this POST request. Revoked payments are not included in exported PAIN.008 files and are not passed 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).
Revoke all Direct Debits In some scenarios you may have configured a number of Direct Debits against a single mandate (you may have set up a fixed-length schedule, for example) and later decide that the collection amounts are incorrect. In this case you can revoke all the associated Direct Debits using this request.
Re-present Failed Direct Debit

Where a Direct Debit is rejected this request allows you to:

  1. Set the original failed payment's status to 'Re-presented'
  2. Create a new Direct Debit for the same amount against the same mandate.