Detalhes de um Boleto

GET/api/billissuer/information?accountNumber={accountNumber}&id_bill={id_bill}

Este endpoint é utilizado para consultar os detalhes de um boleto, retornando informações completas sobre ele, como valor, status, dados do pagador e histórico de pagamento.

Este método recebe os identificadores de conta e boleto e retorna os dados detalhados.

Requisição

{
  "accountNumber": "long",
  "id": "string"
}

Dicionário de dados - Parâmetros

Exemplo de requisição

curl --request GET \
  --url 'https://integration.enoqbank.com/enoq/api/billissuer/information?accountNumber={accountNumber}&id_bill={id_bill}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json'

Retorno (200)

Exemplo de resposta

{
  "id": "00000000-0000-0000-0000-000000000000",
  "value": 0.00,
  "issueDate": "2023-01-01",
  "dueDate": "2023-01-01",
  "payerDocument": "string",
  "payerName": "string",
  "payerStreetAndNumber": "string",
  "payerZipCode": "string",
  "payerCity": "string",
  "payerCityState": "string",
  "payerNeighborhood": "string",
  "payerPhoneNumber": "string",
  "effectivePaymentDate": "2023-01-01",
  "effectiveCreditDate": "2023-01-01",
  "effectivePaymentValue": 0,
  "barCode": null,
  "digitableLine": null,
  "pixEmv": null,
  "status": 1,
  "success": true,
  "message": "string"
}

Dicionário de dados

Recorrência

As consultas podem ser realizadas a qualquer momento.

Informações Adicionais

As consultas podem ser realizadas a qualquer momento.

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Observado em homologação

Requisição sem o header Authorization. A camada de autenticação pode rejeitar a chamada antes de resolver a rota ou validar os dados.

HTTP/1.1 401 Unauthorized

A resposta não possui corpo. Não há campos JSON para interpretar neste cenário.