Guia

API do extrato EDI

Suggest Edits

A API doPagBank foi criada para tornar o acesso aos dados do Extrato EDI mais fácil e prático, disponibilizando tudo em formato JSON, exatamente como você encontra no manual do EDI.

📘

As informações que você obtém através da API não são em tempo real. Embora você possa realizar a consulta no mesmo dia, elas podem não estar completas, já que ainda estamos atualizando nossos dados. Garantimos nosso compromisso em fornecer todos os detalhes no dia seguinte (hoje você confere os dados de ontem).

O que você pode consultar?

Os endpoints da API permitem que você acesse informações sobre:

  • Movimentos Transacionais
  • Movimentos Financeiros
  • Cashouts
  • Saldos

Como utilizar a API

Para utilizar o serviço EDI do PagBank via API, você deve solicitar suas credenciais de acesso. Confira o passo a passo no guia Token API EDI.

As credenciais para utilizar a API consistem em duas informações:

  • USER: Número do estabelecimento.
  • TOKEN: Token de acesso à API EDI. Para mais informações acesse o guia Token API EDI.

Para acessar os extratos do EDI, você deve utilizar a seguinte URL:

https://edi.api.pagseguro.com.br/movement/{ediVersion}/{tipoMovimento}/{AAAA-MM-DD}?pageNumber={pageNumber}&pageSize={pageSize}

Onde:

  • ediVersion: Versão disponível do EDI. Atualmente a versão v3.00 está disponível.
  • tipoMovimento: Define o tipo de movimentação que será retornado. As seguintes opções estão disponíveis:
    • transactional
    • financial
    • cashouts
    • balances
  • AAAA-MM-DD: Define a data das movimentações que será retornada. Não é possível buscar por um intervalo de tempo, apenas por uma única data. O formato deverá ser AAAA-MM-DD.
  • pageNumber: Define o número da página que será retornado na busca, sendo que há um limite de 1000 elementos por página. Quando esse limite é ultrapassado, uma nova página é automaticamente criada.
  • pageSize: Define a quantidade de elementos na página. Por padrão, o limite é 1000.

Abaixo você encontra exemplos de requisições para cada um dos tipoMovimento disponíveis:

https://edi.api.pagseguro.com.br/movement/v3.00/transactional/AAAA-MM-DD?pageNumber=1&pageSize=1000

https://edi.api.pagseguro.com.br/movement/v3.00/financial/AAAA-MM-DD?pageNumber=1&pageSize=1000

https://edi.api.pagseguro.com.br/movement/v3.00/cashouts/AAAA-MM-DD?pageNumber=1&pageSize=1000

https://edi.api.pagseguro.com.br/movement/v3.00/balances/AAAA-MM-DD?pageNumber=1&pageSize=1000

📘

Validade ClientId

Além de disponibilizar a consulta de extrato, a API EDI também possibilita que você verifique a validade do token ClientId. Acesse a página [Verificar validade do token ClientId] para mais informações.

Updated 7 days ago