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

# Reverse

## Overview

The `reverse` method cancels a captured payment before the funds have been settled. Unlike voids (which apply to authorized but not captured payments), 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 charged or duplicate transaction. Reverse allows you to recover funds before they enter the settlement cycle.

## Purpose

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

## Request Fields

| Field                    | Type   | Required | Description                      |
| ------------------------ | ------ | -------- | -------------------------------- |
| `merchantReverseId`      | string | Yes      | Your unique reverse operation ID |
| `connectorTransactionId` | string | Yes      | The connector's transaction ID   |
| `cancellationReason`     | string | No       | Reason for reversing             |

## Response Fields

| Field                    | Type          | Description                  |
| ------------------------ | ------------- | ---------------------------- |
| `merchantReverseId`      | string        | Your reference (echoed back) |
| `connectorTransactionId` | string        | Connector's transaction ID   |
| `status`                 | PaymentStatus | VOIDED, REVERSED             |
| `error`                  | ErrorInfo     | Error details if failed      |
| `statusCode`             | number        | HTTP status code             |

## Example

### SDK Setup

```javascript
const { PaymentClient } = require('hyperswitch-prism');

const paymentClient = new PaymentClient({
    connector: 'stripe',
    apiKey: 'YOUR_API_KEY',
    environment: 'SANDBOX'
});
```

### Request

```javascript
const request = {
    merchantReverseId: "reverse_001",
    connectorTransactionId: "pi_3Oxxx...",
    cancellationReason: "Duplicate charge detected"
};

const response = await paymentClient.reverse(request);
```

### Response

```javascript
{
    merchantReverseId: "reverse_001",
    connectorTransactionId: "pi_3Oxxx...",
    status: "VOIDED",
    statusCode: 200
}
```

## Reverse vs Void vs Refund

| Action      | When to Use                      | Timeline           |
| ----------- | -------------------------------- | ------------------ |
| **Void**    | Before capture                   | Same day           |
| **Reverse** | After capture, before settlement | Same day           |
| **Refund**  | After settlement                 | 5-10 business days |

## Next Steps

* [capture](/integrations/prism/node/payment-service/capture.md) - Capture a payment after authorization
* [void](/integrations/prism/node/payment-service/void.md) - Cancel before capture
* [refund](/integrations/prism/node/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 dynamically by asking a question.

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

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.