EDI

Suggest Edits

O servido de EDI (Electronic Data Interchange) disponibilizado pelo PagBank, também chamado de intercâmbio eletrônico de dados, é usado para enviar extratos eletrônicos para que os clientes possam conciliar suas vendas e pagamentos. Três tipos de extratos são disponibilizados:

  • Transacional: Lista todas as transações confirmadas e operações efetuadas pelo cliente. Consta toda a movimentação do estabelecimento realizada no dia anterior à data de processamento que afeta o Saldo a Receber da conta PagBank.
  • Financeiro: Apresenta toda movimentação relativa à liquidação das transações realizada no dia anterior à data de processamento. Também são apresentados transferências entre contas PagBank e os saques efetuados para contas em Domicílios Bancários e a posição de saldo inicial e final da conta PagBank.
  • Antecipação: Demonstra as antecipações realizadas na mesa, de forma detalhada e por parcelas.

Os extratos não são gerados instantaneamente. Devido ao processo de sincronização, existe um atraso entre a execução da operação e a disponibilização dessa informação no serviço de EDI.

📘

Limitações

Nem todas as operações são incluídas ao gerar os extratos. As seguintes operações não são incluídas nos extratos:

  • Tentativas não autorizadas de compras, apenas transações confirmadas.
  • Vendas com formas de pagamento do tipo Voucher (exemplo: Sodexo, VR, TR, VA, Alelo, etc).
  • Recarga realizadas nas maquininhas.

Documentação

Acesse e faça o download do documento contento o layout de especificação do arquivo do Extrato Eletrônico EDI do PagBank​.

Requisitos

Para utilizar o serviço de EDI, você precisa possuir uma conta de vendedor cadastrada no PagBank e, depois, habilitar o serviço de EDI na sua conta.

Token de utilização

Para que você comece a utilizar o serviço de EDI, você precisa gerar um Token que será utilizado ao utilizar a API do serviço e EDI. Os passos desse processo são descritos abaixo.

  1. Abra um chamado de solicitação de Token através do portal do PagBank. Existe um prazo de 2 dias úteis para processamento.
  2. Selecione Novas Ativações - EDI.
  3. Em Quem é você? selecione se você é um:
    • Cliente PagBank
    • Integrante do time Comercial
    • Conciliador
  4. Informe seu nome, se é uma empresa ou pessoa física, a razão social, e-mail e telefone para contato.
  5. Em Qual o tipo da sua solicitação?, Selecione Geração de token API EDI.
  6. 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.
      Caso tenha mais de um estabelecimento, indique a opção 1xN. Nesse caso será alterado apenas o USER (ID), pois o Token será o mesmo para demonstração das informações.
  7. O Token será gerado e enviado ao e-mail informado no formulário de solicitação.

Um conciliador, ou terceirizado responsável pelas finanças da empresa, também pode solicitar a geração ou replicação de um Token pelo mesmo link, desde que seja homologado no Pagbank. Porém, na solicitação deverá conter a quantidade de clientes a serem ativados e Termo de Adesão assinado pelo(s) cliente(s) contendo o CNPJ deve ser anexado. O Token será enviado para o e-mail informado na solicitação e tem 2 dias úteis de prazo de processamento.

Em caso de softwares de conciliação e/ou sistemas de PDV não homologados como Conciliadores no Pagbank, a solicitação deverá ser oriunda do próprio cliente.

API EDI

Para você utilizar o serviço de EDI, o PagBank disponibiliza dois endpoints:

  • Consultar movimentos: fornece o das movimentações selecionadas. Você precisa de um token válido para utilizar esse endpoint. Você pode escolher a versão de relatório que deseja receber. Atualmente, as versões 1.05, 2.00 e 2.01 estão disponíveis. A diferença entre elas está nos campos informados no extrato.
  • Verificar validade do token ClientId: verifica se o Token que você possui é valido.

🚧

Disponibilidade ambiente de teste

É importe 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 estará retornando dados de operações reais.

O PagBank disponibiliza as coleções dos edpoints associados ao serviço EDI através de uma Coleção do Postman. Alternativamente, você também pode utilizar os endpoints disponíveis na documentação. No entanto, note que com eles você não estará realizando requisições a um ambiente SandBox, mas sim ao ambiente de produção.

Updated 1 day ago