HomeGuiaAPI ReferenceNovidadesComunidade
API Reference

Consultar movimentos

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

A finalidade da API é disponibilizar os dados do Extrato EDI no formato JSON, que são os mesmos indicados no manual do EDI. É importante ressaltar que as informações fornecidas pela API não são em tempo real, embora possam ser consultadas no mesmo dia, é necessário ter em mente que a movimentação pode não estar completa, já que a API ainda está sendo atualizada com mais dados. O compromisso do PagBank é fornecer essas informações no dia seguinte, ou seja, o acesso sempre se refere ao dia anterior (hoje acessa as informações de ontem).

Os endpoint permite que você consulte as informações relacionadas aos movimentos dos tipos:

  • Transacional
  • Financeiro
  • Antecipação

Para utilizar o serviço do EDI via API, é necessário solicitar suas credenciais de acesso, o passo-a-passo está em Token API EDI.

As credenciais são formadas por 2 informações USER (n.º do estabelecimento) + TOKEN.

Para construção das chamadas, segue instruções:

🚧

Não existe um ambiente de teste para o EDI

Não existe um ambiente sandbox para o serviço de EDI, portanto toda chamada feita por esta página retornará como "não autorizado". Para te auxiliar na construção da sua chamada, siga os parâmetros abaixo e copie o endpoint gerado para ser usado no ambiente de produção.

📘

Acesse o guia do serviço EDI para mais informações sobre seu funcionamento e funcionalidades disponíveis.

Path Params
string
enum
required
Defaults to 2.01

Versão disponível do EDI.

Allowed:
Query Params
date

Define a data das movimentações que será retornada, lembrando que não é possível buscar por um intervalo de tempo, apenas por uma única data. O formato deverá ser: AAAA-MM-DD

int32

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.

int32

Define a quantidade de elementos na página, que por padrão o limite é 1000.

string
enum

Define o tipo de movimentação que será retornado. Você pode escolher entre três opções:
1: Transacional
2: Financeiro
3: Antecipação

Allowed:
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

© 1996- Todos os direitos reservados.

PAGSEGURO INTERNET INSTITUIÇÃO DE PAGAMENTO S/A - CNPJ/MF 08.561.701/0001-01

Av. Brigadeiro Faria Lima, 1.384, São Paulo - SP - CEP 01451-001