EDI
O EDI (Electronic Data Interchange) do PagBank é a solução para clientes que gerenciam um grande volume de informações e desejam automatizar a conciliação de forma prática e eficiente. Esses são os tipos de movimentações que você pode acessar:
- Transacional: Tenha acesso a todos os detalhes das transações, incluindo vendas, chargebacks, cancelamentos, ajustes a crédito ou débito e detalhes de SPLIT, dentro de um dia em específico, para compor o saldo a receber.
- Financeiro: Tenha acesso a todas as liquidações das transações, incluindo pagamentos, chargebacks, cancelamentos, transferências entre contas PagBank, cashouts e movimentações relativas às transações antecipadas via Mesa PagBank, com todos os eventos confirmados de recebíveis detalhados por parcela.
Os extratos não são gerados instantaneamente. Devido ao processo de sincronização, as informações sempre se referem à movimentação do dia anterior (D-1). Com o EDI do PagBank, você tem acesso a todo o conteúdo que precisa para uma gestão financeira ágil e organizada.
Limitações
É importante estar ciente de que nem todas as operações são incluídas na geração dos extratos EDI. Fique atento a essas limitações, para um melhor entendimento do extrato. As seguintes transações não estão contempladas:
❌ Tentativas Não Autorizadas: Apenas transações confirmadas são consideradas.
❌ Vendas com Vouchers: Formas de pagamento como Sodexo, VR, TR, VA, Alelo, entre outras, não são incluídas.
❌ Recargas em Maquininhas: Operações de recargas em maquininhas também não aparecem nos extratos.
Material complementar
Acesse e faça o download do documento com o layout de especificação do Extrato Eletrônico EDI do PagBank.
Pré-requisitos
Para utilizar os extratos EDI, você precisa:
- Possuir uma conta de vendedor cadastrada no PagBank.
- Solicitar a disponibilização via portal.
Formas de integração para consumo dos Extratos EDI
Os extratos EDI podem ser disponibilizados de duas maneiras:
-
Via API: Acesso à API EDI no formato JSON.
-
Arquivo*: Envio através de uma VAN** de tráfego, onde é possível fazer o download dos extratos através de um portal ou aplicação dedicada (este serviço será descontinuado em breve).
*Este tipo de integração será descontinuado em breve. Recomendamos que a integração seja feita por API.
**Não há custos de VAN para o cliente.
API EDI
Para você utilizar o serviço de EDI, o PagBank disponibiliza dois endpoints:
- Consultar movimentos: Este endpoint fornece o retorno das movimentações solicitadas. Para utilizá-lo, você precisa de um token* de produção válido. Atualmente, estamos na versão 3.00.
- Verificar validade do token ClientId: Este endpoint fornece a possibilidade de checar se o token que você possui é válido.
*Esse não é o token da sua conta. O token da API EDI deve ser solicitado via portal.
Token API EDI
Antes de começar, você precisa criar um token que vai autenticar suas chamadas. Para isso, siga estas etapas:
- Abra um chamado solicitando seu token pelo portal do PagBank. O time do PagBank tem um prazo de 2 dias úteis para realizar o primeiro contato.
- Selecione Novas Ativações - EDI.
- Em Quem é você? selecione se você é um:
- Cliente PagBank
- Integrante do time Comercial
- Conciliador
- Você deverá informar o seu nome, se é uma empresa ou pessoa física, a razão social, e-mail e telefone para contato.
- Em Qual o tipo da sua solicitação?, Selecione Geração de token API EDI.
- No campo Descrição, informe se você deseja:
- 1xN: 1 Token para diversos ID's de estabelecimento.
- 1x1: 1 Token para cada ID de estabelecimento informado.
Se tiver mais de um estabelecimento, escolha a opção de 1xN. Assim, apenas o USER (ID) será alterado, e o Token será o mesmo para a demonstração das informações.
- O Token será gerado e enviado ao e-mail informado no formulário de solicitação.
Solicitação de extratos pelo conciliador
Qualquer conciliador ou software de conciliação pode passar pelo processo de homologação. Uma vez homologado, o conciliador tem acesso a:
- Geração de um token único e replicação desse token para os clientes: Torne suas operações ainda mais seguras e eficientes.
- Disponibilização dos extratos por API: Para novas homologações, os extratos estarão disponíveis apenas via API. A opção de arquivos será descontinuada e não está disponível para novas homologações.
Abaixo você encontra um exemplo das opções disponíveis quando você utilizar o portal para realizar a sua solicitação.
Ao realizar a sua solicitação, não se esqueça de informar a quantidade de clientes a serem ativados e anexar o Termo de Adesão assinado pelo(s) cliente(s), contendo o CNPJ. O token será enviado para o e-mail indicado em até 2 dias úteis.
Para softwares de conciliação e/ou sistemas de PDV que ainda não estão homologados com o PagBank, a solicitação deve ser feita diretamente pelo cliente.
O processo de homologação pode ser solicitado através do e-mail [email protected].
Cenários de teste
A solução EDI do PagBank não oferece um ambiente Sandbox de teste. No entanto, você pode explorar vários cenários de teste específicos, com a opção de download de arquivos txt ou JSON. Isso permite que você teste e ajuste suas integrações de forma segura. Acesse a página Cenários de teste para verificar todos os exemplos disponíveis.
Se precisar de mais informações ou ajuda entre em contato através do e-mail [email protected].
Disponibilidade ambiente de teste
É importante enfatizar que a solução EDI do PagBank não possui um ambiente de teste (SandBox). Portanto, todas as solicitações realizadas para os endpoints disponibilizados retornarão dados de operações reais.
Updated about 1 month ago