pedrobruning/phpix

Biblioteca para integrar seu sistema PHP com WebServices Pix

v1.0.3 2022-03-19 14:17 UTC

Requires

• php: >=8.1
• symfony/http-client: ^6.0

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• Pedro Henrique Bruning de Oliveira Schier

README

Simples biblioteca que facilita a integração com WebServices para PIX.

Instalação

Para instalar essa biblioteca basta executar o comando a baixo

composer require pedrobruning/phpix

Serviços disponíveis

• OpenPix (https://developers.openpix.com.br/api/)

Requisitos

• Necessário PHP 8.1 ou superior.
• Necessário o pacote symfony/http-client na versão ^6.0

Utilização

Para utilizar essa biblioteca basta seguir os exemplos a seguir.

<?php
require __DIR__ . 'vendor/autoload.php';

//DEPENDÊNCIAS
use PedroBruning\PhPix\Services\PhPixServiceFactory;
use PedroBruning\PhPix\Services\Providers;
use Symfony\Component\HttpClient\HttpClient; 

//INSTÂNCIA
//CRIAÇÃO DO CLIENT: Se o provider que você está utilizando precisa de token de authorization você deve informa-lo na criação do client
$client = HttpClient::create();
$client = $client->withOptions([
    'headers' => ['Authorization' => 'YOUR_TOKEN']
]);

$provider = Providers::YourProvider;
$phPixService = PhPixServiceFactory::make($provider, $client);

Cobranças

Obter Cobrança por Id

$chargeId = 'chargeId';
$charge = $phPixService->charges()->getById($chargeId);

Obter Cobranças por Filtro

$filter = [
    'start' => '2021-03-01T17:28:51.882Z',
    'end' => '2021-03-05T17:28:51.882Z',
    'status' => 'ACTIVE',
];
$charges = $phPixService->charges()->getByFilter($filter);

Criar Cobrança

Todos os campos que podem ser utilizados para criação da cobrança podem ser consultados na própria classe de Request chamada.

use PedroBruning\PhPix\Models\OpenPix\ChargeRequest;
$chargeRequest = new ChargeRequest(
    correlationId: 'validCorrelation',
    value: 100,
    comment: 'validComment',
    identifier: 'validIdentifier',
    customer: [
        'name' => 'Test Customer',
        'email' => '[e-mail]',
        'phone' => '(00) 00000-0000',
        'taxID' => '000000000000'
    ]
);
$charge = $phPixService->charges()->create($chargeRequest);

Estornos

Obter Estorno por Id

$refundId = 'refundId';
$refund = $phPixService->refunds()->getById($refundId);

Obter todos os Estornos

$refund = $phPixService->refunds()->getAll();

Criar Estorno

Todos os campos que podem ser utilizados para criação do estorno podem ser consultados na própria classe de Request chamada.

use PedroBruning\PhPix\Models\OpenPix\RefundRequest;
$refundRequest = new RefundRequest(
    value: 100,
    transactionEndToEndId: 'validTransactionEndToEndId',
    correlationId: 'validCorrelation'
);
$refund = $phPixService->refunds()->create($refundRequest);