Pular para o conteúdo principal

Listar lançamento extratos

Dados da API

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.

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

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

HEADERDESCRIÇÃOTIPOTAMANHOOBSERVAÇÃO
accountNumberNúmero da contalong--
documentNumberDocumento do titular da contastring--
initDateData inicialstring-yyyy-MM-ddTHH:mm:ss
finalDateData finalstring-yyyy-MM-ddTHH:mm:ss
Resposta
  [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"date": "2024-10-16T17:37:55.717Z",
"type": "string",
"description": "string",
"value": 0
}
]

Dicionário de dados - Retorno

HEADERDESCRIÇÃOTIPOTAMANHOOBSERVAÇÃO
idIdentificadorstring--
dateData do lançamentodatetime--
typeTipo do lançamentostring--
descriptionDescrição do lançamentostring--
valueValor do lançamentodecimal--