Cancelling a Collection

Overview

This endpoint allows you to terminate a Direct Debit Collection.

Only pending Direct Debit transactions are eligible for cancellation.

Any custom data supplied to this endpoint will be stored against the resulting cancellation event.

POST - /transactions/{transaction_id}/cancel

Example request:

{
  "custom_data": "L3BheW1lbnQtbGlua3MgcGF5IGN1c3RvbV9kYXRh"
}

A successful request to this API endpoint will result in an HTTP Status Code of "200", with the transaction ID and its updated status echoed back in the response.

Example response:

{
  "status": "cancelled",
  "transaction_id": "4ebc5489-7b9f-4324-983e-07d4b2b00035"
}