Integração PagBank

[tbizze]

A integração é feita mediante a API EDI do PagBank. O servido de EDI (Electronic Data Interchange) 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.

Requisitos

• possuir uma conta de vendedor cadastrada no PagBank e,
• Obter um user e um token para fazer autenticação nas requisições a API.

NOTAS: Para obter as credenciais, abrir chamado de solicitação de Token através do Portal Pipefy. Existe um prazo de 2 dias úteis para processamento.

Passo a passo:

• [x] gerar as credenciais. Chegará por e-mail
• [x] criar controller
• [x] criar classe de serviço
• [x] método para obter financeiro
• [x] método para obter transacional
• [x] método para obter antecipação
• [x] view para exibir dados

[tbizze]

Consultar movimentos

Fonte A finalidade da API é disponibilizar os dados do Extrato EDI no formato JSON,. É importante ressaltar que as informações fornecidas pela API não são em tempo real, embora possam ser consultadas no mesmo dia. 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).

Endpoint: https://edi.api.pagseguro.com.br/edi/v1/{ediVersion}/movimentos

Parâmetros: ?dataMovimento=2024-08-27&pageNumber=1&pageSize=10&tipoMovimento=2

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

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

[tbizze]

Requisições:

Guida para Requisições

• Autenticação nas chamadas da API

Ela é de caráter simples, se dá através das credenciais formadas por 2 informações USER (nº do estabelecimento) + TOKEN. Esses dados são fornecidos pelo Portal Pipefy.

Então deve ser montado uma string => USER :TOKEN. E essa string deve ser criptografada.

$credentials = base64_encode("$this->clientId:$this->token");

'headers' => [
    'Authorization'     => "Basic $credentials",
],

NOTAS: Para segurança, o ClientId e o Token estão numa variável de ambiente, dentro do .Env. E são recuperados através da variável $this->client_id, no constructor().