Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Consents

Revoke a consent

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

post/consents/v1/{consent_id}/revocation

Request body

reason'END_USER_REQUESTED' | 'CONSENT_RENEWAL' | 'KYC_VERIFICATION_FAILED' | 'REGULATORY_RESTRICTION' | 'FRAUD_SUSPECTED' | 'CLIENT_TERMINATED_RELATIONSHIP' | 'ACCOUNT_CLOSED_BY_USER' | 'DUPLICATE_CONSENT' 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.
additional_contextstring nullable

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

Example request

{
  "additional_context": "End user reported losing access to the linked account."
}

Response

Consent revoked successfully.

object required