---
title: "Cancelar lote de pagamento"
method: POST
path: "/{companyId}/banking/payroll/payments/{requestId}/cancel"
tags: ["Pagamentos"]
---

# Cancelar lote de pagamento

`POST /{companyId}/banking/payroll/payments/{requestId}/cancel`

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/{companyId}/banking/payroll/payments/{requestId}/cancel`
- Auth: OAuth 2
  - Authorization code: `https://id.empresas.btgpactual.com/oauth2/authorize`
  - Token URL: `https://id.empresas.btgpactual.com/oauth2/token` scopes: `brn:btg:empresas:banking:payroll`

Cancela um lote de pagamento identificado pelo `requestId`. Somente lotes nos status `submitted` ou `pending_approval` podem ser cancelados.

## Path parameters

- `companyId` string, required
- `requestId` string, required

## Request body

- CancelPaymentRequest
  - `reason` string, nullable

## Response `200`

OK

---

[API](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos.md) - [All operations](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/llms.txt) - [OpenAPI document](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/revisions/2a24d3da114c?raw)
