These docs are for v1.2. Click to read the latest docs for v1.4.

Listar boletos

Fala, desenvolvedor! Nessa seção vou mostrar como você lista os boletos que foram criados!

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

Para que possamos ver quais são os boletos que constam em uma conta, basta:

  • Configurar o Authorization para utilizar o nosso Access Token válido como bearer token.
  • Realizar uma requisição GET para o endpoint https://api.empresas.btgpactual.com/v1/bank-slips e como query params utilizar o accountId da conta que desejamos consultar.

GetBoleto-1

Após realizar essa requisição, nos será retornado um JSON extenso contendo um objeto data e dentro deles encontraremos todos os boletos que existem:

GetBoleto-2

Testando com o status

Podemos, inclusive, realizar um teste para ver se está tudo funcionando normalmente: Cancelar este boleto recém criado que está listado acima, repetir a requisição e checar se o status foi alterado. Para mais instruções sobre esse processo, visite nossa seção Cancelando boletos

GetBoleto-3

Veja como o status mudou de acordo com a operação que realizamos!


Postman

Temos uma collection do postman com todas as requests mais utilizadas e demandadas pelos nossos clientes. Para encontra-lá basta visitar nossa página Postman Collections