PHPackages                             paysera/lib-checkout-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. paysera/lib-checkout-client

ActiveLibrary[Payment Processing](/categories/payments)

paysera/lib-checkout-client
===========================

PHP REST Client for Paysera Checkout

2.2.0(3y ago)123.1k—6.7%1[1 issues](https://github.com/paysera/lib-checkout-client/issues)PHPPHP >=5.5

Since Jan 16Pushed 3y ago9 watchersCompare

[ Source](https://github.com/paysera/lib-checkout-client)[ Packagist](https://packagist.org/packages/paysera/lib-checkout-client)[ RSS](/packages/paysera-lib-checkout-client/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (3)Versions (5)Used By (0)

paysera-checkout-client
-----------------------

[](#paysera-checkout-client)

Provides methods to manipulate `Checkout` API. It automatically authenticates all requests and maps required data structure for you.

#### Usage

[](#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

[](#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);
```

---

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity28

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~500 days

Total

4

Last Release

1181d ago

Major Versions

1.0.0 → 2.0.02019-04-24

### Community

Maintainers

![](https://www.gravatar.com/avatar/9d385187c2b529d5c1189dfc3763972f76738d24293593ff3db876fff82321db?d=identicon)[paysera.com](/maintainers/paysera.com)

---

Top Contributors

[![feraldrood](https://avatars.githubusercontent.com/u/7203522?v=4)](https://github.com/feraldrood "feraldrood (1 commits)")[![rokas-simonavicius](https://avatars.githubusercontent.com/u/127475909?v=4)](https://github.com/rokas-simonavicius "rokas-simonavicius (1 commits)")[![velser](https://avatars.githubusercontent.com/u/10587651?v=4)](https://github.com/velser "velser (1 commits)")

### Embed Badge

![Health badge](/badges/paysera-lib-checkout-client/health.svg)

```
[![Health](https://phpackages.com/badges/paysera-lib-checkout-client/health.svg)](https://phpackages.com/packages/paysera-lib-checkout-client)
```

###  Alternatives

[omnipay/paypal

PayPal gateway for Omnipay payment processing library

3156.8M53](/packages/omnipay-paypal)[eduardokum/laravel-boleto

Biblioteca com boletos para o laravel

626351.9k2](/packages/eduardokum-laravel-boleto)[tbbc/money-bundle

This is a Symfony bundle that integrates moneyphp/money library (Fowler pattern): https://github.com/moneyphp/money.

1961.9M](/packages/tbbc-money-bundle)[2checkout/2checkout-php

2Checkout PHP Library

83740.3k2](/packages/2checkout-2checkout-php)[smhg/sepa-qr-data

Generate QR code data for SEPA payments

61717.2k5](/packages/smhg-sepa-qr-data)[superfaktura/apiclient

Api client for SuperFaktura | online invoicing tool

19133.3k](/packages/superfaktura-apiclient)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)