O que é Extrato Consolidado?

Do ponto de vista financeiro, extrato consolidado consiste na apresentação de um conjunto de informações organizadas de maneira clara, facilitando o entendimento a respeito das transações de um determinado serviço. Possui a função de apresentar todas as movimentações realizadas em uma conta corrente/ poupança ou de débitos e créditos fiscais, como INSS e FGTS.

Por que consultar o extrato na Celcoin?

A consulta é necessária para conferir os extratos de operações realizadas pelas APIs da Celcoin com o seu fluxo de caixa, garantindo transparência e permitindo identificar possíveis divergências.

Pré requisitos para implementação:

• Possuir uma chave API da Celcoin, para mais informações acessar esse link.
• Ter familiaridade com APIs Rest usando o protocolo OAuth 2.0.

Esta funcionalidade tem o objetivo de facilitar a conciliação entre o cliente e a Celcoin, possibilitando uma manipulação mais eficiente dos dados e uma estabilidade de retorno constante e mais seguro.

Caso de uso:

Como fintech, quero consultar, via API, os lançamentos transacionais contábeis gerados anteriormente para poder realizar minha conciliação com a Celcoin.

Consultar Extrato Consolidado

A API para Consultar Extrato Consolidado permite buscar em D+1 o extrato consolidado por produto. Nesta consulta é possível passar os seguintes parâmetros de busca:

• startDate- Data contábil inicial de pesquisa, seguindo formato AAAA-MM-DD.
• endDate– Data contábil final de pesquisa, seguindo formato AAAA-MM-DD.
• page - Identificador da página da listagem retornada.
• quantity - Identificador da quantidade por página retornada.

⚠

️ Atenção!

É necessário informar pelo menos startDate e endDate para realizar a consulta.

Pesquisa limitada em 15 dias de intervalo entre startDate e endDate.

Modelo de request:

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/tools-conciliation/v2/painel/ConsolidatedStatement?startDate=2025-03-01&endDate=2025-03-10&page=1' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {access_token}'

Modelo de response:

[
    {
        "data": "05/03/2025",
        "nomeHistorico": "Saldo",
        "qtdOperacoes": 0,
        "debito": 0,
        "credito": 0,
        "saldoDia": 0,
        "saldo": -57201737.1700,
        "historicoId": 0,
        "nsa": 0
    },
    {
        "data": "05/03/2025",
        "dataContabil": "05/03/2025",
        "nomeHistorico": "Pgto Contas Concessionarias/Tributos",
        "qtdOperacoes": 5969,
        "debito": -526627.6000,
        "credito": 0,
        "saldoDia": 0,
        "saldo": -57728364.7700,
        "historicoId": 8,
        "nsa": 22428
    },
    {
        "data": "05/03/2025",
        "dataContabil": "05/03/2025",
        "nomeHistorico": "Pgto Contas Boletos",
        "qtdOperacoes": 16922,
        "debito": -4860071.2400,
        "credito": 0,
        "saldoDia": 0,
        "saldo": -62588436.0100,
        "historicoId": 9,
        "nsa": 22428
    },
    {
        "data": "10/03/2025",
        "dataContabil": "10/03/2025",
        "nomeHistorico": "Saldo",
        "qtdOperacoes": 0,
        "debito": 0,
        "credito": 0,
        "saldoDia": 0,
        "saldo": -57339557.2400,
        "historicoId": 0,
        "nsa": 0
    }
]

Descrição dos campos

A seguir, a lista com a descrição dos campos retornados nas requisições:

⚠

️ Atenção!

Para testar essa API é necessário realizar uma ou mais transações (Pix, Boleto, Recarga, Débito automático, etc.).

É importante ressaltar que as consultas neste endpoint só serão apresentadas no dia posterior (D+1) ao processamento da transação, pois buscamos que nosso ambiente de Sandbox tenha o mesmo comportamento que o de Produção.