⌘K

Comprovante (PDF)

Baixe o comprovante de um pagamento de boleto em formato PDF, retornado em base64.

O campo pdf do response contém o arquivo em base64. Decodifique o conteúdo e salve com a extensão .pdf para obter o comprovante. Ex. em Node.js: fs.writeFileSync("comprovante.pdf", Buffer.from(data.pdf, "base64")).

GET/api/v2/billets/payments/receipt/{id}

Retorna o comprovante em PDF (base64) de um pagamento de boleto. Requer o escopo billets.read.

Base URL: https://pagamentos.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2 (escopo billets.read)

Parametros de Rota

Nome	Tipo	Descricao
`id`	integer	Identificador do pagamento, retornado na criação do pagamento.

Exemplo de Response

{
  "data": {
    "pdf": "JVBERi0xLjQK..."
  }
}

Exemplos de Codigo

curl -X GET https://pagamentos.basspago.com.br/api/v2/billets/payments/receipt/776543210 \
  --cert ./client.crt \
  --key ./client.key \
  -H "Authorization: Bearer {access_token}"

Erros

Código	Descrição
`401`	Token de acesso inválido ou expirado.
`403`	Sem permissão para executar a operação (escopo billets.read ausente).
`404`	Pagamento não encontrado ou comprovante indisponível.