Void

Overview

The void method cancels a payout that has been initiated but not yet completed or transferred. This is used when a payout needs to be stopped before the funds leave the merchant's account.

Purpose

Use this operation to halt a payout process.

Scenario	Developer Implementation
Cancel a scheduled payout	Call void with the merchantPayoutId and required details.

Request Fields

Field	Type	Required	Description
merchantPayoutId	string	No	Your internal identifier for the payout.
address	PayoutAddress	Yes	Address information associated with the payout.
connectorFeatureData	SecretString	No	Connector-specific metadata or feature configurations.
connectorPayoutId	string	No	The unique payout ID assigned by the connector.
accessToken	SecretString	No	Access token for the connector, if required.

Response Fields

Field	Type	Required	Description
merchantPayoutId	string	No	Your internal identifier passed to the payout processor.
payoutStatus	PayoutEnums.PayoutStatus	No	The current status of the payout (e.g., CANCELLED).
connectorPayoutId	string	No	The unique payout ID assigned by the connector.
error	ErrorInfo	No	Details of any error that occurred.
statusCode	uint32	Yes	The HTTP status code returned from the connector.

Example

SDK Setup

import com.hyperswitch.prism.PayoutClient;
import java.util.Map;
import java.util.HashMap;

PayoutClient payoutClient = PayoutClient.builder()
    .connector("stripe")
    .apiKey("YOUR_API_KEY")
    .environment("SANDBOX")
    .build();

Request

Map<String, Object> request = new HashMap<>();
request.put("connectorPayoutId", "po_1Hh1XYZ2eZvKYlo2C");

Response response = payoutClient.void(request);

Response

{
    "payoutStatus": "CANCELLED",
    "connectorPayoutId": "po_1Hh1XYZ2eZvKYlo2C",
    "statusCode": 200
}

Next Steps

• Get Payout Status