Impressão de boleto

Pré-requisito

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

O boleto já tenha sido registrado (status "Pending").

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/boletos/printWithLogo/{{authenticationCode}}/{{accountBranch}}/{{accountNumber}}

--request GET 'https://sandbox.hiperbanco.com.br/boletos/printWithLogo/{{authenticationCode}}/{{accountBranch}}/{{accountNumber}}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
version	cutting-edge	Essa propriedade garante que o response da API seja retornado no formato JSON
Authorization	Bearer token	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
accountBranch	path	Número da agência ao qual a conta do beneficiário final do boleto pertence.
accountNumber	path	Número da conta do beneficiário final do boleto.
authenticationCode	path	Identificador único do boleto, retornado no endpoint de emissão de boletos.

⚠️
Importante
Os campos accountBranch e accountNumber devem ser preenchidos com as informações da conta logada.

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 Hiperbanco foi disponibilizado com sucesso.

⚠️
Importante
Para que o boleto seja emitido com seu logotipo, a logotipo deverá ser enviado ao Hiperbanco no formato SVG.

Boleto personalizado

Não oferecemos um serviço para upload de layout personalizado. Portanto, caso deseje um boleto personalizado, é 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 Hiperbanco para aprovação.

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 “Processing”. 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 que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.