---
title: "Gerar carta de cancelamento"
method: GET
path: "/v2/charges/{chargeUuid}/cancellation-letter"
tags: ["Charges"]
---

# Gerar carta de cancelamento

`GET /v2/charges/{chargeUuid}/cancellation-letter`

## Request

- Base URL: `https://api.barte.com`
- URL: `https://api.barte.com/v2/charges/{chargeUuid}/cancellation-letter`
- Auth: API key in header `X-Token-Api`
- TypeScript: <https://skmtc.dev/barte/apis/api-de-sellers-v2-atualizada/docs/v2/charges/:chargeUuid/cancellation-letter/get.ts> (a function with typed inputs; its response is checked against the schema)

Gera a carta de cancelamento de uma cobrança específica.

O parâmetro `download` controla o comportamento do PDF:
- Se `download=true`: ao clicar na URL, o PDF é baixado automaticamente
- Se `download=false`: ao clicar na URL, o PDF abre no navegador (sem download automático)

## Path parameters

- `chargeUuid` string, uuid, required

## Query parameters

- `download` boolean

## Headers

- `X-Token-Api` string, uuid, required
- `Content-Type` 'application/json', required

## Response `200`

Carta de cancelamento gerada com sucesso

- CancellationLetterResponse
  - `message` string: Mensagem de sucesso da geração do comprovante
  - `url` string, uri: URL temporária para acesso ao PDF da carta de cancelamento
  - `expiresInSeconds` integer: Tempo de expiração da URL em segundos

## Other responses

- `400`: Erro na requisição
- `401`: Não autorizado
- `403`: Acesso negado
- `404`: Cobrança não encontrada
- `422`: Status inválido da cobrança
- `500`: Erro interno do servidor

---

[API](https://skmtc.dev/barte/apis/api-de-sellers-v2-atualizada.md) - [All operations](https://skmtc.dev/barte/apis/api-de-sellers-v2-atualizada/llms.txt) - [OpenAPI document](https://skmtc.dev/barte/apis/api-de-sellers-v2-atualizada/revisions/f0dd55b167f1?raw)