# Cancel a Pay In transaction with the API

> Cancel transactions with void, refund, or reverse operations. Return funds to customers automatically based on settlement status, with support for full and partial refunds

<AudienceInfo audiences={['developers']} />

How you cancel a pay-in transaction depends on the transaction status. If a transaction hasn't been settled yet, you can void it. If a transaction has been settled, or settlement is pending, you can refund the transaction. Payabli offers a convenient third method, *reversal*, which dynamically refunds or voids a transaction based on its settlement status.

This guide explains how to void, refund, and reverse transactions with the Payabli API.

## Choose a method

First, choose a transaction cancellation method. To streamline your integration with Payabli, use reverse.

<Frame caption="Click to expand">
  <img alt="diagram explained in surrounding text" src="https://files.buildwithfern.com/payabli.docs.buildwithfern.com/29e47533b9c29b92cf693788c2d278d639a76e79624ace5f698b072c0eec2401/images/generated-diagrams/pay-in-transaction-cancel-flowchart.svg" width="600px" height=" " />
</Frame>

### Void

A void cancels an existing sale or captured authorization. Voiding non-captured authorizations prevents future captures. You can void unsettled transactions. If a transaction has been settled, refund it instead.

### Refund

A Refund sends money back to the accountholder after transaction has been settled. If a transaction hasn't been settled, void it instead.

### Reversal

A reversal allows you to either refund or void a transaction without knowing the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. Reverse lets you integrate a single function for transaction cancellations and has Payabli dynamically handle the logic.

## Path parameters

When canceling a transaction via the API, you always need the `transId`, which is the `referenceId` for the transaction. For refunds and reversals, you also need the `amount` to refund.

<ParamField path="transId" type="string" required>
  *Required for voids, refunds, and reversals*

  The referenceId identifying the transaction (PaymentId). You can find this in the success response for the payment you want to void.
</ParamField>

<ParamField path="amount" type="double">
  *Required for refunds and reversals*

  The amount to refund from the original transaction, minus any service fee charged on the original transaction. This amount can't be greater than the original total amount of the transaction minus the service fee. For example, if a transaction was \$90 plus a \$10 service fee, you can refund up to \$90. Set the amount to 0 (zero) to refund the total amount of the transaction minus any service fee.
</ParamField>

## Void a transaction

You can void transactions that haven't settled yet.

This example voids the transaction with a `referenceId` of `10-3ffa27df-b171-44e0-b251-e95fbfc7a723`:

<Tabs>
  <Tab title="v1 API example">
    <EndpointRequestSnippet endpoint="GET /MoneyIn/void/{transId}" example="Void" />
  </Tab>

  <Tab title="v2 API example">
    <EndpointRequestSnippet endpoint="POST /v2/MoneyIn/void/{transId}" example="VoidTransaction" />
  </Tab>
</Tabs>

A successful void returns a 200 status and `isSuccess` set to `true`. If you try to void a transaction that has already been voided, the API returns a 400 status with "Invalid TransStatus" in the response text.

<Tabs>
  <Tab title="Successful void response (v1 API)">
    <EndpointResponseSnippet endpoint="GET /MoneyIn/void/{transId}" example="Void" />
  </Tab>

  <Tab title="Successful void response (v2 API)">
    <EndpointResponseSnippet endpoint="POST /v2/MoneyIn/void/{transId}" example="VoidTransaction" />
  </Tab>

  <Tab title="Invalid TransStatus response">
    ```json Invalid TransStatus response
    {
      "responseText": "Declined: Invalid TransStatus",
    }
    ```
  </Tab>
</Tabs>

## Refund a transaction

You can refund settled transactions. If you use the Enhanced Refund Flow, see [the guide](/guides/pay-in-refunds-enhanced-flow-overview) for information about how refunds are handled in different scenarios.

Tab through to see examples of full and partial refunds using both the v1 and v2 APIs.

<Tabs>
  <Tab title="Full refund (v1 API)">
    This example refunds the transaction with a `referenceId` of `10-3ffa27df-b171-44e0-b251-e95fbfc7a723` for the total amount of the transaction.

    <EndpointRequestSnippet endpoint="GET /MoneyIn/refund/{transId}/{amount}" example="Initiated" />
  </Tab>

  <Tab title="Partial refund (v1 API)">
    This example refunds a partial amount of \$100.99 of the transaction with a `referenceId` of `10-3ffa27df-b171-44e0-b251-e95fbfc7a723`.

    <EndpointRequestSnippet endpoint="GET /MoneyIn/refund/{transId}/{amount}" example="Captured" />
  </Tab>

  <Tab title="Full refund (v2 API)">
    This example refunds the transaction with a `referenceId` of `10-3ffa27df-b171-44e0-b251-e95fbfc7a723` for the total amount of the transaction.

    <EndpointRequestSnippet endpoint="POST /v2/MoneyIn/refund/{transId}" example="FullRefundNoAmount" />
  </Tab>

  <Tab title="Partial refund (v2 API)">
    This example refunds a partial amount of \$100.99 of the transaction with a `referenceId` of `10-3ffa27df-b171-44e0-b251-e95fbfc7a723`.

    <EndpointRequestSnippet endpoint="POST /v2/MoneyIn/refund/{transId}/{amount}" example="RefundAmount" />
  </Tab>
