paysera / lib-checkout-client
本包最新版本(2.2.0)的许可证信息不可用。
Paysera Checkout 的 PHP REST 客户端
2.2.0
2023-02-23 14:35 UTC
Requires
- php: >=5.5
- evp/money: ^1.0|^2.0
- fig/http-message-util: ^1.0
- paysera/lib-rest-client-common: ^1.0 | ^2.1
This package is auto-updated.
Last update: 2024-09-23 17:58:22 UTC
README
提供操作 Checkout
API 的方法。它自动对所有请求进行身份验证,并为您映射所需的数据结构。
用法
此库提供 ClientFactory
类,您应使用它来获取 API 客户端本身
use Paysera\Client\CheckoutClient\ClientFactory; $clientFactory = new ClientFactory([ 'base_url' => 'https://checkout-eu-a.paysera.com/checkout/rest/v1/', // optional, in case you need a custom one. 'basic' => [ // use this, it API requires Basic authentication. 'username' => 'username', 'password' => 'password', ], 'oauth' => [ // use this, it API requires OAuth v2 authentication. 'token' => [ 'access_token' => 'my-access-token', 'refresh_token' => 'my-refresh-token', ], ], // other configuration options, if needed ]); $checkoutClient = $clientFactory->getCheckoutClient();
请仅使用 Vendor
提供的单一身份验证机制。
现在您已经拥有了 CheckoutClient
的实例,您可以使用以下方法
方法
取消支付请求
$result = $checkoutClient->cancelPaymentRequest($id);
获取支付请求公开信息
$result = $checkoutClient->getPaymentRequestPublicInfo($id);
更新支付请求客户电子邮件
use Paysera\Client\CheckoutClient\Entity as Entities; $email = new Entities\Email(); $email->setEmail($email); $result = $checkoutClient->setPaymentRequestEmail($id, $email);
标准 SQL 风格的结果过滤
use Paysera\Client\CheckoutClient\Entity as Entities; $filter = new \Paysera\Component\RestClientCommon\Entity\Filter(); $filter->setLimit($limit); $filter->setOffset($offset); $filter->setOrderBy($orderBy); $filter->setOrderDirection($orderDirection); $filter->setAfter($after); $filter->setBefore($before); $result = $checkoutClient->getPaymentRequestMethods($id, $filter);
开始支付并返回流程数据
use Paysera\Client\CheckoutClient\Entity as Entities; $paymentMethod = new Entities\PaymentMethod(); $paymentMethod->setMethodKey($methodKey); $result = $checkoutClient->startPaymentRequestPayment($id, $paymentMethod);
使用已发行的令牌授权 PaymentRequest
use Paysera\Client\CheckoutClient\Entity as Entities; $authorizationParameters = new Entities\AuthorizationParameters(); $authorizationParameters->setToken($token); $result = $checkoutClient->authorizePaymentRequest($id, $authorizationParameters);
捕获授权的 PaymentRequest
$result = $checkoutClient->capturePaymentRequest($id);
获取支付请求
$result = $checkoutClient->getPaymentRequest($id);
创建支付请求
use Paysera\Client\CheckoutClient\Entity as Entities; $paymentRequest = new Entities\PaymentRequest(); $paymentRequest->setId($id); $paymentRequest->setStatus($status); $paymentRequest->setBusinessId($businessId); $paymentRequest->setOrderId($orderId); $paymentRequest->setUniqueIdentifier($uniqueIdentifier); $paymentRequest->setPrice($price); $paymentRequest->setPricePaid($pricePaid); $paymentRequest->setValidUntil($validUntil); $paymentRequest->setLocale($locale); $paymentRequest->setDescription($description); $paymentRequest->setMethodCountry($methodCountry); $paymentRequest->setMethodKey($methodKey); $paymentRequest->setPayer($payer); $paymentRequest->setInformationRequest($informationRequest); $paymentRequest->setCardDataRestriction($cardDataRestriction); $paymentRequest->setAcceptUrl($acceptUrl); $paymentRequest->setCancelUrl($cancelUrl); $paymentRequest->setCallbackUrl($callbackUrl); $paymentRequest->setAuthorizationUrl($authorizationUrl); $paymentRequest->setAffiliateKey($affiliateKey); $paymentRequest->setParameters($parameters); $paymentRequest->setTokenStrategy($tokenStrategy); $paymentRequest->setIssuedToken($issuedToken); $result = $checkoutClient->createPaymentRequest($paymentRequest);
标准 SQL 风格的结果过滤
use Paysera\Client\CheckoutClient\Entity as Entities; $paymentRequestFilter = new Entities\PaymentRequestFilter(); $paymentRequestFilter->setBusinessId($businessId); $paymentRequestFilter->setStatus($status); $paymentRequestFilter->setMethodKey($methodKey); $result = $checkoutClient->getPaymentRequests($paymentRequestFilter);