v1

latestOpenAPI 3.0.02026-07-2340101105.4 KB
Charges

Gerar carta de cancelamento

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)
get/v2/charges/{chargeUuid}/cancellation-letter

Path parameters

chargeUuidstring uuid required

Identificador único da cobrança

Query parameters

downloadboolean

Define se o PDF deve ser baixado automaticamente ou apenas visualizado no navegador.

  • true: baixar automaticamente
  • false: abrir no navegador (padrão)

Headers

X-Token-Apistring uuid required

Token de autenticação do vendedor

Content-Type'application/json' required

Tipo de conteúdo da requisição

Response

Carta de cancelamento gerada com sucesso

messagestring

Mensagem de sucesso da geração do comprovante

urlstring uri

URL temporária para acesso ao PDF da carta de cancelamento

expiresInSecondsinteger

Tempo de expiração da URL em segundos