PEpennylane
Mandates

Cancel a Gocardless mandate

Changed on

Cancels a specific Gocardless mandate by ID. The mandate must be in a cancellable state, having one of the following statuses: pending_submission, submitted or active.

ℹ️ This endpoint requires the following scope: customer_mandates:all

post/api/external/v2/gocardless_mandates/{gocardless_mandate_id}/cancellations

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/gocardless_mandates/{gocardless_mandate_id}/cancellations
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token scopes: customer_mandates:all

Path parameters

gocardless_mandate_idinteger required

ID of the Gocardless mandate to cancel

Headers

X-Company-Idstring
Example:12345

Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.

Response

Mandate cancelled successfully. No content returned.

Changes