v50

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-169377194.1 KB
Tasks

Cleanup charges with Gateway

Finds all charges (ePDQ, Worldpay, Stripe) which have a status of AUTHORISATION ERROR, AUTHORISATION UNEXPECTED ERROR, AUTHORISATION TIMEOUT and checks what their status is with the payment gateway. If the charges exist on the gateway and are in a non-terminal state, e.g. AUTHORISATION SUCCESS, a request is sent to cancel the charge on the gateway.<br>The job will move the charge into one of three statuses when it has successfully handled it:<br> - AUTHORISATION ERROR CANCELLED - the charge was authorised on the gateway but has now been cancelled. <br> - AUTHORISATION ERROR REJECTED - the authorisation was rejected on the gateway and no action needed to be taken to clean up.<br> - AUTHORISATION ERROR CHARGE MISSING - the charge was not found on the gateway, most likely because the error was before the gateway processed the authorisation.

post/v1/tasks/gateway-cleanup-sweep

Query parameters

limitinteger required

The maximum number of charges in an error state that will be processed by the task

Response

OK

string required