Pular para o conteúdo
OpeniDevelopers

Guia · Nexus

Conciliação bancária via API

Conciliação bancária é comparar o que o banco registrou com o que o ERP espera, registro a registro, para dizer o que confere, o que diverge e o que está faltando. Por API, essa comparação deixa de ser uma planilha mensal e passa a rodar a cada dado que chega.

O que você precisa: duas origens e uma regra.

Toda conciliação tem dois lados. No Nexus, cada lado é uma origem de dados (data source) que alimenta um dataset, e a regra que os compara é um rule set. Para conciliar banco e ERP:

Extrato bancário
Transações de Open Finance, ou o arquivo que o banco entrega: CSV, XLSX ou Francesinha (.fra).
ERP
Uma tabela Postgres com os lançamentos, ou eventos JSON enviados para um webhook de entrada.

O passo a passo, em quatro chamadas.

  1. 1Conecte as origens

    Crie data sources do tipo webhook, arquivo, Postgres, Open Finance ou Openi.

  2. 2Modele os campos

    Datasets guardam os registros. Fields extraem chaves canônicas, como amount e doc, para as regras usarem.

  3. 3Defina as regras

    Um rule set casa dois datasets com uma expressão JSONata e parâmetros de pontuação.

  4. 4Receba os matches

    Cada resultado chega por webhook assinado com HMAC-SHA-256, com retentativas configuráveis.

curl -X POST "https://nexus-api.openi.com.br/v1/data-sources" \
  -H "x-api-key: $NEXUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "webhook",
    "name": "transacoes_banco_x",
    "config": {
      "secret": "um-segredo-com-no-minimo-16-chars",
      "slug": "transacoes-banco-x"
    }
  }'

Como ler o resultado.

Cada par de registros comparado volta com uma pontuação e uma decisão. O resultado chega por webhook assinado com HMAC-SHA-256, nos eventos match.created e reconciliation_job.completed.

MATCH
Os dois registros conferem segundo a regra. Não precisam de revisão.
POSSIBLE
Há semelhança, mas a pontuação não basta para confirmar. É o que vai para a fila de revisão.
NO_MATCH
O par não casa. O registro segue sem correspondência do outro lado.

Nem todo pagamento é um para um. O Nexus também concilia 1:N, N:1, pagamentos parciais e parcelas: um depósito que quita várias faturas, ou uma fatura paga em mais de uma transferência.

Em produção: NDD.

A NDD usa o Nexus para conciliar mais de 100 milhões de registros. Os dados entram por arquivo, banco de dados ou webhook, o rule set casa os dois lados e cada par volta com decisão e pontuação, sem fila manual para o que confere.

Solicitar acessoLer o case

Veja também a página do Nexus e a referência da API.