GOgovernment-digital-service
Agreements

Cancel an agreement for recurring payments

Changed on

You can use this endpoint to cancel a recurring payments agreement in the active status.

post/v1/agreements/{agreementId}/cancel

Request

  • Base URL
    https://publicapi.payments.service.gov.uk
  • URL
    https://publicapi.payments.service.gov.uk/v1/agreements/{agreementId}/cancel
  • Auth
    HTTP bearer

Path parameters

agreementIdstring required

The agreement_id of the agreement you are cancelling

Response

No Content

Changes

  • c8f226fc66d4Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 3917b606b0ddRevision changes
    • info

      endpoint added