PHPackages                             payrexx/payrexx - 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. payrexx/payrexx

ActiveLibrary[Payment Processing](/categories/payments)

payrexx/payrexx
===============

Payrexx PHPLib

v2.0.12(2mo ago)20324.9k—5%24[1 issues](https://github.com/payrexx/payrexx-php/issues)5MITPHPPHP ^8.0CI passing

Since Dec 12Pushed 2mo ago7 watchersCompare

[ Source](https://github.com/payrexx/payrexx-php)[ Packagist](https://packagist.org/packages/payrexx/payrexx)[ Docs](https://www.payrexx.com)[ RSS](/packages/payrexx-payrexx/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (6)Versions (72)Used By (5)

payrexx-php SDK
===============

[](#payrexx-php-sdk)

Overview
--------

[](#overview)

This is the official PHP client library for the Payrexx API, supporting API version **1.0 - 1.11**. It enables easy integration with Payrexx payment services from your PHP applications.

---

Versioning
----------

[](#versioning)

- This client library targets **Payrexx API version 1.11**.
- Make sure to use the compatible library version to avoid compatibility issues.
- The current stable release is **2.0.0**, which requires PHP 8.0 or higher.

---

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

[](#requirements)

- **PHP version:** 8.0 or higher (recommended from version 2.0.0 onwards)
- **PHP modules:** cURL extension enabled

---

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

[](#installation)

### Using Composer (recommended)

[](#using-composer-recommended)

If you do not have Composer installed, please visit  for installation instructions.

Add Payrexx SDK to your project via Composer:

```
composer require payrexx/payrexx
```

Alternatively, add this to your composer.json and run composer update:

- For the latest development version: ```
    {
      "require": {
        "payrexx/payrexx": "dev-master"
      }
    }
    ```
- For the stable version 2.0.0: ```
    {
      "require": {
        "payrexx/payrexx": "2.0.0"
      }
    }
    ```

This will install the SDK and generate the necessary autoload files.

---

Quick Start
-----------

[](#quick-start)

1. Instantiate the Payrexx client

    ```
    $instance = 'your-instance-name'; // e.g., 'demo' for https://demo.payrexx.com
    $apiSecret = 'your-api-secret';   // Find this in your Payrexx instance admin panel

    $payrexx = new \Payrexx\Payrexx($instance, $apiSecret);
    ```
2. Create a model object For example, to work with subscriptions:

    ```
    use Payrexx\Models\Request\Subscription;

    $subscription = new Subscription();
    $subscription->setId(1);
    ```
3. Call API methods

    For example, to cancel a subscription:

    ```
    try {
        $response = $payrexx->cancel($subscription);
        $subscriptionId = $response->getId();
    } catch (\Payrexx\PayrexxException $e) {
        // Handle errors
        echo 'Error Code: ' . $e->getCode() . PHP_EOL;
        echo 'Error Message: ' . $e->getMessage() . PHP_EOL;
    }
    ```

### Specifying the API Version

[](#specifying-the-api-version)

The Payrexx PHP SDK constructor supports an optional `$version` parameter that allows you to specify the API version you want to use.

```
$instance = 'your-instance-name';
$apiSecret = 'your-api-secret';

// Specify the API version explicitly (e.g., "1.8")
$apiVersion = '1.8';

$payrexx = new \Payrexx\Payrexx(
    $instance,
    $apiSecret,
    \Payrexx\Communicator::DEFAULT_COMMUNICATION_HANDLER,
    '',           // leave empty if not using a custom API base domain
    $apiVersion   // specify the API version here
);
```

---

Using Platform Accounts (Custom API Base URL)
---------------------------------------------

[](#using-platform-accounts-custom-api-base-url)

If you are working with Platform accounts, you must specify a custom API base domain when instantiating the client.

```
use Payrexx\Communicator;

$apiBaseDomain = 'your.domain.com';

$payrexx = new \Payrexx\Payrexx(
    $instance,
    $apiSecret,
    Communicator::DEFAULT_COMMUNICATION_HANDLER,
    $apiBaseDomain
);
```

Notes:

- `$instance` is the subdomain part of your unique domain.
- For example, if your login domain is client.platform.yourcompany.com, then:
    - `$instance = 'client'`
    - `$apiBaseDomain = 'platform.yourcompany.com'`

---

Documentation and Support
-------------------------

[](#documentation-and-support)

For detailed information about the API endpoints and data models, please refer to the official Payrexx REST API documentation:

###  Health Score

65

—

FairBetter than 99% of packages

Maintenance85

Actively maintained with recent releases

Popularity48

Moderate usage in the ecosystem

Community32

Small or concentrated contributor base

Maturity83

Battle-tested with a long release history

 Bus Factor3

3 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 ~80 days

Recently: every ~18 days

Total

52

Last Release

68d ago

Major Versions

v1.8.11 → v2.0.02025-07-02

PHP version history (3 changes)v1.0.0PHP &gt;=5.4

v1.8.6PHP ^7.4 || ^8.0

v2.0.0PHP ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/6297ff94ef6ee97def36aec9b602fbdf59f1046269817a9bb30a517324abf7c6?d=identicon)[ukramer](/maintainers/ukramer)

---

Top Contributors

[![michaelraess](https://avatars.githubusercontent.com/u/8957580?v=4)](https://github.com/michaelraess "michaelraess (38 commits)")[![vinothss4u](https://avatars.githubusercontent.com/u/16014985?v=4)](https://github.com/vinothss4u "vinothss4u (36 commits)")[![ukramer](https://avatars.githubusercontent.com/u/809922?v=4)](https://github.com/ukramer "ukramer (34 commits)")[![PhilippSchmidPayrexx](https://avatars.githubusercontent.com/u/190356379?v=4)](https://github.com/PhilippSchmidPayrexx "PhilippSchmidPayrexx (10 commits)")[![ruban-kumar](https://avatars.githubusercontent.com/u/78416580?v=4)](https://github.com/ruban-kumar "ruban-kumar (9 commits)")[![vekkon](https://avatars.githubusercontent.com/u/26244609?v=4)](https://github.com/vekkon "vekkon (8 commits)")[![ruban-ss4u](https://avatars.githubusercontent.com/u/103740642?v=4)](https://github.com/ruban-ss4u "ruban-ss4u (6 commits)")[![LLimani](https://avatars.githubusercontent.com/u/97031247?v=4)](https://github.com/LLimani "LLimani (6 commits)")[![mathis-hermann](https://avatars.githubusercontent.com/u/168133948?v=4)](https://github.com/mathis-hermann "mathis-hermann (5 commits)")[![markusliechti](https://avatars.githubusercontent.com/u/96245342?v=4)](https://github.com/markusliechti "markusliechti (5 commits)")[![binhvm2022](https://avatars.githubusercontent.com/u/104546858?v=4)](https://github.com/binhvm2022 "binhvm2022 (2 commits)")[![mallsbill](https://avatars.githubusercontent.com/u/8493200?v=4)](https://github.com/mallsbill "mallsbill (2 commits)")[![lucaweber2](https://avatars.githubusercontent.com/u/111440709?v=4)](https://github.com/lucaweber2 "lucaweber2 (2 commits)")[![jdluca22](https://avatars.githubusercontent.com/u/97027378?v=4)](https://github.com/jdluca22 "jdluca22 (2 commits)")[![Remo](https://avatars.githubusercontent.com/u/129864?v=4)](https://github.com/Remo "Remo (2 commits)")[![lars-gertsch](https://avatars.githubusercontent.com/u/53812165?v=4)](https://github.com/lars-gertsch "lars-gertsch (2 commits)")[![Kaapiii](https://avatars.githubusercontent.com/u/995643?v=4)](https://github.com/Kaapiii "Kaapiii (2 commits)")[![Mark-H](https://avatars.githubusercontent.com/u/312944?v=4)](https://github.com/Mark-H "Mark-H (1 commits)")[![steljo367](https://avatars.githubusercontent.com/u/58253340?v=4)](https://github.com/steljo367 "steljo367 (1 commits)")[![syeo66](https://avatars.githubusercontent.com/u/1178021?v=4)](https://github.com/syeo66 "syeo66 (1 commits)")

---

Tags

creditcardpayment-gatewaypayment-integrationphpsdk-phppaymentgateway

###  Code Quality

TestsPest

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/payrexx-payrexx/health.svg)

```
[![Health](https://phpackages.com/badges/payrexx-payrexx/health.svg)](https://phpackages.com/packages/payrexx-payrexx)
```

###  Alternatives

[lokielse/omnipay-alipay

Alipay gateway for Omnipay payment processing library

587421.0k11](/packages/lokielse-omnipay-alipay)[sudiptpa/omnipay-nabtransact

National Australia Bank (NAB) Transact driver for the Omnipay payment processing library.

1017.2k](/packages/sudiptpa-omnipay-nabtransact)[baklysystems/laravel-paymob

Laravel PayMob online payment gateway package

282.4k](/packages/baklysystems-laravel-paymob)[lucassmacedo/omnipay-mercadopago

MercadoPago gateway for OmniPay

154.6k](/packages/lucassmacedo-omnipay-mercadopago)

PHPackages © 2026

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