用于集成Safe2Pay支付平台的库

dev-main 2022-11-16 13:31 UTC

This package is auto-updated.

Last update: 2024-09-19 13:54:56 UTC


README

Safe2Pay

主要功能

  • 交易查询。
  • 卡片.tokenize。
  • 支付。
    • 银行汇票。
    • 信用卡。
    • 比特币。
    • 借记卡。
    • Pix。
  • Marketplace的子账户管理。
  • 简单销售。

使用

composer require safe2pay/sdk:dev-master

使用

Safe2Pay API的集成通过RESTful模型进行,以便通过JSON格式安全、简单地传输数据。为了便于发送数据,应根据可用的模型构建一个发送对象,以下是一些示例,然后所需的方法的调用将处理并转换此对象为JSON。

API响应处理

发送后,调用本身将返回一个包含这些属性的完整对象,其中对响应类进行类型转换将简化返回对象的属性处理,无需在项目中创建相同的模型。

依赖关系

  • PHP >= 7.1

支付/交易

支付方式的信息通过PaymentMethod属性给出,其中应提供所需方法的对应代码

  1. 银行汇票;
  2. 信用卡;
  3. 比特币;
  4. 借记卡

交易发送的返回将包含一个状态,可能等于

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

通过汇票创建销售

<?php

require_once 'vendor/autoload.php';

use Safe2Pay\API\PaymentRequest;
use Safe2Pay\Models\Payment\BankSlip;
use Safe2Pay\Models\Transactions\Transaction;
use Safe2Pay\Models\General\Customer;
use Safe2Pay\Models\General\Product;
use Safe2Pay\Models\General\Address;

use Safe2Pay\Models\Core\Config as Enviroment;
$enviroment = new Enviroment();
$enviroment->setAPIKEY('x-api-key');

//Inicializar método de pagamento
$payload  = new Transaction();
//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 = new BankSlip();
//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 = new Product();
 $payloadProduct->setCode(1);
 $payloadProduct->setDescription("Produto 1");
 $payloadProduct->setUnitPrice(2.50);
 $payloadProduct->setQuantity(2);

 array_push($Products, $payloadProduct);

$payload->setProducts($Products);

//Customer
$Customer =  new Customer();
$Customer->setName("Teste Cliente");
$Customer->setIdentity("01579286000174");
$Customer->setEmail("Teste@Teste.com.br");
$Customer->setPhone("51999999999");

$Customer->Address = new Address();
$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);

// ...

通过信用卡创建销售

<?php

require_once 'vendor/autoload.php';

use Safe2Pay\API\PaymentRequest;
use Safe2Pay\Models\Payment\CreditCard;
use Safe2Pay\Models\Transactions\Transaction;
use Safe2Pay\Models\General\Customer;
use Safe2Pay\Models\General\Product;
use Safe2Pay\Models\General\Address;

use Safe2Pay\Models\Core\Config as Enviroment;
$enviroment = new Enviroment();
$enviroment->setAPIKEY('x-api-key');

//Inicializar método de pagamento
$payload  = new Transaction();
//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 = new CreditCard("João da Silva", "4024007153763191", "12/2019", "241", 2);

//Objeto de pagamento - para boleto bancário
$payload->setPaymentObject($CreditCard);

$Products = array();

 $payloadProduct = new Product();
 $payloadProduct->setCode(1);
 $payloadProduct->setDescription("Produto 1");
 $payloadProduct->setUnitPrice(2.50);
 $payloadProduct->setQuantity(2);

 array_push($Products, $payloadProduct);

$payload->setProducts($Products);

//Customer
$Customer =  new Customer();
$Customer->setName("Teste Cliente");
$Customer->setIdentity("01579286000174");
$Customer->setEmail("Teste@Teste.com.br");
$Customer->setPhone("51999999999");

$Customer->Address = new Address();
$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);

// ...

通过加密货币创建销售

<?php

require_once 'vendor/autoload.php';

