Cobranças

PDF do boleto

GET/v1/charges/:chargeId/boleto.pdf
Base URL Produção:https://api.validapay.com.br
Base URL Sandbox:https://sandbox.validapay.com.br

Path Parameters

chargeIdstringobrigatório
Identificador devolvido na criação da cobrança

Baixa o PDF do boleto. Rota pública: não envie Authorization. É o endereço que a API devolve em pdfUrl ao criar um boleto, e pode ser aberto direto pelo pagador.

Responde o binário do PDF com Content-Type: application/pdf, exibido no navegador. Para forçar o download, acrescente ?download=1.

O arquivo é gerado na criação da cobrança, mas não depende disso: se ele não estiver armazenado, a rota o regenera na hora e devolve normalmente. Só responde 404 BOLETO_PDF_NOT_AVAILABLE quando nem a regeneração é possível.

Cobrança que não é boleto responde 400 CHARGE_NOT_BOLETO.

Query Parameters

downloadopcional
1 ou true força o download em vez de exibir no navegador
1
const url = 'https://sandbox.validapay.com.br/v1/charges/:chargeId/boleto.pdf?download=1?download=1';

const options = {
  method: 'GET',
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

400400 Cobrança não é boleto
JSON
{
  "error": {
    "message": "Cobranca nao e do tipo boleto",
    "code": "CHARGE_NOT_BOLETO",
    "details": null,
    "timestamp": "2026-09-14T18:20:00.000Z"
  }
}
404404 PDF indisponível
JSON
{
  "error": {
    "message": "PDF do boleto nao disponivel",
    "code": "BOLETO_PDF_NOT_AVAILABLE",
    "details": null,
    "timestamp": "2026-09-14T18:20:00.000Z"
  }
}