Listar Boleto por Data de Pagamento

GET/api/billissuer/list/by/payment-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}

Utilizado para listar boletos por data de pagamento.

O método recebe um período inicial e um período final de data de pagamento e retorna uma lista de boletos com status 3 (Recebido), compreendidos entre (inclusive) as datas informadas.

Dicionário de dados - Parâmetros

Exemplo de requisição

curl --request GET \
  --url 'https://integration.enoqbank.com/enoq/api/billissuer/list/by/payment-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}' \
  --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,
  "statusBill": 1,
  "statusIntegration": 1
}]

Dicionário de dados

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.