> For the complete documentation index, see [llms.txt](https://docs.hyperswitch.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperswitch.io/integrations/prism/api-reference/payout-service/void.md).

# Void

## Overview

The `Void` RPC 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 `merchant_payout_id` and required details. |

## Request Fields

| Field                    | Type          | Required | Description                                            |
| ------------------------ | ------------- | -------- | ------------------------------------------------------ |
| `merchant_payout_id`     | string        | No       | Your internal identifier for the payout.               |
| `address`                | PayoutAddress | Yes      | Address information associated with the payout.        |
| `connector_feature_data` | SecretString  | No       | Connector-specific metadata or feature configurations. |
| `connector_payout_id`    | string        | No       | The unique payout ID assigned by the connector.        |
| `access_token`           | SecretString  | No       | Access token for the connector, if required.           |

## Response Fields

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

## Example

```bash
grpcurl -H "x-connector: stripe" \
  -H "x-connector-config: {\"config\":{\"Stripe\":{\"api_key\":\"$STRIPE_API_KEY\"}}}" \
  -d '{
    "connector_payout_id": "po_1Hh1XYZ2eZvKYlo2C"
  }' \
  localhost:8080 types.PayoutService/Void
```

```json
{
  "payout_status": "CANCELLED",
  "connector_payout_id": "po_1Hh1XYZ2eZvKYlo2C",
  "status_code": 200
}
```

## Next Steps

* [Get Payout Status](/integrations/prism/api-reference/payout-service/get.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.hyperswitch.io/integrations/prism/api-reference/payout-service/void.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.