README

Essa biblioteca permite você se conectar com a API do BanPay através da sua aplicação em PHP.

NÃO É uma biblioteca oficial, porém a considero funcional, pois sempre adiciono novas funcionalidades conforme a API evolui.

Documentação da API

A documentação oficial da API pode ser encontrada em https://banpay.com.br/api.

Instalação Via Composer

Caso não possua o Composer instalado em sua máquina ou ambiente, você pode seguir as instruções do site oficial do Composer em https://getcomposer.org/doc/00-intro.md.

Acesse o diretório raiz da sua aplicação pelo terminal e execute o comando a seguir para instalar a biblioteca:

composer require jlamim/banpay-php-sdk

Após instalar, inclua o autoloader em seu projeto:

require_once 'vendor/autoload.php';

Definindo o ambiente

A API do BanPay conta com um ambiente de produção e outro de homologação. Por padrão a biblioteca se conecta ao ambiente de produção e para mudar a conexão para o ambiente de homologação basta utilizar $cliente->setEnvironment('homologacao').

No código seria algo como:

$cliente = new Cliente;
$cliente->setToken("TOKEN");
$cliente->setEnvironment('homologacao');

Se ao fazer as requisições à API você se deparar com erros relacionados a certificado SSL é sinal de que seu ambiente não está localizando os certificados. Para desativar a verificação do certificado basta utilizar $cliente->setVerifySSL(false).

Funcionalidadesda API

Consulta a Cliente

use BanPay\Cliente;
use BanPay\Services\Consultas\Usuario;
use BanPay\Exceptions\BanPayException;

$cliente = new Cliente;
$cliente->setToken("TOKEN");

try{
    $usuario = Usuario::get($cliente);

    echo $usuario->getNome();
    echo $usuario->getApelido();
    echo $usuario->getEmail();

}catch(BanPayException $e){
    echo $e->getMessage();
}

Consulta a Saldo

use BanPay\Cliente;
use BanPay\Services\Consultas\Saldo;
use BanPay\Exceptions\BanPayException;

$cliente = new Cliente;
$cliente->setToken("TOKEN");

try{
    $saldo = Saldo::get($cliente);

    echo $saldo->getUsuario();
    echo $saldo->getEmail();
    echo $saldo->getSaldoDisponivel();

}catch(BanPayException $e){
    echo $e->getMessage();
}

Consulta a Transação (transferência)

use BanPay\Cliente;
use BanPay\Services\Consultas\Transferencia;
use BanPay\Exceptions\BanPayException;

$cliente = new Cliente;
$cliente->setToken("TOKEN");

$codigo = "xxxxxxxx";

try{
    $transferencia = Transferencia::get($cliente, $codigo);

    echo $transferencia->getData();
    echo $transferencia->getValor();
    echo $transferencia->getOrigem();
    echo $transferencia->getOrigemUsuario();
    echo $transferencia->getOrigemNome();
    echo $transferencia->getOrigemEmail();
    echo $transferencia->getDestinoUsuario();
    echo $transferencia->getDestinoNome();
    echo $transferencia->getDestinoEmail();
    // retorna a data pra ser usada com a biblioteca https://carbon.nesbot.com/
    $transferencia->getDataCarbon();

}catch(BanPayException $e){
    echo $e->getMessage();
}

Realizar Transferência

As transferências através da API do BanPay só podem ser realizadas a partir da conta de origem do token informado.

use BanPay\Cliente;
use BanPay\Services\Financeiro\NovaTransferencia;
use BanPay\Services\Financeiro\Transferencia;
use BanPay\Exceptions\BanPayException;

$cliente = new Cliente;
$cliente->setToken("TOKEN");

$transferencia = new Transferencia;
$transferencia->setContaDestino('email@contadestino.com');
$transferencia->setValor(100.99);

try{
    $novaTransferencia = new NovaTransferencia;
    $resposta = $novaTransferencia->executar($cliente, $transferencia);

    echo $resposta->getStatus();
    echo $resposta->getHashTransacao();
    echo $resposta->getMensagem();

}catch(BanPayException $e){
    echo $e->getMessage();
}

Para verificar a transferência e obter mais detalhes sobre ela você pode utilizar o recurso de "Consulta a Transação" disponível na API e com suporte nessa biblioteca.

Considerações Finais

Suporte

Para reportar um novo bug por favor abra uma Issue no github

Licença

Distribuída sobre a licença MIT. Copie, cole, modifique, melhore e compartilhe sem medo ;)

Créditos

Jonathan Lamim - www.jonathanlamim.com.br

jlamim / banpay-php-sdk

Maintainers

Details