PHPackages                             payeverorg/payever-php-sdk - 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. payeverorg/payever-php-sdk

ActiveLibrary[Payment Processing](/categories/payments)

payeverorg/payever-php-sdk
==========================

PHP SDK for payever payments

1.0.0(1y ago)02852MITPHPPHP >=5.6.0

Since Apr 29Pushed 1y agoCompare

[ Source](https://github.com/payeverorg/payever-php-sdk)[ Packagist](https://packagist.org/packages/payeverorg/payever-php-sdk)[ Docs](https://github.com/payeverorg/payever-php-sdk)[ RSS](/packages/payeverorg-payever-php-sdk/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (4)Versions (2)Used By (2)

payever PHP SDK
===============

[](#payever-php-sdk)

[![Latest Stable Version](https://camo.githubusercontent.com/9f37385a6fbb119732d1a05b30fc9bd734490c415d19cfda730382fe6eac9ebb/68747470733a2f2f706f7365722e707567782e6f72672f706179657665726f72672f706179657665722d7068702d73646b2f762f737461626c65)](https://packagist.org/packages/payeverorg/payever-php-sdk)[![Total Downloads](https://camo.githubusercontent.com/b924687c7621516310e6ae0b0d52556a3d7052846e9ccc015c5ace1e58906c58/68747470733a2f2f706f7365722e707567782e6f72672f706179657665726f72672f706179657665722d7068702d73646b2f646f776e6c6f616473)](https://packagist.org/packages/payeverorg/payever-php-sdk)[![License](https://camo.githubusercontent.com/04749d71c9bb0dec6c42a87a6b32f15d59d251322f38710ec2dda5a90bcd25b9/68747470733a2f2f706f7365722e707567782e6f72672f706179657665726f72672f706179657665722d7068702d73646b2f6c6963656e7365)](https://packagist.org/packages/payeverorg/payever-php-sdk)

The payever PHP SDK enables seamless integration with the payever platform, providing access to its e-commerce & payment features. Designed for developers, this SDK simplifies interaction with payever APIs to create powerful applications and plugins.

This library follows semantic versioning. Read more on [semver.org](http://semver.org).

Troubleshooting
---------------

[](#troubleshooting)

If you faced an issue you can contact us via official support channel -

Requirements
------------

[](#requirements)

- [PHP 5.6.0 and later](http://www.php.net/)
- PHP cURL extension

Installation
------------

[](#installation)

You can use **Composer**

### Composer

[](#composer)

The preferred method is via [composer](https://getcomposer.org). Follow the [installation instructions](https://getcomposer.org/doc/00-intro.md) if you do not already have composer installed.

Once composer is installed, execute the following command in your project root to install this library:

```
composer require payeverorg/payever-php-sdk
```

Documentation
-------------

[](#documentation)

Raw HTTP API docs can be found here -

### Enums

[](#enums)

The are several list of fixed string values used inside API. For convenience they are represented as constants and grouped into classes.

- Payments
    - [`ChannelSet`](lib/Payever/Core/Enum/ChannelSet.php) - list of available payever API channels
    - [`ChannelTypeSet`](lib/Payever/Core/Enum/ChannelTypeSet.php) - list of available payever API channel types
    - [`PaymentMethod`](lib/Payever/Payments/Enum/PaymentMethod.php) - list of available payever payment methods
    - [`Status`](lib/Payever/Payments/Enum/Status.php) - list of available payever payment statuses

### API Clients

[](#api-clients)

HTTP API communication with payever happens through [`PaymentsApiClient`](#paymentsapiclient) API clients.

#### Configuration

[](#configuration)

Each API client requires configuration object as the first argument of client's constructor. In order to get the valid configuration object you need to have valid API credentials:

- Client ID
- Client Secret
- Business UUID

Additionally, you need to tell which API channel you're using:

```
use Payever\Sdk\Core\ClientConfiguration;
use Payever\Sdk\Core\Enum\ChannelSet;

$clientId = 'your-oauth2-client-id';
$clientSecret = 'your-oauth2-client-secret';
$businessUuid = '88888888-4444-4444-4444-121212121212';

$clientConfiguration = new ClientConfiguration();

$clientConfiguration
    ->setClientId($clientId)
    ->setClientSecret($clientSecret)
    ->setBusinessUuid($businessUuid)
    ->setChannelSet(ChannelSet::CHANNEL_MAGENTO)
    ->setApiMode(ClientConfiguration::API_MODE_LIVE)
;
```

NOTE: All examples below assume you have [`ClientConfiguration`](https://github.com/payeverworldwide/core-sdk-php/blob/main/lib/Payever/Core/ClientConfiguration.php) instantiated inside `$clientConfiguration` variable.

#### PaymentsApiClient

[](#paymentsapiclient)

This API client is used in all payment-related interactions.

##### Create payment and obtain redirect url

[](#create-payment-and-obtain-redirect-url)

```
use Payever\Sdk\Payments\Enum\PaymentMethod;
use Payever\Sdk\Payments\Enum\Salutation;
use Payever\Sdk\Payments\Http\MessageEntity\Payment\CartItemEntity;
use Payever\Sdk\Payments\Http\MessageEntity\Payment\ChannelEntity;
use Payever\Sdk\Payments\Http\MessageEntity\Payment\CustomerAddressEntity;
use Payever\Sdk\Payments\Http\MessageEntity\Payment\CustomerEntity;
use Payever\Sdk\Payments\Http\MessageEntity\Payment\PurchaseEntity;
use Payever\Sdk\Payments\Http\MessageEntity\Payment\UrlsEntity;
use Payever\Sdk\Payments\Http\RequestEntity\CreatePaymentRequest;

$channelEntity = new ChannelEntity();
$channelEntity->setName('api');

$purchaseEntity = new PurchaseEntity();
$purchaseEntity
    ->setAmount(500)
    ->setDeliveryFee(100)
    ->setCurrency('EUR');

$customerEntity = new CustomerEntity();
$customerEntity
    ->setType('person')
    ->setEmail('john.doe@example.com')
    ->setPhone('+450001122')
    ->setBirthdate('1990-01-01');

$cartItem = new CartItemEntity();
$cartItem
    ->setName('Product 1')
    ->setIdentifier('product-1')
    ->setSku('product-1')
    ->setUnitPrice(100)
    ->setTaxRate(19)
    ->setTotalAmount(400)
    ->setTotalTaxAmount(19)
    ->setQuantity(4)
    ->setDescription('product 1 description')
    ->setImageUrl('product-1.jpg')
    ->setProductUrl('product-1')
    ->setCategory('category');

$addressEntity = new CustomerAddressEntity();
$addressEntity
    ->setSalutation(Salutation::SALUTATION_MR)
    ->setFirstName('John')
    ->setLastName('Doe')
    ->setCity('Hamburg')
    ->setRegion('Region')
    ->setZip('10111')
    ->setStreet('Awesome street, 10')
    ->setCountry('DE')
    ->setOrganizationName('Company');

$urls = new UrlsEntity();
$urls
    ->setSuccess('http:://your.domain/success?paymentId=--PAYMENT-ID--')
    ->setPending('http:://your.domain/pending?paymentId=--PAYMENT-ID--')
    ->setFailure('http:://your.domain/failure')
    ->setCancel('http:://your.domain/cancel')
    ->setNotification('http:://your.domain/notification?paymentId=--PAYMENT-ID--');

$requestEntity = new CreatePaymentRequest();
$requestEntity
    ->setChannel($channelEntity)
    ->setReference('1001')
    ->setPaymentMethod(PaymentMethod::METHOD_SANTANDER_DE_INSTALLMENT)
    ->setClientIp('192.168.1.1')
    ->setPurchase($purchaseEntity)
    ->setCustomer($customerEntity)
    ->setCart([$cartItem])
    ->setBillingAddress($addressEntity)
    ->setUrls($urls);

try {
    $createPaymentRequest = $paymentsApiClients->createPaymentV3Request($requestEntity);
    $createPaymentResponse = $createPaymentRequest->getResponseEntity();

    header(sprintf('Location: %s', $createPaymentResponse->getRedirectUrl()), true);
    exit;
} catch (\Exception $exception) {
    echo $exception->getMessage();
}
```

##### Retrieve payment details by id

[](#retrieve-payment-details-by-id)

```
use Payever\Sdk\Payments\PaymentsApiClient;
use Payever\Sdk\Payments\Http\ResponseEntity\Result\PaymentResult;

$paymentId = '--PAYMENT-ID--';
$paymentsApiClient = new PaymentsApiClient($clientConfiguration);

try {
    $response = $paymentsApiClient->retrievePaymentRequest($paymentId);
    /** @var PaymentResult $payment */
    $payment = $response->getResponseEntity()->getResult();
    $status = $payment->getStatus();
} catch(\Exception $exception) {
    echo $exception->getMessage();
}
```

##### Cancel the payment by id

[](#cancel-the-payment-by-id)

```
use Payever\Sdk\Payments\PaymentsApiClient;
use Payever\Sdk\Payments\Action\ActionDecider;

$paymentId = '--PAYMENT-ID--';
$paymentsApiClient = new PaymentsApiClient($clientConfiguration);
$actionDecider = new ActionDecider($paymentsApiClient);

try {
    if ($actionDecider->isActionAllowed($paymentId, ActionDecider::ACTION_CANCEL, false)) {
        $paymentsApiClient->cancelPaymentRequest($paymentId);
    }
} catch(\Exception $exception) {
    echo $exception->getMessage();
}
```

##### Trigger Santander shipping-goods payment action

[](#trigger-santander-shipping-goods-payment-action)

```
use Payever\Sdk\Payments\PaymentsApiClient;
use Payever\Sdk\Payments\Action\ActionDecider;

$paymentId = '--PAYMENT-ID--';
$paymentsApiClient = new PaymentsApiClient($clientConfiguration);
$actionDecider = new ActionDecider($paymentsApiClient);

try {
    if ($actionDecider->isActionAllowed($paymentId, ActionDecider::ACTION_SHIPPING_GOODS, false)) {
        $paymentsApiClient->shippingGoodsPaymentRequest($paymentId);
    }
} catch(\Exception $exception) {
    echo $exception->getMessage();
}
```

##### Get Company credit level

[](#get-company-credit-level)

```
use Payever\Sdk\Payments\B2BApiClient;
use Payever\Sdk\Payments\Http\RequestEntity\CompanyCreditRequest;
use Payever\Sdk\Payments\Http\RequestEntity\B2B\CreditCompanyEntity;

$company = new CreditCompanyEntity();
$company->setExternalId('81981372');

$companyCreditRequest = new CompanyCreditRequest();
$companyCreditRequest->setCompany($company);

$b2bApiClient = new B2BApiClient($clientConfiguration);
$result = $b2bApiClient->companyCreditRequest($companyCreditRequest);
```

License
-------

[](#license)

Please see the [license file](LICENSE) for more information.

###  Health Score

26

—

LowBetter than 41% of packages

Maintenance45

Moderate activity, may be stable

Popularity12

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity32

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

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

Unknown

Total

1

Last Release

429d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/22471576?v=4)[payeverdev](/maintainers/payeverdev)[@payeverdev](https://github.com/payeverdev)

---

Top Contributors

[![payeverdev](https://avatars.githubusercontent.com/u/22471576?v=4)](https://github.com/payeverdev "payeverdev (10 commits)")

---

Tags

paymentse-commercepayever

###  Code Quality

TestsPHPUnit

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/payeverorg-payever-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/payeverorg-payever-php-sdk/health.svg)](https://phpackages.com/packages/payeverorg-payever-php-sdk)
```

###  Alternatives

[amsgames/laravel-shop

Package set to provide shop or e-commerce functionality (such as CART, ORDERS, TRANSACTIONS and ITEMS) to Laravel for customizable builds.

4835.9k](/packages/amsgames-laravel-shop)[enupal/stripe

Allows customers sign up for recurring and one-time payments with Stripe, perfect for orders, donations, subscriptions, and events. Create simple payment forms in seconds easily without coding. For Craft CMS 3.x

3416.6k1](/packages/enupal-stripe)

PHPackages © 2026

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