Obtendo o pdf de um boleto

Suggest Edits

🚧

Sandbox

No momento, nós trabalhamos em expandir as funcionalidades do ambiente de sandbox para melhor refletir as funcionalidades do ambiente de produção. Por conta disso, desabilitamos a funcionalidade de obtenção de PDF em sandbox.

Reiteramos que a funcionalidade no ambiente de produção está operando normalmente.

A obtenção do pdf de um boleto em produção passa por um processo similar ao de listagem de boletos, e nesta seção iremos fazer um passo a passo explicando como fazer isso!

Essa é um request realizada utilizando o accountId, portanto, todos os dados são atrelados à conta referente ao accountId.

Para obter o pdf de um boleto, primeiro precisamos algum id específico e único ao boleto que queremos gerar o pdf. Esse Id pode ser:

  • bankSlipId
  • digitableLine
  • barcode

Sabendo um desses dados, nós podemos listar um boleto assim como fazemos em Listar boletos, porém realizando algumas modificações:

  • Ao realizar a chamada para o endpoint https://api.empresas.btgpactual.com/v1/bank-slips?accountId=SEU_ACCOUNT_ID nós adicionamos o dado que temos do boleto, como por exemplo https://api.empresas.btgpactual.com/v1/bank-slips?accountId=SEU_ACCOUNT_ID&bankSlipId=BANKSLIPID_DO_SEU_BOLETO
  • No header da requisição, devemos passar obrigatóriamente accept: application/pdf. Esta é a informação que dirá ao nosso sistema para gerar o pdf. Caso ela não seja passada, o retorno será um json similar ao que mostramos em Listar boletos:

Se realizarmos o processo da forma correta, receberemos um boleto em formato pdf no layout do BTG Pactual Empresas, similiar ao modelo de boleto abaixo com os dados do seu boleto:

Updated 15 days ago