ALalphagov
Card payments

Cancel payment

Changed on

Cancel a payment based on the provided payment ID and the Authorisation token. The Authorisation token needs to be specified in the 'authorization' header as 'authorization: Bearer YOUR_API_KEY_HERE'. A payment can only be cancelled if it's in a state that isn't finished.

post/v1/payments/{paymentId}/cancel

Request

  • Base URL
    https://publicapi.payments.service.gov.uk
  • URL
    https://publicapi.payments.service.gov.uk/v1/payments/{paymentId}/cancel
  • Auth
    API key in header Authorization

Path parameters

paymentIdstring required

Payment identifier

Response

No Content

Changes

  • 6d52e43c48aaRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • info

      the endpoint scheme security Authorization was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

  • 884c555517bcRevision changes
    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      the endpoint scheme security Authorization was removed from the API

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status