avlyalin / laravel-sberbank-acquiring
提供与Sberbank收单系统交互的功能
Requires
- php: ^7.2
- ext-curl: *
- ext-json: *
Requires (Dev)
- mockery/mockery: ^1.3.1
- orchestra/testbench: ^3.8|^4.0|^5.0
- phpunit/phpunit: ^8.0|^9.0
- squizlabs/php_codesniffer: ^3.5
This package is auto-updated.
Last update: 2024-09-28 05:48:47 UTC
README
该包为您的应用程序提供与Sberbank收单系统进行支付交互的功能。功能包括:
- 创建和存储支付
- 记录支付操作
在使用前,请阅读Sberbank提供的文档。
要求
- PHP >= 7.2
- Laravel >= 5.8
- PHP 扩展:ext-json, ext-curl
- 关系型数据库
安装
将包添加到依赖项
composer require avlyalin/laravel-sberbank-acquiring
发布配置文件
php artisan vendor:publish --provider="Avlyalin\SberbankAcquiring\Providers\AcquiringServiceProvider" --tag=config
运行迁移
php artisan migrate
概述
表格
为存储支付和操作历史,创建了多个表格
- acquiring_payments - 基础支付表,存储所有支付系统的支付信息
- acquiring_payment_operations - 支付操作
- acquiring_sberbank_payments - 通过Sberbank系统直接进行的支付
- acquiring_apple_pay_payments - 通过Apple Pay进行的支付
- acquiring_samsung_pay_payments - 通过Samsung Pay进行的支付
- acquiring_google_pay_payments - 通过Google Pay进行的支付
- acquiring_payment_statuses - 支付状态参考表
- acquiring_payment_operation_types - 操作类型参考表
- acquiring_payment_systems - 支付系统参考表
基本支付和不同支付系统中的支付之间的关联通过ORM级别的多态关系组织。
客户端
该包包含两个用于处理收单的客户端类
ApiClient- 调用Sberbank APIClient- 对ApiClient的封装,保存支付和操作到数据库,使用配置文件。建议使用它。
ApiClient和Client已添加到服务容器中,可用于依赖注入。类解析
use Avlyalin\SberbankAcquiring\Client\ApiClient; use Avlyalin\SberbankAcquiring\Client\Client; $client = $this->app->make(Client::class); $apiClient = $this->app->make(ApiClient::class);
操作
目前支持以下收单操作
注册订单
必选参数 - 金额。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\Client; $client = $this->app->make(Client::class); $acquiringPayment = $client->register( 1000, // сумма ['orderNumber' => '123-456'], // необязательные параметры HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса ); $status = $acquiringPayment->status->name; // 'Зарегистрирован'
如果第二个参数未指定参数
returnUrl和failUrl,则从配置文件中获取。
注册预授权订单
必选参数 - 金额。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\Client; $client = $this->app->make(Client::class); $acquiringPayment = $client->registerPreAuth( 1000, // сумма ['orderNumber' => '123-456'], // необязательные параметры HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса ); $status = $acquiringPayment->status->name; // 'Зарегистрирован'
如果第二个参数未指定参数
returnUrl和failUrl,则从配置文件中获取。
请求完成订单支付
必选参数:支付模型(AcquiringPayment)的ID,金额。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\Client; $client = $this->app->make(Client::class); $acquiringPayment = $client->deposit( 1, // id модели платежа (AcquiringPayment) 1000, // сумма [], // необязательные параметры HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса );
请求取消订单支付
必选参数 - 支付模型(AcquiringPayment)的ID。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\Client; $client = $this->app->make(Client::class); $acquiringPayment = $client->reverse( 1, // id модели платежа (AcquiringPayment) ['language' => 'EN'], // необязательные параметры HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса );
请求退款
必选参数:支付模型(AcquiringPayment)的ID,金额。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\Client; $client = $this->app->make(Client::class); $acquiringPayment = $client->refund( 1, // id модели платежа (AcquiringPayment) 500, // сумма ['language' => 'EN'], // необязательные параметры HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса );
获取订单状态
必选参数 - 支付模型(AcquiringPayment)的ID。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\Client; $client = $this->app->make(Client::class); $acquiringPayment = $client->getOrderStatusExtended( 1, // id модели платежа (AcquiringPayment) ['language' => 'EN'], // необязательные параметры HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса );
请求通过Apple Pay支付
必选参数 - 从Apple Pay系统获得的paymentToken。更多信息在这里。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\Client; $client = $this->app->make(Client::class); $acquiringPayment = $client->payWithApplePay( 'vnkXadsIDvejvKQPvcxbTqeEhfbPOG', // Токен, полученный от системы Apple Pay [ // необязательные параметры 'orderNumber' => '123_abc', 'language' => 'EN', 'description' => 'payment description', ], HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса );
请求通过Samsung Pay支付
必选参数 - 从Samsung Pay系统获得的paymentToken。更多信息在这里。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\Client; $client = $this->app->make(Client::class); $acquiringPayment = $client->payWithSamsungPay( 'vnkXadsIDvejvKQPvcxbTqeEhfbPOG', // Токен, полученный от системы Samsung Pay [ // необязательные параметры 'orderNumber' => '123_abc', 'language' => 'EN', 'description' => 'payment description', ], HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса );
请求通过Google Pay支付
必需参数:从Google Pay系统获取的paymentToken和金额。详细信息请参阅此处。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\Client; $client = $this->app->make(Client::class); $acquiringPayment = $client->payWithGooglePay( 'vnkXadsIDvejvKQPvcxbTqeEhfbPOG', // Токен, полученный от системы Google Pay 1000, [ // необязательные параметры 'orderNumber' => '123_abc', 'language' => 'EN', 'description' => 'payment description', ], HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса );
请求收据信息
描述请参阅此处。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\ApiClient; $apiClient = $this->app->make(ApiClient::class); $response = $apiClient->getReceiptStatus( [ // параметры 'orderId' => 'kvp431_Wmvx_gqQx', 'language' => 'EN' ], HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса ); if ($response->isOk) { print_r($response->getResponseArray()); } else { print_r($response->getErrorMessage()); }
请求激活绑定
必需参数是之前创建的绑定的标识符。详细信息请参阅此处。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\ApiClient; $apiClient = $this->app->make(ApiClient::class); $response = $apiClient->bindCard( '131-cvlg-1vcvc-14cvx', // id связки [], // необязательные параметры HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса ); if ($response->isOk) { print_r($response->getResponseArray()); } else { print_r($response->getErrorMessage()); }
请求取消绑定
必需参数是之前创建的绑定的标识符。详细信息请参阅此处。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\ApiClient; $apiClient = $this->app->make(ApiClient::class); $response = $apiClient->unBindCard( '131-cvlg-1vcvc-14cvx', // id связки [], // необязательные параметры HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса ); if ($response->isOk) { print_r($response->getResponseArray()); } else { print_r($response->getErrorMessage()); }
请求获取客户所有绑定的列表
必需参数是客户在商店系统中的编号(标识符)。详细信息请参阅此处。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\ApiClient; $apiClient = $this->app->make(ApiClient::class); $response = $apiClient->getBindings( 'client-id-1', // номер (идентификатор) клиента [], // необязательные параметры HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса ); if ($response->isOk) { print_r($response->getResponseArray()); } else { print_r($response->getErrorMessage()); }
请求获取特定银行卡绑定的列表
描述请参阅此处。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\ApiClient; $apiClient = $this->app->make(ApiClient::class); $response = $apiClient->getBindingsByCardOrId( 'client-id-1', // номер (идентификатор) клиента [], // необязательные параметры HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса ); if ($response->isOk) { print_r($response->getResponseArray()); } else { print_r($response->getErrorMessage()); }
请求更改绑定有效期
必需参数是之前创建的绑定的标识符。详细信息请参阅此处。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\ApiClient; $apiClient = $this->app->make(ApiClient::class); $response = $apiClient->getBindingsByCardOrId( '131-cvlg-1vcvc-14cvx', // id связки [ // параметры 'newExpiry' => 202012, ], HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса ); if ($response->isOk) { print_r($response->getResponseArray()); } else { print_r($response->getErrorMessage()); }
请求检查卡片在3DS中的参与情况
必需参数是用于支付的卡片的掩码号码(PAN)。详细信息请参阅此处。
use Avlyalin\SberbankAcquiring\Client\HttpClientInterface; use Avlyalin\SberbankAcquiring\Client\ApiClient; $apiClient = $this->app->make(ApiClient::class); $response = $apiClient->verifyEnrollment( '4111111111111111', // номер карты HttpClientInterface::METHOD_GET, // метод запроса ['Cache-Control' => 'no-cache'] // хэдеры запроса ); if ($response->isOk) { print_r($response->getResponseArray()); } else { print_r($response->getErrorMessage()); }
设置
请参阅配置文件。
身份验证
在调用支付网关时,可以使用以下在注册时获取的数据进行身份验证
- 服务账户的登录名/密码对
- 令牌
- 销售商登录名(当使用Apple Pay、Samsung Pay、Google Pay时)
配置文件提供用于设置身份验证数据的参数
...
'auth' => [
'userName' => env('SBERBANK_USERNAME', ''),
'password' => env('SBERBANK_PASSWORD', ''),
'token' => env('SBERBANK_TOKEN', ''),
],
'merchant_login' => env('SBERBANK_MERCHANT_LOGIN', ''),
...
可以通过编辑配置文件或在.env中指定来设置这些数据
SBERBANK_USERNAME=your_username SBERBANK_PASSWORD=your_password SBERBANK_TOKEN=your_token SBERBANK_MERCHANT_LOGIN=your_merchant_login
更新支付状态
某些操作不允许确定新的支付状态。为了更新状态,实现了一个artisan命令,该命令调用getOrderStatusExtended操作来更新所有具有指定状态的支付。
该命令接受一个参数id - 需要更新状态的支付状态的id集合
php artisan sberbank-acquiring:update-statuses --id=1 --id=7
建议将此命令添加到调度器(app/Console/Kernel.php)
use Avlyalin\SberbankAcquiring\Commands\UpdateStatusCommand; use Avlyalin\SberbankAcquiring\Models\AcquiringPaymentStatus; protected function schedule(Schedule $schedule) { $schedule->command(UpdateStatusCommand::class, [ '--id' => [ AcquiringPaymentStatus::NEW, AcquiringPaymentStatus::ACS_AUTH, ], ])->everyMinute(); }
事件(Events)
目前实现了一个事件
异常(Exceptions)
该包在发生错误时抛出异常。
支持
如果您觉得这个项目对您有帮助,您可以在此处支持其发展。
许可(License)
MIT许可证(MIT)。有关更多信息,请参阅许可证文件。
