Overview da API

Antes de integrar a nossa solução, é necessário que você entenda o fluxo operacional para que sua integração possa ocorrer sem problemas.

Para conseguir acesso ao arquivo de Conciliação, é preciso seguir 3 passos:

  1. Solicitar as credenciais da API
  2. Solicitar concessão de acesso ao arquivo, para o estabelecimento
  3. Buscar o arquivo em nossa API

1. Solicitar Credenciais de API

As credenciais para acesso aos arquivos de conciliação são: ClientId e ClientSecret.

Para obter suas credenciais, acesse e preencha o formulário de Parcerias disponível nesta página.

Importante: Caso você seja um lojista, informe sua conciliadora para que ela entre em contato com nosso canal de Parcerias através do mesmo link.

2. Solicitar Concessão de Acesso ao Arquivo

Para que uma empresa terceira (conciliadora) acesse os dados de conciliação de um estabelecimento, é necessário o consentimento do lojista.

O fluxo ocorre da seguinte forma:

  1. A conciliadora solicita o acesso ao arquivo do lojista via nossa API.
  2. O lojista recebe um e-mail, podendo aprovar ou recusar o pedido através dos links disponíveis.
  3. Ao aprovar, nosso sistema registra a concessão e envia um e-mail de confirmação.
  4. As credenciais de acesso são enviadas automaticamente à conciliadora via webhook.
  5. Após receber e decriptar a senha (utilizando AES CBC PKCS7), a conciliadora pode se autenticar utilizando o endpoint de autenticação indicado na documentação Gerando seu token de acesso .

O token obtido na autenticação permite o acesso aos arquivos de conciliação nos fluxos disponíveis.

3. Buscar o arquivo em nossa API

Com o token retornado, é possível consultar e baixar os arquivos de conciliação:

📘

Ao solicitar acesso, a conciliadora terá autorização para arquivos de cartão e de Pix. Atenção: os métodos de integração para cada tipo de arquivo são diferentes, siga o fluxo específico de cada um.