PHPackages                             propaysystems/payment-platform-api-interface - 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. propaysystems/payment-platform-api-interface

ActiveLibrary[Payment Processing](/categories/payments)

propaysystems/payment-platform-api-interface
============================================

This is my package payment-platform-api-interface

1.0.11(2mo ago)02.9k↓38.9%[1 PRs](https://github.com/PropaySystems/payment-platform-api-interface/pulls)MITPHPPHP ^8.2CI passing

Since Jul 19Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/PropaySystems/payment-platform-api-interface)[ Packagist](https://packagist.org/packages/propaysystems/payment-platform-api-interface)[ Docs](https://github.com/propaysystems/payment-platform-api-interface)[ GitHub Sponsors](https://github.com/PropaySystems)[ RSS](/packages/propaysystems-payment-platform-api-interface/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (8)Versions (32)Used By (0)

Payment platform api interface
==============================

[](#payment-platform-api-interface)

[![Tests](https://github.com/PropaySystems/payment-platform-api-interface/actions/workflows/run-tests.yml/badge.svg)](https://github.com/PropaySystems/payment-platform-api-interface/actions/workflows/run-tests.yml)

This package provides an interface for integrating with the payment API, facilitating seamless interactions and transactions. It simplifies the process of connecting to the payment API by abstracting the underlying HTTP requests and responses into a more user-friendly set of PHP methods. Users can easily install this package via Composer and start integrating their applications with the payment API, leveraging its functionalities to manage contacts, initiate payments, and query transaction statuses, among other features.

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

[](#installation)

You can install the package via composer:

```
composer require propaysystems/payment-platform-api-interface
```

### PHP Usage

[](#php-usage)

```
$client = PaymentPlatformAPI::getInstance() //Singleton
         ->sandbox() //Use sandbox environment
         ->url('https://example.com') //Set host only if you have a custom host
         ->setVersion('v1')
         ->setCredentials('username', 'password');
         or
        ->setToken('132465789132465789');

//Get all contacts
$response = $client->contacts($filters = [], $includes = ['bankAccounts', 'products'], $sort = ['-contact_number'], $version = 'v1', $per_page = 10, $page = 1)->get();

Sorting is ascending by defailt  and can be reversed by adding a hyphen (-) to the start of the property name

Example:
$sort = ['name', '-created_at'];
```

### Laravel Usage

[](#laravel-usage)

Create config file

```
return [
    'url' => env('PAYMENT_PLATFORM_API_URL', ''),
    'version' => env('PAYMENT_PLATFORM_API_VERSION', 'v1'),
    'username' => env('PAYMENT_PLATFORM_API_USERNAME', 'secret'),
    'password' => env('PAYMENT_PLATFORM_API_PASSWORD', 'password'),
];
```

Register in the boot method of the app service provider

```
$this->app->bind(PaymentPlatformAPI::class, function() {
    return PaymentPlatformAPI::getInstance()
        ->url(config('custom.payment-platform-api.url'))
        ->setVersion(config('custom.payment-platform-api.version'))
        ->setCredentials(
            config('custom.payment-platform-api.username'),
            config('custom.payment-platform-api.password')
        );
});
```

Use the singleton class in your application

```
$client = app(PaymentPlatformAPI::class);
```

Testing
-------

[](#testing)

```
composer test
```

Testing Coverage Report
-----------------------

[](#testing-coverage-report)

```
XDEBUG_MODE=coverage ./vendor/bin/pest --coverage --coverage-xml=logs/coverage
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [Marius Odendaal](https://github.com/PropaySystems)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

49

—

FairBetter than 95% of packages

Maintenance87

Actively maintained with recent releases

Popularity22

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 68.6% 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

Every ~29 days

Total

21

Last Release

81d ago

Major Versions

0.0.7 → 1.0.02025-08-04

v0.0.6 → 1.0.12025-09-17

PHP version history (2 changes)0.0.1PHP ^8.1

v0.0.4PHP ^8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/fb26ac16f482619121698ff934f7757be3613df54d11a00c6917a278bb696332?d=identicon)[propay](/maintainers/propay)

---

Top Contributors

[![mariusdatakrag](https://avatars.githubusercontent.com/u/81690364?v=4)](https://github.com/mariusdatakrag "mariusdatakrag (72 commits)")[![Johan-kitching](https://avatars.githubusercontent.com/u/111725304?v=4)](https://github.com/Johan-kitching "Johan-kitching (22 commits)")[![ettiennelouw](https://avatars.githubusercontent.com/u/1754421?v=4)](https://github.com/ettiennelouw "ettiennelouw (5 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (2 commits)")[![jgudhlanga](https://avatars.githubusercontent.com/u/22350355?v=4)](https://github.com/jgudhlanga "jgudhlanga (2 commits)")[![penstej](https://avatars.githubusercontent.com/u/208038073?v=4)](https://github.com/penstej "penstej (2 commits)")

---

Tags

PropaySystemspayment-platform-api-interface

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/propaysystems-payment-platform-api-interface/health.svg)

```
[![Health](https://phpackages.com/badges/propaysystems-payment-platform-api-interface/health.svg)](https://phpackages.com/packages/propaysystems-payment-platform-api-interface)
```

###  Alternatives

[chargebee/chargebee-php

ChargeBee API client implementation for PHP

768.0M9](/packages/chargebee-chargebee-php)[imdhemy/google-play-billing

Google Play Billing

491.3M5](/packages/imdhemy-google-play-billing)[bitpay/sdk

Complete version of the PHP library for the new cryptographically secure BitPay API

42337.5k4](/packages/bitpay-sdk)[buckaroo/sdk

Buckaroo payment SDK

12189.1k9](/packages/buckaroo-sdk)[contica/facturador-electronico-cr

Un facturador de código libre para integrar facturación electrónica en Costa Rica a un proyecto PHP

2128.8k](/packages/contica-facturador-electronico-cr)[karson/mpesa-php-sdk

172.2k](/packages/karson-mpesa-php-sdk)

PHPackages © 2026

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