Revoke all Direct Debits | Nuapay Developer Hub

Revoke all Direct Debits RESTful API

API Details

As detailed in the Revoke Direct Debit section, it is possible to revoke a single Direct Debit payment that is in READY_FOR_EXPORT status. The Revoke All Direct Debits request allows you to revoke a number of payments, linked to a specific mandate/DDI, in a single request (for a fixed-length schedule).

Important: Note that in a fixed-length payment schedule (e.g. 12 payments, €10 per Direct Debit) all payments are created in READY_FOR_EXPORT status when you create the payment schedule. When you use the Revoke All Direct Debits request, all these payments are revoked. In an open-ended schedule only one payment is created in READY FOR EXPORT at any point in time; when one payment is exported a new payment is created in READY FOR EXPORT status. When you use Revoke All against an open-ended schedule, only one payment is revoked and a new payment will be created in READY_FOR_EXPORT.

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.