Impressão de boleto
stable
Este endpoint permite que o parceiro solicite o boleto do Bankly em formato PDF, contendo todas as informações necessárias para o pagamento, como o código de barras.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O boleto já tenha sido registrado (status "Registered").
Requisição (Request)
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/bankslip/{{authenticationCode}}/pdf
--request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/bankslip/authenticationCode/pdf' \
--header 'Authorization: Bearer {{Token}}' \
--header 'accept: application/json' \
--header 'api-version: 2.0'
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 2.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 em 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 | Mensagem | Descrição |
|---|---|---|---|
| 400 | BANKSLIP_INVALID_STATUS_OPERATION | Invalid bankslip status to perform this operation. | O boleto está com o status “Processed”. Dessa forma, não é possível realizar a sua impressão. |
Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400.
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated about 1 month ago