Carta de Cancelamento de Transação

Gerar carta de cancelamento

get

https://api.barte.comhttps://sandbox-api.barte.com

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

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)

Authorizations

ApiKeyAuth

X-Token-ApistringRequired

Path parameters

chargeUuidstring · uuidRequired

Identificador único da cobrança

Query parameters

downloadbooleanOptional

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

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

Default: false

Header parameters

X-Token-Apistring · uuidRequired

Token de autenticação do vendedor

Content-Typestring · enumRequired

Tipo de conteúdo da requisição

Possible values:

Responses

200

Carta de cancelamento gerada com sucesso

application/json

messagestringOptional

Mensagem de sucesso da geração do comprovante

Example: Comprovante gerado com sucesso

urlstring · uriOptional

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

Example: https://cancellation-letter.s3.amazonaws.com/carta_cancelamento_pre_authorizacao_586bef82-6799-4ab0-ac24-0b1d971ef474.pdf

expiresInSecondsintegerOptional

Tempo de expiração da URL em segundos

Example: 86400

400

Erro na requisição

application/json

401

Não autorizado

application/json

403

Acesso negado

application/json

404

Cobrança não encontrada

application/json

422

Status inválido da cobrança

application/json

500

Erro interno do servidor

application/json

get/v2/charges/{chargeUuid}/cancellation-letter

HTTPcURLJavaScriptPython

GET /v2/charges/{chargeUuid}/cancellation-letter HTTP/1.1
Host: api.barte.com
X-Token-Api: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*

{
  "message": "Comprovante gerado com sucesso",
  "url": "https://cancellation-letter.s3.amazonaws.com/carta_cancelamento_pre_authorizacao_586bef82-6799-4ab0-ac24-0b1d971ef474.pdf?AWSAccessKeyId=ASIA5FTZCU5NKHFFOD6O&Signature=1GNNjZ986hTGeuzRcuyVVXdP5uA%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEPT%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJIMEYCIQC6QCW3ib%2B7QKJLkd%2F3VkzgD8sjWlZ1J0Ah1tVccPZEPQIhAJQwXtCHeqc%2BEn6qw18yIlNICC1Rs26G9Zcr%2BQNElMsPKvMCCL3%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQABoMOTA1NDE4Mjg2OTM4IgxfjJae8JwvjExqCZYqxwJkRP4dP%2F7Vj3YCPOfODcO0mg8xwjRZYLxBGMiaEFkDCD9Hs%2BCis4GmDbaabglsJwRRhCplGp8wOpEwP%2FzLFh2TipbYGw7M51ivZiieLHZsxt7ikR2vQSpJ6XcCY4QbkfpyYYTLtV00%2ByvO2BcDY4t98mBw63WkA4Y0x6eVy6GFg%2But6lS3qfw3bGkn6hHl0JZD9eFIA4Wwo1TFdCH%2B6LAIvZ0r4pugIUlLtE5Vk7XLvTu5QPHbPmWYlVuSlVO78RkCgSOCG7Ogy468pA9UBGAGnM9ARqdNQyv3WK%2Fe3ZZKQ5A6iiFAOMH9iPMPLVee1lJ2JZ3F26EiY6DX9QIRWhXi05uyQd8katJhBPXOaVEM3p7Z%2FZcYFm9YyVvocjaDPE8dT20vGjRTIUxSUucTlRlATO%2F78lqMyQTGjVAr9Ydj0SVzZqJM2gQwr56izQY6nQFxp8v5tB3KythvEKDy9CbAOPzEogfU5fnsZTm9nHsB%2B%2BMjAVeUONo1T89edIilV956N2CQxG9afSYtrF4C%2FAVM0nF3mKxr8MAi7162MITgDvAWvT%2Fie0zfIDo6TBwYCOsV8IDtpEiCRcSUyFbw4g3prRuoC2tvGv33wZcQ0ecMxv0oYox8%2FU1chbOv1deEGXVGXF9lcavHrjaq21th&Expires=1772741496",
  "expiresInSeconds": 86400
}