GOgocardless
Mandate

Cancel a mandate

Immediately cancels a mandate and all associated cancellable payments. Any metadata supplied to this endpoint will be stored on the mandate cancellation event it causes.

This will fail with a cancellation_failed error if the mandate is already cancelled.

post/mandates/{mandate_id}/actions/cancel

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Path parameters

mandate_idstring required

The mandate id

Headers

GoCardless-Versionstring required

Request body

Response

Action completed successfully

Example response

{
  "mandates": {
    "id": "MD123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "reference": "REF-123",
    "status": "pending_submission",
    "scheme": "bacs",
    "mandate_type": "bank_debit",
    "next_possible_charge_date": "2014-10-27",
    "next_possible_standard_ach_charge_date": "2014-10-27",
    "verified_at": "2021-01-01T12:00:00.000Z",
    "links": {
      "customer_bank_account": "BA123",
      "creditor": "CR123",
      "new_mandate": "MD123",
      "customer": "CU123"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.