> 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/python/payment-service/reverse.md).

# Reverse

## Overview

The `reverse` method cancels a captured payment before funds have settled. Unlike voids, reverses apply to captured payments that haven't completed bank settlement.

**Business Use Case:** When an error is discovered immediately after capture, such as incorrect amount or duplicate transaction. Recover funds before settlement.

## Purpose

| Scenario              | Benefit                         |
| --------------------- | ------------------------------- |
| Same-day cancellation | Recover funds before settlement |
| Processing error      | Undo incorrect capture          |
| Duplicate transaction | Reverse double charge           |

## Request Fields

| Field                      | Type | Required | Description                      |
| -------------------------- | ---- | -------- | -------------------------------- |
| `merchant_reverse_id`      | str  | Yes      | Your unique reverse operation ID |
| `connector_transaction_id` | str  | Yes      | The connector's transaction ID   |
| `cancellation_reason`      | str  | No       | Reason for reversing             |

## Response Fields

| Field                      | Type          | Description                  |
| -------------------------- | ------------- | ---------------------------- |
| `merchant_reverse_id`      | str           | Your reference (echoed back) |
| `connector_transaction_id` | str           | Connector's transaction ID   |
| `status`                   | PaymentStatus | VOIDED, REVERSED             |
| `status_code`              | int           | HTTP status code             |

## Example

### SDK Setup

```python
from hyperswitch_prism import PaymentClient

payment_client = PaymentClient(
    connector='stripe',
    api_key='YOUR_API_KEY',
    environment='SANDBOX'
)
```

### Request

```python
request = {
    "merchant_reverse_id": "reverse_001",
    "connector_transaction_id": "pi_3Oxxx...",
    "cancellation_reason": "Duplicate charge detected"
}

response = await payment_client.reverse(request)
```

### Response

```python
{
    "merchant_reverse_id": "reverse_001",
    "connector_transaction_id": "pi_3Oxxx...",
    "status": "VOIDED",
    "status_code": 200
}
```

## Next Steps

* [capture](/integrations/prism/python/payment-service/capture.md) - Capture a payment
* [void](/integrations/prism/python/payment-service/void.md) - Cancel before capture
* [refund](/integrations/prism/python/payment-service/refund.md) - Return funds after settlement


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.hyperswitch.io/integrations/prism/python/payment-service/reverse.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.