use Safe2Pay\API\PaymentRequest;
use Safe2Pay\Models\Transactions\Transaction;
use Safe2Pay\Models\General\Customer;
use Safe2Pay\Models\General\Product;
use Safe2Pay\Models\General\Address;

use Safe2Pay\Models\Core\Config as Enviroment;
$enviroment = new Enviroment();
$enviroment->setAPIKEY('x-api-key');

//Inicializar método de pagamento
$payload  = new Transaction();
//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 = new Cryptocoin("LTC");

//Objeto de pagamento - para Criptomoedas
$payload->setPaymentObject($CryptoCoin);

$Products = array();

$Products = array();

 $payloadProduct = new Product();
 $payloadProduct->setCode(1);
 $payloadProduct->setDescription("Produto 1");
 $payloadProduct->setUnitPrice(2.50);
 $payloadProduct->setQuantity(2);

 array_push($Products, $payloadProduct);

$payload->setProducts($Products);

//Customer
$Customer =  new Customer();
$Customer->setName("Teste Cliente");
$Customer->setIdentity("01579286000174");
$Customer->setEmail("Teste@Teste.com.br");
$Customer->setPhone("51999999999");

$Customer->Address = new Address();
$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);

// ...

通过借记卡创建销售

<?php

require_once 'vendor/autoload.php';

use Safe2Pay\API\PaymentRequest;
use Safe2Pay\Models\Payment\DebitCard;
use Safe2Pay\Models\Transactions\Transaction;
use Safe2Pay\Models\General\Customer;
use Safe2Pay\Models\General\Product;
use Safe2Pay\Models\General\Address;

use Safe2Pay\ Models\Core\Config as Enviroment;
$enviroment = new Enviroment();
$enviroment->setAPIKEY('x-api-key');

//Inicializar método de pagamento
$payload  = new Transaction();
//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 = new DebitCard("João da Silva", "4024007153763191", "12/2019", "241");

//Objeto de pagamento - para boleto bancário
$payload->setPaymentObject($CreditCard);

$Products = array();

$Products = array();

 $payloadProduct = new Product();
 $payloadProduct->setCode(1);
 $payloadProduct->setDescription("Produto 1");
 $payloadProduct->setUnitPrice(2.50);
 $payloadProduct->setQuantity(2);

 array_push($Products, $payloadProduct);

$payload->setProducts($Products);

//Customer
$Customer =  new Customer();
$Customer->setName("Teste Cliente");
$Customer->setIdentity("01579286000174");
$Customer->setEmail("Teste@Teste.com.br");
$Customer->setPhone("51999999999");

$Customer->Address = new Address();
$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);

// ...

对卡片进行.tokenize

<?php

require_once 'vendor/autoload.php';

use Safe2Pay\Models\Payment\CreditCard;
use Safe2Pay\API\TokenizationRequest;

use Safe2Pay\Models\Core\Config as Enviroment;
$enviroment = new Enviroment();
$enviroment->setAPIKEY('x-api-key');


/**
 * Class TokenizationTest
 *
 * @package Safe2Pay\Test
 */
class TokenizationTest
{

    public static function Create()
    {
         //Cria uma instância do objeto do cartão para realizar a tokenização
        $CreditCard = new CreditCard("João da Silva", "4024007153763191", "12/2019", "241", null);
        //Realiza a tokenização e traz o retorno

        $response  = TokenizationRequest::Create($CreditCard);

        //...
   
    }
}

// ...

查询交易

<?php

require_once 'vendor/autoload.php';

use Safe2Pay\API\TransactionRequest;

use Safe2Pay\Models\Core\Config as Enviroment;
$enviroment = new Enviroment();
$enviroment->setAPIKEY('x-api-key');
/**
 * Class TransactionTest
 *
 * @package Safe2Pay\Test
 */
class TransactionTest
{

    public static function Get()
    { 
        $Id=535489;
       
        $response =TransactionRequest::Get($Id);

        //...
    }
}

// ...

更多信息/联系

如有疑问,请通过我们的渠道或直接通过电子邮件 integracao@safe2pay.com.br 联系我们。

更多信息请访问: https://safe2pay.com.br