List Failed Direct Debits RESTful API
Edit me

API Details

Direct Debit payments can fail at various stages in their lifecycle.

Where you are creating payments via the API you will be informed in your API response when there is an error in your request.

The List Failed Direct Debits API allows you to query any Bank-related rejects. It also allows you to list any Technical Rejects that you may have had (you will only have Technical Rejects if you are importing payments via file upload; API requests do not result in Technical Rejects).

Failed payments can be grouped into three basic types:

Type Description
Technical Rejects If you are importing payments into Nuapay via a file upload, some payments may be rejected for failing business validation rules. You may receive a DD001 code, for example, if you reference a mandate that does not exist. Note that there are no Technical Rejects for API or UI-based payments. In the case of an API request the response will indicate in real time that the payment has failed (if you have provided an incorrect mandate reference in your Create Direct Debit call, for example, you will receive a 7021 error code).
Pre-settlement Failures Payments that are created and exported that the Payer’s bank then rejects or refuses before the settlement date.
Post-settlement Failures Payments that are exported and accepted but the bank then fails after the settlement date.

API Details

The List Failed Direct Debits request allows you to return a list of all technical reject, pre-, and post-settlement failed payments. Note that you should schedule to run this request at various times in the lifecycle of your Direct Debits to ensure that you have the current statuses of your payments before and after the settlement date. Alternatively you could implement a Webhook for this.