Consulta status do boleto

Pré-requisito

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

O boleto tenha sido emitido com sucesso.

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/boletos/getAuthCode/{{issueId}}

--request GET 'https://sandbox.hiperbanco.com.br/boletos/getAuthCode/{{issueId}}' \
--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
issueId	path	Identificador único da solicitação de emissão do boleto

Corpo da requisição (Body)

Não é necessário enviar parâmetros no body desta requisição.

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita com sucesso e trará um objeto contendo as informações do boleto.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
id	string	Identificador único do item ou da requisição.
boleto	objeto	Objeto contendo as informações do boleto.
boleto.authentication_code	string	Código de autenticação do boleto.
boleto.status	string	Status atual do boleto, sendo Pending "Disponivel para Pagamento / Impressão em PDF", Failure "Ocorreu uma falha na emissão do boleto" e Processing "Boleto está em processamento"
boleto.reasons	null	Motivos associados ao status Failure "Esta propriedade irá retornar os motivos pelo qual a emissão do boleto falhou".

⚠️
Importante

O authentication_code retornará apenas se o status do boleto for Pending

O boleto só estará disponível para impressão em PDF / Pagamento quando o status do mesmo for Pending

[
    {
        "id": "f7e8f431-3eeb-44ca-947c-e7b7f0f3dede",
        "boleto": {
            "authentication_code": "928f3021-b377-4acb-898f-aa54792c6185",
            "status": "Pending",
            "reasons": null
        }
    }
]

[
  {
    "id": "ae518747-d422-4e51-b9e3-ee4882e9f4eb",
    "boleto": {
      "authentication_code": null,
      "status": "Failure",
      "reasons": "Maximum quantity limit per month exceeded"
    }
  }
]

Status do boleto

Status	Descrição
Failure	Falha na geração do boleto.
Processing	Pagamento do boleto está sendo processado.
Pending	Boleto gerado, aguardando pagamento.
Approved	Pagamento do boleto foi aprovado.
Paid	Boleto foi pago com sucesso.
Expired	Boleto expirou sem pagamento.
Cancelled	Boleto foi cancelado manual .
Overdue	Boleto está vencido e ainda não foi pago.

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.