allw / laravel-pagseguro
与PagSeguro支付网关集成的库。
Requires
- php: >=5.4.0
- ext-curl: *
- lib-curl: *
- lib-libxml: *
- lib-openssl: *
- illuminate/validation: >=4.2
Requires (Dev)
- phpunit/phpunit: ^4.8.35
This package is not auto-updated.
Last update: 2024-10-01 01:29:31 UTC
README
laravel-pagseguro消费PagSeguro API,提供一个简单的生成支付和通知交易的方式。
用户创建和配置
在您使用Laravel PagSeguro之前,请确保您的PagSeguro用户配置正确,以下为PagSeguro用户配置的URL:https://pagseguro.uol.com.br/preferencias/integracoes.jhtml
兼容性
PHP >= 5.4 Laravel 5.x
安装
打开文件 composer.json
并插入以下指令
"require": {
"michael/laravelpagseguro": "dev-master"
}
注意:对于Laravel 5.1或以下版本,请在require中指定版本 0.4.1 而不是使用 dev-master
在require中添加Laravel PagSeguro后,您需要执行以下命令
composer update
或者执行以下命令
composer require michael/laravelpagseguro:dev-master
Service Provider配置
打开文件 config/app.php
并在 providers
数组中添加以下指令
laravel\pagseguro\Platform\Laravel5\ServiceProvider::class
包别名
在您的 config/app.php
文件中,在 aliases
数组中添加以下指令
'PagSeguro' => laravel\pagseguro\Platform\Laravel5\PagSeguro::class
配置器创建
现在您将执行以下命令
php artisan vendor:publish
如果一切顺利,将会显示以下消息
Copied File [/vendor/michael/laravelpagseguro/src/laravel/pagseguro/Config/laravelpagseguro.php] To [/config/laravelpagseguro.php]
配置调整
打开文件 config/laravelpagseguro.php
并修改 token
以及 e-mail
,提供您的商店信息
'credentials' => array(//SETA AS CREDENCIAIS DE SUA LOJA 'token' => null, 'email' => null, )
代理
如果您需要使用Laravel PagSeguro的代理,取消注释并配置http适配器行
'http' => [ 'adapter' => [ 'type' => 'curl', 'options' => [ CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_0, // CURLOPT_PROXY => 'http://user:pass@host:port', // PROXY OPTION <<-- ] ], ],
发送购买请求示例
发送数组应构建以下结构
$data = [ 'items' => [ [ 'id' => '18', 'description' => 'Item Um', 'quantity' => '1', 'amount' => '1.15', 'weight' => '45', 'shippingCost' => '3.5', 'width' => '50', 'height' => '45', 'length' => '60', ], [ 'id' => '19', 'description' => 'Item Dois', 'quantity' => '1', 'amount' => '3.15', 'weight' => '50', 'shippingCost' => '8.5', 'width' => '40', 'height' => '50', 'length' => '80', ], ], 'shipping' => [ 'address' => [ 'postalCode' => '06410030', 'street' => 'Rua Leonardo Arruda', 'number' => '12', 'district' => 'Jardim dos Camargos', 'city' => 'Barueri', 'state' => 'SP', 'country' => 'BRA', ], 'type' => 2, 'cost' => 30.4, ], 'sender' => [ 'email' => 'sender@gmail.com', 'name' => 'Isaque de Souza Barbosa', 'documents' => [ [ 'number' => '01234567890', 'type' => 'CPF' ] ], 'phone' => [ 'number' => '985445522', 'areaCode' => '11', ], 'bornDate' => '1988-03-21', ] ];
获取数据后,使用 createFromArray
方法创建结账对象
$checkout = PagSeguro::checkout()->createFromArray($data);
要确认发送,使用以下方式的 send
方法
$checkout = PagSeguro::checkout()->createFromArray($data); $credentials = PagSeguro::credentials()->get(); $information = $checkout->send($credentials); // Retorna um objeto de laravel\pagseguro\Checkout\Information\Information if ($information) { print_r($information->getCode()); print_r($information->getDate()); print_r($information->getLink()); }
提供手机充值元数据
// .... $data['cellphone_charger'] = '+5511980810000'; $checkout = PagSeguro::checkout()->createFromArray($data);
提供旅行数据元数据
// .... $data['travel'] = [ 'passengers' => [ [ 'name' => 'Isaque de Souza', 'cpf' => '40404040411', 'passport' => '4564897987' ], [ 'name' => 'Michael Douglas', 'cpf' => '80808080822', ] ], 'origin' => [ 'city' => 'SAO PAULO - SP', 'airportCode' => 'CGH', // Congonhas ], 'destination' => [ 'city' => 'RIO DE JANEIRO - RJ', 'airportCode' => 'SDU', // Santos Dumont ] ]; $checkout = PagSeguro::checkout()->createFromArray($data);
提供游戏元数据
// .... $data['game'] = [ 'gameName' => 'PS LEGEND', 'playerId' => 'BR561546S4', 'timeInGameDays' => 360, ]; $checkout = PagSeguro::checkout()->createFromArray($data);
凭证
要从文件中检索默认凭证,可以使用
$credentials = PagSeguro::credentials()->get();
或使用替代凭证
$credentials = PagSeguro::credentials()->create($token, $email);
手动查询交易
$credentials = PagSeguro::credentials()->get(); $transaction = PagSeguro::transaction()->get($code, $credentials); $information = $transaction->getInformation();
接收交易通知
创建一个名为 "pagseguro.notification" 的POST路由(在config中)
Route::post('/pagseguro/notification', [ 'uses' => '\laravel\pagseguro\Platform\Laravel5\NotificationController@notification', 'as' => 'pagseguro.notification', ]);
在您的config/laravelpagseguro.php中注册一个callback(可调用函数)
'routes' => [ 'notification' => [ 'callback' => ['MyNotificationClass', 'myMethod'], // Callable 'credential' => 'default', 'route-name' => 'pagseguro.notification', // Nome da rota ], ],
或者...
'routes' => [ 'notification' => [ 'callback' => function ($information) { // Callable \Log::debug(print_r($information, 1)); }, ], ],
类中的 callable 示例
在配置文件中,您应该这样设置
'notification' => [ 'callback' => ['App\Controllers\PagSeguroController', 'Notification'], // Callable callback to Notification function (notificationInfo) : void {} 'credential' => 'default', // Callable resolve credential function (notificationCode) : Credentials {} 'route-name' => 'pagseguro.notification', // Criar uma rota com este nome ],
在控制器中,您应该创建一个方法,例如,Notification
public static function Notification($information) { \Log::debug(print_r($information->getStatus()->getCode(), 1)); }
创建周期性付款计划
创建周期性付款计划首先需要创建计划,为此您需要创建以下数组
如果您想查看请求对象,请访问:https://dev.pagseguro.uol.com.br/v1.0/reference#criar-plano
$plan = [ 'body' => [ 'reference' => 'plano laravel pagseguro', ], 'preApproval' => [ 'name' => 'Plano ouro - mensal', 'charge' => 'AUTO', // outro valor pode ser MANUAL 'period' => 'MONTHLY', //WEEKLY, BIMONTHLY, TRIMONTHLY, SEMIANNUALLY, YEARLY 'amountPerPayment' => '125.00', // obrigatório para o charge AUTO - mais que 1.00, menos que 2000.00 'membershipFee' => '50.00', //opcional - cobrado com primeira parcela 'trialPeriodDuration' => 30, //opcional 'details' => 'Decrição do plano', //opcional 'expiration' => [ // opcional 'value' => 1, // obrigatório de 1 a 1000000 'unit' => 'YEARLY', // obrigatório ], ] ];
然后您需要调用创建计划的函数
$plan = \PagSeguro::plan()->createFromArray($plan); $credentials = \PagSeguro::credentials()->get(); $information = $plan->send($credentials); // Retorna um objeto de laravel\pagseguro\Checkout\Information\Information if ($information) { print_r($information->getCode()); print_r($information->getDate()); print_r($information->getLink()); }
许可
Laravel PagSeguro使用MIT许可证,要了解更多信息,请参阅链接: MIT license