Re-present Failed Direct Debits | Nuapay Developer Hub

Re-present Failed Direct Debits RESTful API

API Details

Where a payment fails (for example for insufficient funds) you may want to re-try (i.e. re-present) the payment.

The re-present request carries out two distinct steps:

It updates the original failed payment’s status to RE-PRESENTED
It creates a new Direct Debit payment (with a new collection date and a new payment reference) in READY_FOR_EXPORT status

Optionally the new Direct Debit payment may also include a re-presentation fee

For SEPA:

Note: Certain SEPA Response codes will indicate that a re-presentation will be unsuccessful. For example an MD07 (debtor deceased) or an AC04 (Account closed). We recommend that you only attempt to re-present a failed payment for MS03 (Reason not specified) and AM04 (Insufficient funds).

For Bacs:

Note: For Bacs re-presentation must take place within one month of the date on which the first presentation was made; the amount must be the same as the original failed payment. A service user should give at least 5 working days’ notice to the payer of the new collection date. For more information on the rules on re-presentation see the Bacs Service User Guide, available for download from the Bacs site

The following are optional arguments:

representationDate
representationFee (not allowed for Bacs)
endToEndId

Important: If you do not specify a re-presentation date or fee, the default values will be taken from your organisation’s Nuapay configuration. These settings are configured at the Scheme level for your business.

Idempotency

Tip: We recommend that you use a unique idempotency key when working with this endpoint. The Idempotency-Key is a Header parameter in this API.

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

Swagger Reference: Direct Debits & Credit Transfers

Note:

When working with our APIs, please use the Sandbox URI when testing and the Live URI when you move to Production.

LIVE     https://api.nuapay.com
SANDBOX  https://sandbox.nuapay.com/

If you haven't done so already and would like to do some testing, please Request Sandbox Access

Important: Endpoints and Webhooks may be extended from time to time and any changes we make will follow our Versioning and Backward Compatibility rules. This means that the code that you write today must be designed to be robust enough to handle any future changes (where a new object is added to (or removed from) a specific API response, for example).

Tip: You must use the resource identifier of the schemeId/ mandateId/ directDebitId in your requests and not the actual creditor scheme ID/SUN or Unique Mandate Reference or Direct Debit identifier. Resource identifiers are short alphanumeric strings, similar to this: abxq9kq52l. Depending on the request you may need 1, 2 or all 3 of these resource identifiers in your URI.