README

此库允许您通过PHP应用程序连接到BanPay API。

这不是官方库，但考虑到其功能性，我会随着API的演进不断添加新功能。

API文档

官方API文档可在https://banpay.com.br/api找到。

通过Composer安装

如果您未在机器或环境中安装Composer，可以遵循Composer官方网站上的说明：https://getcomposer.org.cn/doc/00-intro.md.

通过终端访问应用程序的根目录并执行以下命令来安装库

composer require jlamim/banpay-php-sdk

安装后，将自动加载器包含到您的项目中

require_once 'vendor/autoload.php';

定义环境

BanPay API拥有一个生产环境和另一个测试环境。默认情况下，库连接到生产环境，要更改连接到测试环境，只需使用$cliente->setEnvironment('homologacao')。

在代码中可能如下所示

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

如果您在向API发出请求时遇到与SSL证书相关的错误，这表明您的环境无法定位证书。要禁用证书验证，只需使用$cliente->setVerifySSL(false)。

API功能

查询客户

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();
}

查询余额

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();
}

查询交易（转账）

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();
}

执行转账

通过BanPay API执行的转账只能从提供的token的原账戶进行。

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();
}

要验证转账并获得更多详细信息，您可以使用API中提供的“查询交易”功能，并在此库中得到支持。

总结

支持

请通过github创建一个issue来报告新的bug

许可证

基于MIT许可证分发。复制、粘贴、修改、改进和分享，无需担忧 ;)

致谢

• Jonathan Lamim - www.jonathanlamim.com.br