Meu primeiro boleto

Fala, desenvolvedor! Dessa vez vou te mostrar como criar o seu primeiro boleto de cobrança.

Escopos

Para a emissão de um boleto, precisamos saber quais são os escopos necessários. Essas informações podem ser encontradas na nossa página sobre Boletos. Neste caso, precisamos dos escopos openid, empresas.btgpactual.com/bank-slips e empresas.btgpactual.com/accounts

Depois de marcarmos os escopos e salvarmos as alterações, devemos obter o Access Token por meio do Authorization Code Flow . Caso não saiba como fazer, temos um tutorial sobre como gerá-lo.

Campo accountId

Após obter o Access Token, ainda precisamos de um dado chamado accountId para conseguir emitir um boleto. Este dado é referente à CONTA que concedeu ACESSOS no FLUXO do AUTHORIZATION CODE.

Para obtê-lo, basta Listar contas que concederam acesso e na response você encontrará, dentre outros dados, o accountId

Emitindo o boleto

Agora que temos em mãos o Access Token com as permissões necessárias e o accountId que nós concedeu as permissões, podemos emitir nosso primeiro boleto!

Para emitir o boleto, precisamos fazer uma requisição POST no endpoint https://api.empresas.btgpactual.com/v1/bank-slips enviando em authorization nosso Access Token e como query params o nosso accountId:

Precisamos também enviar no Body da request as informações obrigatórias que um boleto exige, conforme a API Reference:

Esse é minimo de informações necessários para emitir um boleto. Caso queira apenas copiar e colar para realizar seus testes:

{
      "payer": {
        "name": "Gabriel",
        "taxId": "00000000000"
      },
      "referenceNumber": "00",
      "amount": 1,
      "dueDate": "2024-09-19",
      "installments": 1
}

Na página de boletos da API Reference eu explico o que é cada um dos campos e suas particularidades. A leitura desta página é extremamente importante para quando for emitir um boleto no ambiente de produção!

A response da request é a seguinte:

O campo status indica qual a situação do boleto no seu processo de criação. Para saber mais sobre os status e seus significados, visite Boletos.

E assim, emitimos o nosso primeiro boleto!

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