Impressão de boleto

Este endpoint permite que o parceiro obtenha o boleto do Bankly, contendo todas as informações necessárias para o pagamento, como o código de barras.

Após realizar o download do boleto, o parceiro poderá realizar modificações no layout ou substituir a logo do Bankly, caso seja deseje.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

O boleto já tenha sido registrado (status Registered).

Requisição

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/bankslip/{{authenticationCode}}/pdf

--location --request GET 'https://api-mtls.sandbox.bankly.com.br/bankslip/{{authenticationCode}}/pdf' \  
--header 'api-version: 1.0' \  
--header 'Authorization: Bearer {{accessToken}}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.

Esta requisição requer o scope descrito a seguir:

Scope	Descrição
`boleto.read`	Concede acesso para imprimir um boleto.

Cabeçalhos (Headers)

Nome	Descrição
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Nome	Tipo	Descrição
`authenticationCode`	`path`	Identificador único do boleto retornado na sua emissão.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará que o arquivo PDF com o boleto Bankly foi disponibilizado com sucesso.

Boleto personalizado

Não oferecemos um serviço para upload de layout personalizado. Portanto, caso deseje que o boleto tenha sua marca, é necessário que ele seja gerado pelo próprio parceiro, considerando os dados obtidos na consulta.

🚧
Importante
O layout personalizado pelo parceiro deve seguir as orientações da Febraban.

Após estruturar o modelo de boleto, o parceiro deve enviá-lo ao time de Implantação do Bankly para aprovação.

👍
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status code	Código	Descrição
400	BANKSLIP_STATUS_SITUATION	O boleto ainda não se encontra registrado.
404	BANKSLIP_NOT_FOUND	Não foi localizado um boleto com o `authenticationCode` informado.

Válido lembrar que a API também poderá retornar erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.