> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Pré-requisitos

> Confira as credenciais, o acesso de rede e os formatos de arquivo de que você precisa antes de usar o Matcher para conciliação.

Antes de usar o Matcher, confirme que você tem o que esta página descreve.

## Opcional: conciliar dados do Midaz

***

O Matcher se combina com o Midaz Ledger, mas não existe conector ativo entre eles. O Matcher não abre conexão com o Midaz. Conciliar dados do Midaz é totalmente opcional. O Matcher funciona como produto independente que concilia quaisquer fontes de dados.

### Quando conciliar dados do Midaz

Concilie dados de ledger do Midaz se:

* Você usa o Midaz como seu sistema de ledger
* Você quer conciliar os lançamentos do Midaz com fontes externas (extratos bancários, relatórios de gateway)

### Quando o Midaz não está envolvido

O Matcher funciona de forma independente quando:

* Ao conciliar entre sistemas externos (bancos, ERPs, processadores de pagamento)
* Ao usar outro sistema de ledger
* Ao importar dados de ledger por arquivos CSV/JSON/XML

### Como funciona

O Matcher concilia dados do Midaz do mesmo jeito que ingere qualquer fonte (por importação, não por consulta ativa):

1. Exporte os dados do ledger do período que você quer conciliar.
2. Importe essa exportação para um contexto do Matcher como fonte do tipo `LEDGER`.
3. Importe os dados da contraparte (extrato bancário ou relatório de gateway) como o outro lado.
4. O Matcher faz a correspondência dos dois lados usando suas regras de correspondência.

> [!NOTE]
>
> Veja o guia [Matcher e Midaz](https://docs.lerian.studio/pt/products/matcher/integrations/matcher-midaz-integration.md) para o fluxo completo.

## Autenticação

***

O Access Manager emite o token e verifica as permissões de quem chama.

### Permissões obrigatórias

Permissões refinadas controlam o acesso aos recursos do Matcher:

| Permissão | Descrição |
| - | - |
| `contexts:create` | Criar contextos de conciliação |
| `contexts:read` | Ver a configuração do contexto |
| `rules:create` | Criar regras de correspondência |
| `imports:create` | Enviar arquivos de transações |
| `match-runs:run` | Executar jobs de correspondência |
| `exceptions:read` | Ver exceções |
| `exceptions:resolve` | Resolver exceções |
| `reports:read` | Acessar relatórios |

## Formatos genéricos de importação

***

Os importadores genéricos do Matcher aceitam CSV, JSON e XML. Os parsers embutidos também aceitam CAMT.053, CNAB 240/400, OFX, vários formatos de adquirente e formatos de recebíveis. Veja o [catálogo de formatos de importação](https://docs.lerian.studio/pt/products/matcher/imports/matcher-import-formats.md) para o inventário completo.

Cada formato genérico tem requisitos estruturais específicos para a ingestão dar certo.

### CSV (valores separados por vírgula)

Muito usado para extratos bancários e exportações.

**Requisitos:**

* O arquivo deve ter uma linha de cabeçalho
* Codificação UTF-8 (configurável)
* Delimitador vírgula (configurável)
* Campos entre aspas para valores que contêm delimitadores

**Exemplo:**

```csv theme={null}
transaction_id,amount,currency,date,reference
TXN-001,1000.00,USD,2024-01-15,Invoice payment
TXN-002,-250.50,USD,2024-01-16,Refund
```

### JSON (notação de objetos javascript)

Recomendado para integrações baseadas em API.

**Requisitos:**

* Um array de objetos ou um único objeto
* Codificação UTF-8 (configurável)
* Nomes de campo consistentes entre os registros

**Exemplo:**

```json theme={null}
[
  {
    "transaction_id": "TXN-001",
    "amount": 1000.0,
    "currency": "USD",
    "date": "2024-01-15",
    "reference": "Invoice payment"
  }
]
```

### XML (linguagem de marcação extensível)

Comum em integrações corporativas e bancárias.

**Requisitos:**

* Um único elemento raiz
* Codificação UTF-8 (configurável)
* Estrutura de elementos consistente

**Exemplo:**

```xml theme={null}
<?xml version="1.0" encoding="UTF-8"?>
<transactions>
 <transaction>
 <transaction_id>TXN-001</transaction_id>
 <amount>1000.00</amount>
 <currency>USD</currency>
 <date>2024-01-15</date>
 <reference>Invoice payment</reference>
 </transaction>
</transactions>
```

### Limites de tamanho de arquivo

| Limite | Padrão |
| - | - |
| Tamanho máximo do arquivo enviado | 1 GiB |
| Corpo de requisição máximo em buffer | 100 MiB |

## Requisitos de rede

***

### Acesso ao Matcher

Seus sistemas e usuários acessam a API do Matcher e o módulo Matcher do Lerian Console nos endereços que a Lerian fornece.

### Acesso aos seus sistemas

Para estas fontes, o Matcher se conecta ao sistema que você indica, e esse sistema deve aceitar conexões do Matcher:

| O que você registra | A que o Matcher se conecta |
| - | - |
| Conexão de Discovery | O banco de dados ou a API que a conexão indica. `GET /v1/discovery/connector-types` lista os tipos disponíveis |
| Binding de fonte no trilho `file` | O servidor SFTP, o endpoint HTTPS, o bucket S3 ou a caixa de e-mail IMAP |

As conexões de agregador precisam da sua conta no Pluggy ou no Belvo.

A entrega de eventos é opcional. Quando a Lerian a habilita para você, o Matcher publica os eventos de [Eventos do Matcher](https://docs.lerian.studio/pt/reference/events/matcher.md) como CloudEvents.

## Checklist

***

Antes de começar, confirme que:

* **As credenciais estão disponíveis**: você tem um token do Access Manager
* **O acesso de rede funciona**: os sistemas que você registra aceitam conexões do Matcher
* **Um navegador está disponível**: você o usa para abrir o módulo Matcher do Lerian Console
* **Os dados de exemplo estão prontos**: você tem arquivos de transações para o primeiro teste (veja [Início rápido](https://docs.lerian.studio/pt/products/matcher/getting-started/matcher-quick-start.md))

## Próximos passos

***

> [card] [Início rápido](https://docs.lerian.studio/pt/products/matcher/getting-started/matcher-quick-start.md)
>
> Rode sua primeira conciliação.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.