Revoke a consent

Revokes an authorised payment consent. The consent must be in AUTHORISED state.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params

Revocation reason supplied with the request.

string
enum
required

The reason the consent is being revoked. Must be one of the predefined values:

  • END_USER_REQUESTED: The end user has requested revocation of their consent through the Lean-provided consent management interface or via the client's customer support.
  • CONSENT_RENEWAL: The consent is being revoked as part of a renewal flow, where a replacement consent has been authorized to supersede it.
  • KYC_VERIFICATION_FAILED: The client's KYC or identity verification checks on the end user have failed or could not be completed.
  • REGULATORY_RESTRICTION: A regulatory, compliance, or jurisdictional obligation requires the client to revoke the consent.
  • FRAUD_SUSPECTED: Suspicious or potentially fraudulent activity has been detected on the end user's account or transactions.
  • CLIENT_TERMINATED_RELATIONSHIP: The client has ended their commercial relationship with the end user.
  • ACCOUNT_CLOSED_BY_USER: The end user has permanently closed their account with the client.
  • DUPLICATE_CONSENT: A duplicate or superseding consent exists for the same end user and payment source, and this consent is being retired.
string | null

Optional free-text context describing the circumstances of the revocation.

Responses

400

The consent is not in an AUTHORISED state and cannot be revoked.

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json