Skip to content
BranchesTags

Latest commit

History

60 Commits

Folders and files

NameName
Last commit message
Last commit date
.vscode
.vscode
lib
lib
test
test
.gitignore
.gitignore
README.md
README.md
azure-pipelines.yml
azure-pipelines.yml
composer.json
composer.json

Repository files navigation

Safe2Pay PHP SDK

Safe2Pay

Principais recursos

  • Consulta de transações.
  • Tokenização de cartão.
  • Pagamentos.
    • Boleto bancário.
    • Cartão de crédito.
    • Bitcoin.
    • Cartão de débito.
    • Pix.
  • Gerenciamento de subcontas para Marketplace.
  • Venda simples.

Utilização

composer require safe2pay/sdk:dev-master

Utilização

A integração com a API do Safe2Pay se dá pelo modelo RESTful, de forma a realizar a transferência segura e simplificada dos dados pelo formato JSON. Para facilitar o envio dos dados, deve-se montar um objeto para envio baseado nos modelos disponíveis, com exemplos abaixo, e a própria chamada do método desejado realizará o tratamento e conversão deste objeto para JSON.

Tratamento das respostas da API

Após o envio, a própria chamada devolverá a resposta em um objeto completo com as propriedades desta, onde um cast das classes de resposta permitirá o tratamento das propriedades do objeto de retorno de forma simplificada, sem a necessidade de criar os mesmos modelos em seu projeto.

Dependências

  • PHP >= 7.1

Pagamentos / Transações

A informação da forma de pagamento é dada por meio da propriedade PaymentMethod, onde deve ser informado o código correspondente ao método desejado:

  1. Boleto Bancário;
  2. Cartão de Crédito;
  3. Bitcoin;
  4. Cartão de Débito

O retorno do envio da transação trará um status para esta, que pode ser igual a:

1 = PENDENTE
2 = PROCESSAMENTO
3 = AUTORIZADO
4 = DISPONÍVEL
5 = EM DISPUTA
6 = DEVOLVIDO
7 = BAIXADO
8 = RECUSADO
11 = LIBERADO
12 = EM CANCELAMENTO
13 = CHARGEBACK

Criando uma venda com Boleto

<?phprequire_once'vendor/autoload.php';
useSafe2Pay\API\PaymentRequest;
useSafe2Pay\Models\Payment\BankSlip;
useSafe2Pay\Models\Transactions\Transaction;
useSafe2Pay\Models\General\Customer;
useSafe2Pay\Models\General\Product;
useSafe2Pay\Models\General\Address;
useSafe2Pay\Models\Core\ConfigasEnviroment;
$enviroment = newEnviroment();
$enviroment->setAPIKEY('x-api-key');
//Inicializar método de pagamento$payload = newTransaction();
//Ambiente de homologação$payload->setIsSandbox(true);
//Descrição geral $payload->setApplication("Teste SDK PHP");
//Nome do vendedor$payload->setVendor("João da Silva");
//Url de callback$payload->setCallbackUrl("https://callbacks.exemplo.com.br/api/Notify");
//Código da forma de pagamento// 1 - Boleto bancário// 2 - Cartão de crédito// 3 - Criptomoeda// 4 - Cartão de débito $payload->setPaymentMethod("1");
//Informa o objeto de pagamento$BankSlip = newBankSlip();
//Data de vencimento$BankSlip->setDueDate("16/10/2019");
//Instrução$BankSlip->setInstruction("Instrução de Exemplo");
//Multa$BankSlip->setPenaltyRate(2.00);
//Juros$BankSlip->setInterestRate(4.00);
//Cancelar após o vencimento$BankSlip->setCancelAfterDue(false);
//Pagamento parcial$BankSlip->setIsEnablePartialPayment(false);
//Mensagens$BankSlip->setMessage(array(
"mensagem 1",
"mensagem 2",
"mensagem 3"
));
//Objeto de pagamento - para boleto bancário$payload->setPaymentObject($BankSlip);
$Products = array();
$payloadProduct = newProduct();
$payloadProduct->setCode(1);
$payloadProduct->setDescription("Produto 1");
$payloadProduct->setUnitPrice(2.50);
$payloadProduct->setQuantity(2);
array_push($Products, $payloadProduct);
$payload->setProducts($Products);
//Customer$Customer = newCustomer();
$Customer->setName("Teste Cliente");
$Customer->setIdentity("01579286000174");
$Customer->setEmail("Teste@Teste.com.br");
$Customer->setPhone("51999999999");
$Customer->Address = newAddress();
$Customer->Address->setZipCode("90620000");
$Customer->Address->setStreet("Avenida Princesa Isabel");
$Customer->Address->setNumber("828");
$Customer->Address->setComplement("Lado B");
$Customer->Address->setDistrict("Santana");
$Customer->Address->setStateInitials("RS");
$Customer->Address->setCityName("Porto Alegre");
$Customer->Address->setCountryName("Brasil");
$payload->setCustomer($Customer);
$response = PaymentRequest::CreatePayment($payload);
// ...

