braspag / braspagapiphpsdk
Integração com a API da Braspag
This package's canonical repository appears to be gone and the package has been frozen as a result.
Installs: 3 914
Dependents: 0
Suggesters: 0
Security: 0
Stars: 17
Watchers: 14
Forks: 31
Open Issues: 11
Requires
- php: >=5.6
This package is not auto-updated.
Last update: 2020-08-11 13:49:52 UTC
README
SDK API PHP
Principais recursos
- Pagamentos por cartão de crédito.
- Pagamentos recorrentes.
- Com autorização na primeira recorrência.
- Com autorização a partir da primeira recorrência.
- Pagamentos por cartão de débito.
- Pagamentos por boleto.
- Pagamentos por transferência eletrônica.
- Cancelamento de autorização.
- Consulta de pagamentos.
Limitações
Por envolver a interface de usuário da aplicação, o SDK funciona apenas como um framework para criação das transações. Nos casos onde a autorização é direta, não há limitação; mas nos casos onde é necessário a autenticação ou qualquer tipo de redirecionamento do usuário, o desenvolvedor deverá utilizar o SDK para gerar o pagamento e, com o link retornado pela Braspag, providenciar o redirecionamento do usuário.
Dependências
- PHP >= 5.6
Instalando o SDK
Se já possui um arquivo composer.json
, basta adicionar a seguinte dependência ao seu projeto:
"require": { "braspag/braspagapiphpsdk": "^3.0" }
Com a dependência adicionada ao composer.json
, basta executar:
composer install
Alternativamente, você pode executar diretamente em seu terminal:
composer require "braspag/braspagapiphpsdk:^3.0"
Utilizando o SDK
Para criar um pagamento simples com cartão de crédito com o SDK, basta fazer:
Criando um pagamento com cartão de crédito
<?php require 'vendor/autoload.php'; use Braspag\API\Merchant; use Braspag\API\Environment; use Braspag\API\Sale; use Braspag\API\Braspag; use Braspag\API\Payment; use Braspag\API\Request\BraspagRequestException; // ... // Configure o ambiente $environment = $environment = Environment::sandbox(); // Configure seu merchant $merchant = new Merchant('MERCHANT ID', 'MERCHANT KEY'); // Crie uma instância de Sale informando o ID do pagamento $sale = new Sale('123'); // Crie uma instância de Customer informando o nome do cliente $customer = $sale->customer('Fulano de Tal'); // Crie uma instância de Payment informando o valor do pagamento $payment = $sale->payment(15700); // Crie uma instância de Credit Card utilizando os dados de teste // esses dados estão disponíveis no manual de integração $payment->setType(Payment::PAYMENTTYPE_CREDITCARD) ->creditCard("123", "Visa") ->setExpirationDate("12/2018") ->setCardNumber("0000000000000001") ->setHolder("Fulano de Tal"); // Crie o pagamento na Braspag try { // Configure o SDK com seu merchant e o ambiente apropriado para criar a venda $sale = (new Braspag($merchant, $environment))->createSale($sale); // Com a venda criada na Braspag, já temos o ID do pagamento, TID e demais // dados retornados pela Braspag $paymentId = $sale->getPayment()->getPaymentId(); // Com o ID do pagamento, podemos fazer sua captura, se ela não tiver sido capturada ainda $sale = (new Braspag($merchant, $environment))->captureSale($paymentId, 15700, 0); // E também podemos fazer seu cancelamento, se for o caso $sale = (new Braspag($merchant, $environment))->cancelSale($paymentId, 15700); } catch (BraspagRequestException $e) { // Em caso de erros de integração, podemos tratar o erro aqui. // os códigos de erro estão todos disponíveis no manual de integração. $error = $e->getBraspagError(); } // ...
Criando transações com cartão de débito
<?php require 'vendor/autoload.php'; use Braspag\API\Merchant; use Braspag\API\Environment; use Braspag\API\Sale; use Braspag\API\Braspag; use Braspag\API\Payment; use Braspag\API\Request\BraspagRequestException; // ... // Configure o ambiente $environment = $environment = Environment::sandbox(); // Configure seu merchant $merchant = new Merchant('MERCHANT ID', 'MERCHANT KEY'); // Crie uma instância de Sale informando o ID do pagamento $sale = new Sale('123'); // Crie uma instância de Customer informando o nome do cliente $customer = $sale->customer('Fulano de Tal'); // Crie uma instância de Payment informando o valor do pagamento $payment = $sale->payment(15700); // Defina a URL de retorno para que o cliente possa voltar para a loja // após a autenticação do cartão $payment->setReturnUrl('https://localhost/test'); // Crie uma instância de Debit Card utilizando os dados de teste // esses dados estão disponíveis no manual de integração $payment->debitCard("123", "Visa") ->setExpirationDate("12/2018") ->setCardNumber("0000000000000001") ->setHolder("Fulano de Tal"); // Crie o pagamento na Braspag try { // Configure o SDK com seu merchant e o ambiente apropriado para criar a venda $sale = (new Braspag($merchant, $environment))->createSale($sale); // Com a venda criada na Braspag, já temos o ID do pagamento, TID e demais // dados retornados pela Braspag $paymentId = $sale->getPayment()->getPaymentId(); // Utilize a URL de autenticação para redirecionar o cliente ao ambiente // de autenticação do emissor do cartão $authenticationUrl = $sale->getPayment()->getAuthenticationUrl(); } catch (BraspagRequestException $e) { // Em caso de erros de integração, podemos tratar o erro aqui. // os códigos de erro estão todos disponíveis no manual de integração. $error = $e->getBraspagError(); } // ...