paysera / lib-checkout-client
PHP REST Client for Paysera Checkout
Installs: 20 281
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 11
Forks: 1
Open Issues: 1
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-10-23 18:12:28 UTC
README
Provides methods to manipulate Checkout
API.
It automatically authenticates all requests and maps required data structure for you.
Usage
This library provides ClientFactory
class, which you should use to get the API client itself:
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();
Please use only one authentication mechanism, provided by Vendor
.
Now, that you have instance of CheckoutClient
, you can use following methods
Methods
Cancel payment request
$result = $checkoutClient->cancelPaymentRequest($id);
Get payment request public info
$result = $checkoutClient->getPaymentRequestPublicInfo($id);
Update payment request customer email
use Paysera\Client\CheckoutClient\Entity as Entities; $email = new Entities\Email(); $email->setEmail($email); $result = $checkoutClient->setPaymentRequestEmail($id, $email);
Standard SQL-style Result filtering
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);
Start payment and return flow data
use Paysera\Client\CheckoutClient\Entity as Entities; $paymentMethod = new Entities\PaymentMethod(); $paymentMethod->setMethodKey($methodKey); $result = $checkoutClient->startPaymentRequestPayment($id, $paymentMethod);
Authorize PaymentRequest with already issued Token
use Paysera\Client\CheckoutClient\Entity as Entities; $authorizationParameters = new Entities\AuthorizationParameters(); $authorizationParameters->setToken($token); $result = $checkoutClient->authorizePaymentRequest($id, $authorizationParameters);
Capture authorized PaymentRequest
$result = $checkoutClient->capturePaymentRequest($id);
Get payment request
$result = $checkoutClient->getPaymentRequest($id);
Create payment request
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);
Standard SQL-style Result filtering
use Paysera\Client\CheckoutClient\Entity as Entities; $paymentRequestFilter = new Entities\PaymentRequestFilter(); $paymentRequestFilter->setBusinessId($businessId); $paymentRequestFilter->setStatus($status); $paymentRequestFilter->setMethodKey($methodKey); $result = $checkoutClient->getPaymentRequests($paymentRequestFilter);