Skip to main content

reverse Method

Overview

The reverse method cancels a captured payment before settlement.

Request Fields

FieldTypeRequiredDescription
merchantReverseIdstringYesYour reverse operation ID
connectorTransactionIdstringYesThe transaction ID
cancellationReasonstringNoReason for reversing

Response Fields

FieldTypeDescription
statusPaymentStatusVOIDED, REVERSED

Example

$request = [
'merchantReverseId' => 'reverse_001',
'connectorTransactionId' => 'pi_3Oxxx...',
'cancellationReason' => 'Duplicate charge'
];
$response = $paymentClient->reverse($request);