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.

Usage Use the date filters to retrieve the required failed payment details
Method GET
URI /faileddirectdebits
Required Arguments rejectcreatefrom, rejectcreateto

A successful request will return a 200 OK response code.

The following is the complete list of possible status codes, which may be returned in the response:

Status Code Description
200 OK - The request completed successfully.
201 Created - A new resource has been created successfully. The resource is appended to the response.
400 Bad Request - The request was malformed. The response body will include an error providing further information.
401 Unauthorized - Your API key is wrong.
403 Forbidden - The client has provided a valid Authentication header, but it does not have permission to access this resource.
404 Not Found - The requested resource did not exist.
405 Method Not Allowed - When a HTTP method is being requested that isn’t allowed.
410 Gone - The API requested has been removed from our servers.
412 Precondition Failed - Certain unmet conditions must be fulfilled before the request to be processed e.g. timestamp is too old.
415 Unsupported Media Type - If incorrect content type was provided as part of the request (e.g. other than “application/json”).
422 Unprocessable Entity - Used for validation errors. More details will be provided in response body.
500 Internal Server Error - We had a problem with our server. Try again later and if the problem persists contact the Nuapay application support team.
501 Not Implemented - When the endpoint is not implemented yet.
503 Service Unavailable - We’re temporarially offline for maintanance. Please try again later.

Note: For a more detailed view of this API see the: API Reference