Revoke

Overview

The revoke method cancels an existing recurring payment mandate.

Business Use Case: A customer cancels their subscription. Stop future billing.

Purpose

Scenario	Benefit
Subscription cancellation	Honor cancellations
Compliance	Meet regulatory requirements

Request Fields

Field	Type	Required	Description
mandateId	string	Yes	The mandate ID to revoke
reason	string	No	Reason for revocation

Response Fields

Field	Type	Description
mandateId	string	The revoked mandate ID
status	MandateStatus	REVOKED
revokedAt	string	ISO 8601 timestamp
statusCode	int	HTTP status code

Example

SDK Setup

use HyperswitchPrism\RecurringPaymentClient;

$recurringClient = new RecurringPaymentClient([
    'connector' => 'stripe',
    'apiKey' => 'YOUR_API_KEY',
    'environment' => 'SANDBOX'
]);

Request

$request = [
    'mandateId' => 'mandate_xxx',
    'reason' => 'customer_canceled'
];

$response = $recurringClient->revoke($request);

Response

[
    'mandateId' => 'mandate_xxx',
    'status' => 'REVOKED',
    'revokedAt' => '2024-01-15T10:30:00Z',
    'statusCode' => 200
]

Next Steps

• charge - Process payments before revocation