ENOQ PayDocs
v3

Lançamento de Extrato

GET/api/statements?accountNumber={accountNumber}&documentNumber={documentNumber}&initDate={initDate}&finalDate={finalDate}

Este endpoint permite listar lançamentos no extrato de uma conta em um intervalo de tempo especificado. É possível filtrar por número da conta, documento do titular e período desejado.

Este método aceita parâmetros para detalhar os lançamentos de acordo com as informações da conta e intervalo de datas.

Requisição

{
  "accountNumber": "long",
  "documentNumber": "string",
  "initDate": "string",
  "finalDate": "string"
}

Dicionário de dados - Parâmetros

Exemplo de requisição
curl --request GET \
  --url 'https://integration.enoqbank.com/enoq/api/statements?accountNumber={accountNumber}&documentNumber={documentNumber}&initDate={initDate}&finalDate={finalDate}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json'

Retorno (200)

Exemplo de resposta
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "date": "2024-10-16T17:37:55.717Z",
    "type": "string",
    "description": "string",
    "value": 0
  }
]

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.