---
title: "Request payout transaction cancellation"
method: DELETE
path: "/payout/{user_token}/{payout_token}"
tags: ["Payout"]
---

# Request payout transaction cancellation

`DELETE /payout/{user_token}/{payout_token}`

## Request

- Base URL: `https://api.masspay.io/v1.0.0`
- URL: `https://api.masspay.io/v1.0.0/payout/{user_token}/{payout_token}`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/masspay/apis/masspay-api/docs/payout/:user_token/:payout_token/delete.ts> (a function with typed inputs; its response is checked against the schema)

This **DELETE** endpoint allows you to request the cancellation of a previously created payout transaction.<br>Once a payout has been committed, you can use this endpoint to submit a cancellation request.<br>**Note:** Submitting a cancellation request does not guarantee that the payout will be successfully cancelled.<br>To use this endpoint, provide the `user_token` and `payout_token` of the payout transaction you wish to cancel in the URL path.<br>The response returns a JSON object containing details about the cancellation request, including the `payout_token`, `cancelation_status`, `confirmation_code`, and any potential errors.

## Path parameters

- `user_token` string, required
- `payout_token` string, required

## Query parameters

- `cancellation_reason` string

## Headers

- `Idempotency-Key` string

## Response `200`

successful operation

- object
  - `payout_token` string, required: Payout token that was attempted to be cancelled
  - `cancellation_status` 'CANCELLED' | 'CANCELLATION_REQUESTED' | 'CANCELLATION_FAILED', required: The status of the cancellation attempt:<br> `CANCELLED` - The payout was successfully cancelled. Funds have not been released or were successfully reversed.<br> `CANCELLATION_REQUESTED` - The request to cancel has been accepted and is being processed, but the final outcome is not yet confirmed.<br> `CANCELLATION_FAILED` - The payout cannot be cancelled because it has already been processed, fully paid, or settled. (see [Payout Reversals](ref:initiatePayoutReversal))
  - `cancellation_status_reason` string: When available, provide additional information about the status
  - `confirmation_code` string: If a cancellation request was successfully submitted, the request confirmation code would be returned

## Other responses

- `400`: Bad request.
- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Not found.
- `405`: Method Not Allowed.
- `500`: Internal server error.
- `504`: Gateway Time-out.

## Changes

- **2026-11-03** `f9fa41b7c45c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/masspay/apis/masspay-api/changes/payout/:user_token/:payout_token/delete.md)

---

[API](https://skmtc.dev/masspay/apis/masspay-api.md) - [All operations](https://skmtc.dev/masspay/apis/masspay-api/llms.txt) - [OpenAPI document](https://skmtc.dev/masspay/apis/masspay-api/revisions/f9fa41b7c45c?raw)