Revoke all Direct Debits RESTful API
Edit me

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, in a single request (for a fixed-length schedule).

Usage The Revoke All request will only revoke payments in READY FOR EXPORT status. This request should be used where a fixed-length schedule is linked to the mandate
Method POST
URI /schemes/{CS_ID}/mandates/{MANDATE_ID}/revokealldirectdebits

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