Criando uma venda com cartão de crédito

<?phprequire_once'vendor/autoload.php';
useSafe2Pay\API\PaymentRequest;
useSafe2Pay\Models\Payment\CreditCard;
useSafe2Pay\Models\Transactions\Transaction;
useSafe2Pay\Models\General\Customer;
useSafe2Pay\Models\General\Product;
useSafe2Pay\Models\General\Address;
useSafe2Pay\Models\Core\ConfigasEnviroment;
$enviroment = newEnviroment();
$enviroment->setAPIKEY('x-api-key');
//Inicializar método de pagamento$payload = newTransaction();
//Ambiente de homologação$payload->setIsSandbox(true);
//Descrição geral $payload->setApplication("Teste SDK PHP");
//Nome do vendedor$payload->setVendor("João da Silva");
//Url de callback$payload->setCallbackUrl("https://callbacks.exemplo.com.br/api/Notify");
//Código da forma de pagamento// 1 - Boleto bancário// 2 - Cartão de crédito// 3 - Criptomoeda// 4 - Cartão de débito $payload->setPaymentMethod("2");
$CreditCard = newCreditCard("João da Silva", "4024007153763191", "12/2019", "241", 2);
//Objeto de pagamento - para boleto bancário$payload->setPaymentObject($CreditCard);
$Products = array();
$payloadProduct = newProduct();
$payloadProduct->setCode(1);
$payloadProduct->setDescription("Produto 1");
$payloadProduct->setUnitPrice(2.50);
$payloadProduct->setQuantity(2);
array_push($Products, $payloadProduct);
$payload->setProducts($Products);
//Customer$Customer = newCustomer();
$Customer->setName("Teste Cliente");
$Customer->setIdentity("01579286000174");
$Customer->setEmail("Teste@Teste.com.br");
$Customer->setPhone("51999999999");
$Customer->Address = newAddress();
$Customer->Address->setZipCode("90620000");
$Customer->Address->setStreet("Avenida Princesa Isabel");
$Customer->Address->setNumber("828");
$Customer->Address->setComplement("Lado B");
$Customer->Address->setDistrict("Santana");
$Customer->Address->setStateInitials("RS");
$Customer->Address->setCityName("Porto Alegre");
$Customer->Address->setCountryName("Brasil");
$payload->setCustomer($Customer);
$response = PaymentRequest::CreatePayment($payload);
// ...

Criando uma venda com Criptomoedas

<?phprequire_once'vendor/autoload.php';
useSafe2Pay\API\PaymentRequest;
useSafe2Pay\Models\Transactions\Transaction;
useSafe2Pay\Models\General\Customer;
useSafe2Pay\Models\General\Product;
useSafe2Pay\Models\General\Address;
useSafe2Pay\Models\Core\ConfigasEnviroment;
$enviroment = newEnviroment();
$enviroment->setAPIKEY('x-api-key');
//Inicializar método de pagamento$payload = newTransaction();
//Ambiente de homologação$payload->setIsSandbox(true);
//Descrição geral $payload->setApplication("Teste SDK PHP");
//Nome do vendedor$payload->setVendor("João da Silva");
//Url de callback$payload->setCallbackUrl("https://callbacks.exemplo.com.br/api/Notify");
//Código da forma de pagamento// 1 - Boleto bancário// 2 - Cartão de crédito// 3 - Criptomoeda// 4 - Cartão de débito $payload->setPaymentMethod("3");
$CryptoCoin = newCryptocoin("LTC");
//Objeto de pagamento - para Criptomoedas$payload->setPaymentObject($CryptoCoin);
$Products = array();
$Products = array();
$payloadProduct = newProduct();
$payloadProduct->setCode(1);
$payloadProduct->setDescription("Produto 1");
$payloadProduct->setUnitPrice(2.50);
$payloadProduct->setQuantity(2);
array_push($Products, $payloadProduct);
$payload->setProducts($Products);
//Customer$Customer = newCustomer();
$Customer->setName("Teste Cliente");
$Customer->setIdentity("01579286000174");
$Customer->setEmail("Teste@Teste.com.br");
$Customer->setPhone("51999999999");
$Customer->Address = newAddress();
$Customer->Address->setZipCode("90620000");
$Customer->Address->setStreet("Avenida Princesa Isabel");
$Customer->Address->setNumber("828");
$Customer->Address->setComplement("Lado B");
$Customer->Address->setDistrict("Santana");
$Customer->Address->setStateInitials("RS");
$Customer->Address->setCityName("Porto Alegre");
$Customer->Address->setCountryName("Brasil");
$payload->setCustomer($Customer);
$response = PaymentRequest::CreatePayment($payload);
// ...

