Skip to main content
Após emitir um boleto, você pode alterar sua data de vencimento, cancelar/baixar a cobrança ou gerar o PDF para envio ao pagador.

Alterar data de vencimento

Use PATCH /baas/v1/charges/:correlationId para atualizar a data de vencimento de um boleto pendente. Somente o campo dueDate pode ser alterado.
A resposta de sucesso retorna 200 OK com o corpo vazio (text/plain). O boleto continua com o mesmo correlationId, ourNumber e código de barras — apenas o vencimento muda.
Só é possível alterar o vencimento de boletos com status Pending. Boletos expirados, pagos ou cancelados não podem ser modificados.

Baixar e cancelar boleto

Use PUT /baas/v1/charges/:correlationId/closeout para baixar (cancelar) um boleto. Após a baixa, o boleto não pode mais ser pago.
A resposta de sucesso retorna 200 OK. Após a baixa, o status do boleto passa para Cancelled.
A baixa não cancela um pagamento já realizado. Se o boleto foi pago antes da solicitação de baixa, o pagamento permanece registrado normalmente.

Gerar PDF do boleto

Use GET /baas/v1/charges/:correlationId/stream para obter o boleto em formato PDF. A resposta é um stream binário com Content-Type: application/pdf.
cURL
O PDF gerado contém o código de barras e, para BANKSLIP_PIX, também o QR Code Pix impresso no documento.

Exemplo em código

Node.js

Referência da API

Atualizar boleto

PATCH /baas/v1/charges/:correlationId

Cancelar boleto

PUT /baas/v1/charges/:correlationId/closeout

Imprimir PDF

GET /baas/v1/charges/:correlationId/stream