</Tabs>

A successful refund returns a 200 status with a JSON body.

<Tabs>
  <Tab title="Full refund (v1 API)">
    This example shows a successful refund response for a full refund. The `resultText` value is "INITIATED" for refunds that have been initiated but not yet completed. This response is only returned in accounts with the Enhanced Refund Flow enabled.

    <EndpointResponseSnippet endpoint="GET /MoneyIn/refund/{transId}/{amount}" example="Initiated" />
  </Tab>

  <Tab title="Partial refund (v1 API)">
    This example shows a successful refund response for a partial refund. The `resultText` value is "CAPTURED".

    <EndpointResponseSnippet endpoint="GET /MoneyIn/refund/{transId}/{amount}" example="Captured" />
  </Tab>

  <Tab title="Full refund (v2 API)">
    This example shows a successful refund response for a full refund.

    <EndpointResponseSnippet endpoint="POST /v2/MoneyIn/refund/{transId}" example="FullRefundNoAmount" />
  </Tab>

  <Tab title="Partial refund (v2 API)">
    This example shows a successful refund response for a partial refund.

    <EndpointResponseSnippet endpoint="POST /v2/MoneyIn/refund/{transId}/{amount}" example="RefundAmount" />
  </Tab>
</Tabs>

<Tip>
  Just like sale transactions, you can void a refund transaction before the batch closes. Use the `referenceId` from the refund transaction response as the `transId` in the void request.
</Tip>

## Reverse a transaction

You can use reversal to either refund or void a transaction without knowing the transaction's settlement status. See the [API reference](/developers/api-reference/moneyin/reverse-a-transaction) for this endpoint.

Because reversing a transaction either voids or refunds it, keep these points in mind when creating requests:

* If a transaction isn't settled, the reversal request is treated as a void. Only full voids supported. Partial voids aren't supported.
* If a transaction is settled, the reversal request is treated as a refund. Both full and partial refunds are supported. Payabli refunds the amount passed in the request.
* There isn't a v2 version of the reverse endpoint as there is with void and refund. Use the v1 endpoint for reversals.

When using the `api/MoneyIn/reverse/` endpoint, the transaction's batch status determines how your reversal request is processed:

| Batch Status     | Reversal Type | How it's Treated            | Result                     |
| ---------------- | ------------- | --------------------------- | -------------------------- |
| Open             | Full          | Processed as Void           | ✓ Success                  |
| Open             | Partial       | Attempted as Partial Void   | ✗ Rejected (not supported) |
| Closed (Settled) | Full          | Processed as Full Refund    | ✓ Success                  |
| Closed (Settled) | Partial       | Processed as Partial Refund | ✓ Success                  |

These examples show how to reverse a transaction.

<Tabs>
  <Tab title="Full reversal">
    This example will refund the transaction with a `referenceId` of `10-3ffa27df-b171-44e0-b251-e95fbfc7a723` for the total amount of the transaction, if the transaction is settled. If the transaction isn't settled, it voids the transaction.

    <EndpointRequestSnippet endpoint="GET /MoneyIn/reverse/{transId}/{amount}" example="Void" />
  </Tab>

  <Tab title="Partial reversal">
    This example refunds \$53.76 of the transaction with a `referenceId` of `10-3ffa27df-b171-44e0-b251-e95fbfc7a723`, if the transaction is settled. If the transaction isn't settled, it reverses \$53.76 of the original authorized amount, and captures the rest.

    <EndpointRequestSnippet endpoint="GET /MoneyIn/reverse/{transId}/{amount}" example="Refund" />
  </Tab>
</Tabs>

A successful reverse returns a 200 status with a JSON body. You can tell whether the operation was a refund or a void based on the `resultText` value. A "REVERSED" value means the operation was a void. A "CAPTURED" value means that the operation was a refund.

<Tabs>
  <Tab title="Void Response">
    <EndpointResponseSnippet endpoint="GET /MoneyIn/reverse/{transId}/{amount}" example="Void" />
  </Tab>

  <Tab title="Refund Response">
    <EndpointResponseSnippet endpoint="GET /MoneyIn/reverse/{transId}/{amount}" example="Refund" />
  </Tab>
</Tabs>

## Related resources

See these related resources to help you get the most out of Payabli.

<AccordionGroup>
  <Accordion title="Prerequisites">
    * **[Make a sale transaction](/guides/pay-in-developer-transactions-create)** - You need to make a transaction before voiding or refunding it
  </Accordion>

  <Accordion title="References">
    * **[Pay In schemas](/guides/pay-in-schemas-overview)** - Learn about Pay In (money in) transaction schemas
    * **[Pay In statuses](/guides/pay-in-status-reference)** - Learn about Pay In (money in) statuses
  </Accordion>

  <Accordion title="Related topics">
    * **[Void API (v2)](/developers/api-reference/moneyinV2/void-a-transaction)** - API reference for v2 of the void a transaction endpoint
    * **[Refund API (v2)](/developers/api-reference/moneyinV2/refund-a-settled-transaction)** - API reference for v2 of the refund a settled transaction endpoint
    * **[Refund split transaction](/developers/api-reference/moneyin/refund-a-settled-transaction-with-instructions)** - API reference for refunding a split transaction with instructions
  </Accordion>
</AccordionGroup>