Consulta de extrato

Esta API permite que empresas parceiras e integradoras da solução de pagamento da NDD consultem a movimentação financeira da conta, gerem extratos, conciliem lançamentos e apoiem decisões estratégicas sem acessar o portal do NDD Cargo.

O extrato segue o modelo de extrato bancário tradicional contendo os campos:

• Lançamento: Crédito ou Débito
• Tipo de operação: Ex transferência PIX
• Valor
• Data e hora

Prazo máximo consulta: 3 meses

O parceiro só poderá consultar o extrato da conta das contratantes vinculadas ao seu Cliente ID.

Método e rota

• Solicitação (POST): /consulta/extrato/:enterpriseId
• Consulta (GET): /consulta/extrato/

Estrutura da requisição

Cabeçalhos

• Authorization: o token JWT deve ser enviado no header.

  Authorization: Bearer {token}

Corpo

Confira o exemplo abaixo e veja aqui a definição completa.

POST

{
"dataInicial": "2026-03-01T00:00:00",
"dataFinal":   "2026-03-30T00:00:00",
"enterpriseID": "guid"
}

Exemplo de resposta bem-sucedida:

{ 
"codigoConsulta": "guid"
}

GET

A consulta é realizada de forma assíncrona. Primeiro, é feita a solicitação de extração do CIOT informando o período, por meio do método POST. Em seguida, o resultado é obtido utilizando o GUID gerado, por meio do método GET.

• Consulta (GET): /consulta/extrato/

{ 
"codigoConsulta": "guid"
}

Exemplo de resposta bem-sucedida:

{ 
"operationType": "débito",
"operation": "transferência PIX",
"transactionStatus": "Executed",
"value": 100,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionCode": "dff110ee-caea-4e66-8655-45c02371bfca"
 }

Layout

Parâmetro	Tipo	Descrição
operationType	string	Tipo de lançamento: crédito ou débito.
operation	string	Tipo de operação.
transactionStatus	string	Status da transação.
value	integer	Valor da transação.
transactionDate	date-time	Data e hora da transação.
transactionCode	uuid	Código da transação de pagamento (gerado mesmo que o pagamento não tenha ocorrido).

Códigos de Status HTTP

• 200: Consulta realizada com sucesso.
• 400: Parâmetro ausente ou intervalo inválido.
• 401: Não autorizado (token JWT ausente ou inválido).
• 403: Recurso restrito ao parceiro ou ambiente específico.
• 500: Erro interno do servidor ou exceções não tratadas.