---
title: "Cancel a scheduled/recurring batch"
method: POST
path: "/v1/payout/{batch_id}/cancel-batch"
tags: ["Mass payouts"]
---

# Cancel a scheduled/recurring batch

`POST /v1/payout/{batch_id}/cancel-batch`

## Request

- Base URL: `https://api.nowpayments.io`
- URL: `https://api.nowpayments.io/v1/payout/{batch_id}/cancel-batch`
- Auth: none declared
- TypeScript: <https://skmtc.dev/nowpayments/apis/np-open-api/docs/v1/payout/:batch_id/cancel-batch/post.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows you to cancel an entire recurring payout batch.

Once canceled:

- No new payouts will be generated within the batch
    
- Existing payouts that have not yet been processed will be canceled
    
- The batch status will be updated accordingly
    

**Params:**

**batch_id** (required) - the unique identifier of the payout batch you want to cancel.

## Headers

- `x-api-key` string

## Response `default`

200

---

[API](https://skmtc.dev/nowpayments/apis/np-open-api.md) - [All operations](https://skmtc.dev/nowpayments/apis/np-open-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nowpayments/apis/np-open-api/revisions/32c28317af15?raw)