PHPackages                             jlamim/banpay-php-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. jlamim/banpay-php-sdk

ActiveLibrary[API Development](/categories/api)

jlamim/banpay-php-sdk
=====================

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.

v1.0.1(5y ago)010MITPHPPHP >=5.6CI failing

Since May 14Pushed 5y ago1 watchersCompare

[ Source](https://github.com/jlamim/banpay-php-sdk)[ Packagist](https://packagist.org/packages/jlamim/banpay-php-sdk)[ RSS](/packages/jlamim-banpay-php-sdk/feed)WikiDiscussions master Synced today

READMEChangelog (3)Dependencies (3)Versions (5)Used By (0)

BanPay PHP SDK
==============

[](#banpay-php-sdk)

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
-------------------

[](#documentação-da-api)

A documentação oficial da API pode ser encontrada em .

Instalação Via Composer
-----------------------

[](#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

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

[](#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
---------------------

[](#funcionalidadesda-api)

### Consulta a Cliente

[](#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

[](#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)

[](#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

[](#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
--------------------

[](#considerações-finais)

### Suporte

[](#suporte)

[Para reportar um novo bug por favor abra uma Issue no github](https://github.com/jlamim/banpay-php-sdk/issues)

### Licença

[](#licença)

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

### Créditos

[](#créditos)

- [Jonathan Lamim - www.jonathanlamim.com.br](https://www.jonathanlamim.com.br)

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

3

Last Release

2187d ago

Major Versions

v0.1-beta → v1.02020-05-14

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1915321?v=4)[Jonathan Lamim ](/maintainers/jlamim)[@jlamim](https://github.com/jlamim)

---

Top Contributors

[![jlamim](https://avatars.githubusercontent.com/u/1915321?v=4)](https://github.com/jlamim "jlamim (20 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/jlamim-banpay-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/jlamim-banpay-php-sdk/health.svg)](https://phpackages.com/packages/jlamim-banpay-php-sdk)
```

###  Alternatives

[statamic/cms

The Statamic CMS Core Package

4.8k3.2M720](/packages/statamic-cms)[ashallendesign/laravel-exchange-rates

A wrapper package for interacting with the exchangeratesapi.io API.

485677.8k](/packages/ashallendesign-laravel-exchange-rates)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[vluzrmos/slack-api

Wrapper for Slack.com WEB API.

102589.1k3](/packages/vluzrmos-slack-api)[smodav/mpesa

M-Pesa API implementation

16363.7k1](/packages/smodav-mpesa)[codebar-ag/laravel-docuware

DocuWare integration with Laravel

1221.1k](/packages/codebar-ag-laravel-docuware)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)