Criando uma venda com cartão de débito

<?phprequire_once'vendor/autoload.php';
useSafe2Pay\API\PaymentRequest;
useSafe2Pay\Models\Payment\DebitCard;
useSafe2Pay\Models\Transactions\Transaction;
useSafe2Pay\Models\General\Customer;
useSafe2Pay\Models\General\Product;
useSafe2Pay\Models\General\Address;
useSafe2Pay\ Models\Core\ConfigasEnviroment;
$enviroment = newEnviroment();
$enviroment->setAPIKEY('x-api-key');
//Inicializar método de pagamento$payload = newTransaction();
//Ambiente de homologação$payload->setIsSandbox(true);
//Descrição geral $payload->setApplication("Teste SDK PHP");
//Nome do vendedor$payload->setVendor("João da Silva");
//Url de callback$payload->setCallbackUrl("https://callbacks.exemplo.com.br/api/Notify");
//Código da forma de pagamento// 1 - Boleto bancário// 2 - Cartão de crédito// 3 - Criptomoeda// 4 - Cartão de débito $payload->setPaymentMethod("4");
$CreditCard = newDebitCard("João da Silva", "4024007153763191", "12/2019", "241");
//Objeto de pagamento - para boleto bancário$payload->setPaymentObject($CreditCard);
$Products = array();
$Products = array();
$payloadProduct = newProduct();
$payloadProduct->setCode(1);
$payloadProduct->setDescription("Produto 1");
$payloadProduct->setUnitPrice(2.50);
$payloadProduct->setQuantity(2);
array_push($Products, $payloadProduct);
$payload->setProducts($Products);
//Customer$Customer = newCustomer();
$Customer->setName("Teste Cliente");
$Customer->setIdentity("01579286000174");
$Customer->setEmail("Teste@Teste.com.br");
$Customer->setPhone("51999999999");
$Customer->Address = newAddress();
$Customer->Address->setZipCode("90620000");
$Customer->Address->setStreet("Avenida Princesa Isabel");
$Customer->Address->setNumber("828");
$Customer->Address->setComplement("Lado B");
$Customer->Address->setDistrict("Santana");
$Customer->Address->setStateInitials("RS");
$Customer->Address->setCityName("Porto Alegre");
$Customer->Address->setCountryName("Brasil");
$payload->setCustomer($Customer);
$response = PaymentRequest::CreatePayment($payload);
// ...

Tokenizando um cartão

<?phprequire_once'vendor/autoload.php';
useSafe2Pay\Models\Payment\CreditCard;
useSafe2Pay\API\TokenizationRequest;
useSafe2Pay\Models\Core\ConfigasEnviroment;
$enviroment = newEnviroment();
$enviroment->setAPIKEY('x-api-key');
/** * Class TokenizationTest * * @package Safe2Pay\Test */class TokenizationTest
{
publicstaticfunctionCreate()
{
//Cria uma instância do objeto do cartão para realizar a tokenização$CreditCard = newCreditCard("João da Silva", "4024007153763191", "12/2019", "241", null);
//Realiza a tokenização e traz o retorno$response = TokenizationRequest::Create($CreditCard);
//...
}
}
// ...

Consultar transação

<?phprequire_once'vendor/autoload.php';
useSafe2Pay\API\TransactionRequest;
useSafe2Pay\Models\Core\ConfigasEnviroment;
$enviroment = newEnviroment();
$enviroment->setAPIKEY('x-api-key');
/** * Class TransactionTest * * @package Safe2Pay\Test */class TransactionTest
{
publicstaticfunctionGet()
{ $Id=535489;
$response =TransactionRequest::Get($Id);
//...
}
}
// ...

Informações adicionais / Contato

Em caso de dúvidas, ficamos à disposição em nossos canais ou diretamente pelo e-mail integracao@safe2pay.com.br.

Para mais informações acesse: https://safe2pay.com.br

About

SDK do Safe2Pay para a linguagem PHP.

Resources

Readme
Activity
Custom properties

Stars

15 stars

Watchers

5 watching

Forks

15 forks
Report repository

Releases

Packages

Used by

Contributors

Languages