Obter o PDF do Boleto

GET/api/billissuer/pdf?accountNumber={accountNumber}&id_bill={id_bill}

Este endpoint é utilizado para obter o PDF de um boleto pronto para impressão. O PDF é retornado em formato base64, podendo ser facilmente convertido para visualização ou armazenamento.

Recebe o identificador único de um boleto e retorna o PDF correspondente.

Requisição

{
  "accountNumber": "long",
  "id": "string"
}

Dicionário de dados - Parâmetros

Exemplo de requisição

curl --request GET \
  --url 'https://integration.enoqbank.com/enoq/api/billissuer/pdf?accountNumber={accountNumber}&id_bill={id_bill}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json'

Retorno (200)

Exemplo de resposta

{
  "id": "string",
  "pdfBytes": "JVBERi0xLjQK[...]adsfasd"
}

Dicionário de dados

Recorrência

As consultas podem ser realizadas a qualquer momento.

Informações Adicionais

O base64 poderá ser transformado em PDF na aplicação e o boleto já estará pronto para visualização.

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Observado em homologação

Requisição sem o header Authorization. A camada de autenticação pode rejeitar a chamada antes de resolver a rota ou validar os dados.

HTTP/1.1 401 Unauthorized

A resposta não possui corpo. Não há campos JSON para interpretar neste cenário.