devjoaomarcos/paghiper-php-sdk

Biblioteca de integração PHP PagHiper

1.0.0 2022-10-26 01:10 UTC

Requires

• php: >=7.2
• guzzlehttp/guzzle: ^7.0

MIT

• Pedro Lima
• João Marcos

• paghiper

README

Descrição

Utilizando essa biblioteca você pode integrar o PagHiper no seu sistema e utilizar os recursos que o PagHiper fornece em sua API, deixando seu código mais legível e manutenível.

Esta biblioteca tem suporte aos seguintes recursos:

• Emissão de boleto
• Cancelamento de boleto
• Consultar status do boleto
• Receber notificações automáticas (Retorno Automático)
• Realizar saques para conta bancária
• Listar contas bancárias
• Listar transações
• Múltiplos boletos
• Pix

Instalação

Compatibilidade

Execute o comando

composer require webmasterdro/paghiper-php-sdk:^2.0

Utilizando

Antes de utilizar, obtenha suas credenciais (apiKey e token) em https://www.paghiper.com/painel/credenciais/

Pix

Para utilizar a nova modalidade de pagamento (PIX) você só precisa fazer isto:

$paghiper = new PagHiper('api_key', 'token', 'píx');
$paghiper->pix()->create([]);
$paghiper->pix()->status('transaction_id');
$paghiper->pix()->cancel('transaction_id');
$paghiper->pix()->notification($_POST['notification_id'], $_POST['idTransacao']);

Emissão de Boleto

Para emitir um boleto você pode fazer da seguinte maneira:

use WebMaster\PagHiper\PagHiper;

$paghiper = new PagHiper('api_key', 'token');
$transaction = $paghiper->billet()->create([
    'order_id' => 'ABC-456-789',
    'payer_name' => 'Pedro Lima',
    'payer_email' => '[e-mail]',
    'payer_cpf_cnpj' => '1234567891011',
    'type_bank_slip' => 'boletoa4',
    'days_due_date' => '3',
    'items' => [[
        'description' => 'Macbook',
        'quantity' => 1,
        'item_id' => 'e24fc781-f543-4591-a51c-dde972e8e0af',
        'price_cents' => '1000'
    ]]
]);

Você pode obter a lista de dados que você pode enviar no seguinte link: https://dev.paghiper.com/reference#gerar-boleto

Para cancelar um boleto:

$transaction = $paghiper->billet()->cancel('JKP03X9KN0RELVLH');

Para consultar o status de um boleto:

$transaction = $paghiper->billet()->status('JKP03X9KN0RELVLH');

Para gerar múltiplos boletos em único PDF:

$transaction = $paghiper->billet()->multiple([
    'id_transacao'
], 'boletoCarne');

Para obter informações do pagamento via retorno automático:

$transaction = $paghiper->notification()->response($_POST['notification_id'], $_POST['idTransacao']);

Para obter a lista de suas contas bancárias:

$banckAccounts = $paghiper->banking()->accounts();

Para realizar um saque:

$banckAccounts = $paghiper->banking()->withdraw('id_conta_bancaria');