A API da Conciliadora foi desenvolvida para integrar sistemas de gestão (ERPs) e plataformas financeiras, permitindo uma troca de informações estruturada e segura. Com essa integração, os clientes podem enviar as transações registradas em seus sistemas e contar com a especialidade da Conciliadora para validá-las. Dessa forma, a conciliação é realizada diretamente na plataforma da Conciliadora, tornando o processo de conferência e controle financeiro mais ágil e preciso. Além disso, os dados conciliados podem ser consultados e transmitidos de volta ao sistema do cliente, garantindo uma comunicação eficiente entre as plataformas.
Documentação API da Conciliadora.
Collection da API da Conciliadora.
Como funciona a API da Conciliadora?
A Conciliadora fornece dois fluxos de integração para que sua aplicação seja capaz de acessar os recursos de conciliação: o fluxo de envio e o fluxo de retorno. Através desses fluxos, sua aplicação será capaz de utilizar as funcionalidades e a especialidade de conciliação da Conciliadora.
Fluxo de envio
O fluxo de envio é o método que traz a possibilidade de encaminhar as transações realizadas e registradas no ERP ou sistema de gestão do cliente para a conciliação(comparação) com as informações das transações das adquirentes presentes na plataforma da Conciliadora.
PASSO A PASSO
1- Envio do arquivo para conciliação
Após a liberação das credenciais da(s) empresa(s) pela Conciliadora, a aplicação do cliente deve utilizar o IdEmpresa, Senha e arquivo(XML) para envio das transações registradas no ERP para conciliação na Conciliadora.
Recomendamos utilizar o "IdentificadorPagamento" para a rastreabilidade da conciliação das informações entre o sistema e adquirente.
Documentação: Envio Venda Sistema
1.1- Consulta do status do processamento do arquivo e conciliação sistema
Após o envio do arquivo de conciliação pela aplicação do cliente pode ser realizado a consulta sobre o status do processamento do arquivo e o resultado da conciliação das informações entre ERP e adquirente na Conciliadora. Na consulta deste endpoint utilizar o TipoArquivo: Cliente e Status 'Todos' para o seu acompanhamento.
Documentação: Status processamento serviço
2- Consulta sobre o resultado da conciliação
Após a conclusão do processo de conciliação entre os sistemas, o ERP pode consultar os resultados para identificar possíveis ajustes. Isso permite verificar se há registros não enviados pelo ERP ou se alguma correção é necessária, garantindo que as transações registradas no sistema e na adquirente estejam totalmente alinhadas.
Nos temos uma sugestão de apresentação destas informações no ERP conforme a nossa tela de Conciliação Venda Sistema.
Documentação: Conciliação venda sistema e Consulta vendas não enviadas
3- Consulta vendas conciliadas para atualização de dados no ERP
Após a conciliação das transações, o ERP pode consultar todas as vendas conciliadas para atualizar os dados conforme as informações fornecidas pela adquirente. Isso permite alinhar detalhes como data de previsão de pagamento, produto, modalidade, taxas e tarifas aplicadas, garantindo maior precisão no controle financeiro.
Documentação: Vendas conciliadas
Fluxo de retorno
O fluxo de retorno são métodos e endpoints onde o cliente consegue realizar a consulta de informações presentes na Conciliadora para serem tratadas no ERP ou sistema de gestão, podendo ser utilizado junto com o método de Envio também para uma conciliação de ponta a ponta!
PASSO A PASSO
1- Consulta dos recebimentos
Após a recepção do arquivo de pagamento da adquirente, os registros de venda e pagamento são conciliados. Para os registros conciliados no envio, o campo "IdentificadorPagamento" é apresentado nos pagamentos da adquirente, permitindo a rastreabilidade da informação e facilitando a automatização da baixa no ERP.
Além disso, caso o cliente realize a conciliação bancária da Conciliadora, o campo "TemConciliacaoBancaria" indica se o pagamento já foi previamente conciliado com o extrato bancário. Dessa forma, é possível garantir uma dupla validação antes de efetuar a baixa no ERP.
Documentação: Consulta pagamentos
API da Conciliadora somente retorno
A API da Conciliadora oferece flexibilidade para atender diferentes necessidades de integração entre sistemas. Além da conciliação completa, que envolve o envio e a validação das transações, o ERP também pode optar por utilizar exclusivamente as APIs de retorno de Vendas e Pagamentos.
Ao utilizar apenas essas APIs, o ERP terá acesso às informações de transações processadas pelas adquirentes. No entanto, nesse formato, a responsabilidade pela conciliação e validação das informações fica integralmente a cargo do ERP, que deverá comparar e tratar os dados conforme sua própria lógica de negócio.
Documentação: Consulta vendas e pagamentos