Skip to content

Latest commit

 

History

History
132 lines (74 loc) · 3.64 KB

README.md

File metadata and controls

132 lines (74 loc) · 3.64 KB

BoletoBancario.com - Boleto Fácil

SDK para integração com o Boleto Fácil

Para verificar a documentação completa e os exemplos de resposta, acesse o Manual de Integração.

Como usar:

Baixe e coloque o arquivo boletofacil.php no mesmo diretorio do arquivo PHP que irá implementar. Após isso, importe o arquivo em seu projeto e inicialize usando seu Token de integração:

require 'boletofacil.php';
use BoletoFacil\BoletoFacil;

$boletoFacil = new BoletoFacil("SEU_TOKEN");

Gerar cobrança mínima:

Chame o metodo createCharge para gerar uma cobrança com os dados mínimos:

$boletoFacil->createCharge("Junior Barros", "CPF_DO_CLIENTE", "Pedido 48192", "147.36", "07/11/2017");

Gerar cobrança:

Chame o metodo createCharge para gerar uma cobrança com os dados mínimos, e depois adicione mais atributos a cobrança, como por exemplo parcelas e o email do cliente (para envio automatico do email):

$boletoFacil->createCharge("Junior Barros", "CPF_DO_CLIENTE", "Pedido 48192", "1047.36", "07/11/2017");
$boletoFacil->installments = 10;
$boletoFacil->payerEmail = "[email protected]";

Emitir cobrança:

Após gerar uma cobrança, você deverá chamar o método issueCharge para emitir a cobrança:

$boletoFacil->createCharge("Junior Barros", "CPF_DO_CLIENTE", "Pedido 48192", "147.36", "07/11/2017");
$boletoFacil->payerEmail = "[email protected]";

$boletoFacil->issueCharge();

Notificação de pagamentos

Você pode configurar o Boleto Fácil para enviar notificações para seu sistema sempre que houver um evento de pagamento. Para isso, faça login no Boleto Fácil, e acesse a página de integração Notificação de pagamentos.

Consulta de pagamentos:

Após receber uma notificação de pagamento, seu sistema pode utilizar o paymentToken recebido para consultar detalhes do pagamento:

require 'boletofacil.php';
use BoletoFacil\BoletoFacil;

$boletoFacil = new BoletoFacil("SEU_TOKEN");
$boletoFacil->fetchPaymentDetails("PAYMENT_TOKEN");

Consulta de saldo:

Você pode verificar seu saldo através do método:

require 'boletofacil.php';
use BoletoFacil\BoletoFacil;

$boletoFacil = new BoletoFacil("SEU_TOKEN");
$boletoFacil->fetchBalance();

Solicitação de transferência:

Você pode solicitar a transferência dos valores em saldo usando o seguinte método:

require 'boletofacil.php';
use BoletoFacil\BoletoFacil;

$boletoFacil = new BoletoFacil("SEU_TOKEN");
$boletoFacil->requestTransfer();

Para definir o valor a ser transferido:

require 'boletofacil.php';
use BoletoFacil\BoletoFacil;

$boletoFacil = new BoletoFacil("SEU_TOKEN");
$boletoFacil->transferAmount = "147.36";
$boletoFacil->requestTransfer();

Cancelamento de cobrança:

Para arquivar e cancelar os lembretes de uma cobrança, use o método:

require 'boletofacil.php';
use BoletoFacil\BoletoFacil;

$boletoFacil = new BoletoFacil("SEU_TOKEN");
$boletoFacil->cancelCharge("CODIGO_DA_COBRANCA");

Para verificar a documentação completa e os exemplos de resposta, acessar Manual de Integração.