PHPackages                             paymentassist/paymentassist-php - 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. [API Development](/categories/api)
4. /
5. paymentassist/paymentassist-php

ActiveLibrary[API Development](/categories/api)

paymentassist/paymentassist-php
===============================

PHP SDK for the Payment Assist Partner API

2.1.0(9mo ago)04.0k1MITHTMLPHP &gt;=7.2CI failing

Since Dec 19Pushed 9mo ago3 watchersCompare

[ Source](https://github.com/paymentassist/paymentassist-php)[ Packagist](https://packagist.org/packages/paymentassist/paymentassist-php)[ Docs](https://www.payment-assist.co.uk)[ RSS](/packages/paymentassist-paymentassist-php/feed)WikiDiscussions master Synced 2w ago

READMEChangelog (4)Dependencies (11)Versions (11)Used By (0)

paymentassist-php
=================

[](#paymentassist-php)

PHP SDK for the [Payment Assist](https://www.payment-assist.co.uk) Partner API.

Note

**paymentassist-php v2 is now the default version**. For legacy integrations, please see the [v1 branch](https://github.com/paymentassist/paymentassist-php/tree/v1).

Dependencies
------------

[](#dependencies)

- PHP &gt;= 7.2
- PHP JSON extension
- PHP cURL extension

Workflow
--------

[](#workflow)

[![Payment Assist API Workflow](https://camo.githubusercontent.com/1f3eed2ec389722e0145818d72e216ffc3d0f60dad5dbd7d52bdf85b242d0742/68747470733a2f2f313937393831373435362d66696c65732e676974626f6f6b2e696f2f7e2f66696c65732f76302f622f676974626f6f6b2d6c65676163792d66696c65732f6f2f6173736574732532462d4c42305f773943377546595957445a636978722532462d4d544d4c4f5847356330576a75345850576f4d2532462d4d544d4c526530346a62516950424a386374742532464150492532307765622d666c6f772532302835292e706e673f616c743d6d6564696126746f6b656e3d63303566393733652d373462612d346162662d616464642d323962376637333830656462 "API Workflow")](https://camo.githubusercontent.com/1f3eed2ec389722e0145818d72e216ffc3d0f60dad5dbd7d52bdf85b242d0742/68747470733a2f2f313937393831373435362d66696c65732e676974626f6f6b2e696f2f7e2f66696c65732f76302f622f676974626f6f6b2d6c65676163792d66696c65732f6f2f6173736574732532462d4c42305f773943377546595957445a636978722532462d4d544d4c4f5847356330576a75345850576f4d2532462d4d544d4c526530346a62516950424a386374742532464150492532307765622d666c6f772532302835292e706e673f616c743d6d6564696126746f6b656e3d63303566393733652d373462612d346162662d616464642d323962376637333830656462)

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

[](#installation)

Install with Composer:

`composer require paymentassist/paymentassist-php:dev-v2`

Publish configuration files
---------------------------

[](#publish-configuration-files)

Use composer to publish configuration files:

`composer --working-dir=vendor/paymentassist/paymentassist-php/ run-script publish-config`

Usage
-----

[](#usage)

```
use PaymentAssist\ApiClient;

$config = [
    'debug'                  => true,
    'timeout'                => 120,
    'log'                    => [
        'debug'                       => true,
        'log_file_name'               => 'apiclient.log',
        'log_file_path'               => 'PATH-TO-YOUR-LOGS-FOLDER',
        'log_request_before_response' => true,
        'log_app_name'                => 'ApiClient',
        'log_format'                  => null, // if null, a default format from GuzzleHttp\MessageFormatter class will be used
    ],
    'verify_ssl_certificate' => true,
    'default'                => 'partner_api_v1',
    'connections'            => [
        'partner_api_v1' => [
            'base_uri'               => 'https://api.v1.payment-assist.co.uk',
            'manifest_path'          => 'default', // use manifest files stored within the package
            'api_key'                => 'YOUR-KEY',
            'secret'                 => 'YOUR-SECRET',
            'additional_query_param' => [],
        ],
    ],
];

$client   = ApiClient::instance($config)->setConnection(ApiClient::PARTNER_API_V1);
$response = $client->GetAccountConfigurationDetails();

if ($response->isOK()) {
    $plans = collection(
        $response
            ->getContent()
            ->getData()
            ->getPlans()
            ->toArray()
    )->map(function ($plan) {
        return $plan['name'];
    })->toList();
} else {
    echo($response->getStatus() . ' ' . $response->getReason());
    echo('There was an error fetching plans from the API: ' . $response->getContents()->getMessage());
}
```

In the above example `$config` variable contains a config structure which needs to be provided as an argument to `ApiClient::instance()` static method.

This structure can be stored in the config section of your application. After installing the package you can publish an example config file. Composer script will copy the file `apiclient.php` to the `config` folder in the root folder of your app if it exists, otherwise it will copy the file to the root folder of your app.

Config file contains the structure and the default config values which can be overridden by the values stored in the file `.apiclient.env` which will be copied to the root folder of your app.

Refer to [API documentation](https://api-docs.payment-assist.co.uk) for details of valid endpoints and required params.

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

[](#contributing)

We welcome contributions. There are several ways to help out:

- Create an issue on GitHub, if you have found a bug.
- Write patches for open bugs/feature issues, preferably with test cases included. Please fork our repo, make your changes in a new branch and then open a pull request ensuring the correct target branch.
- Contribute to the [documentation](https://api-docs.payment-assist.co.uk)

Support
-------

[](#support)

For integrations support, please email .

###  Health Score

41

—

FairBetter than 87% of packages

Maintenance58

Moderate activity, may be stable

Popularity18

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity64

Established project with proven stability

 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 ~360 days

Recently: every ~254 days

Total

9

Last Release

273d ago

Major Versions

1.0.1 → 2.0.02022-08-30

v1.x-dev → 2.0.12023-02-01

PHP version history (2 changes)1.0PHP &gt;=5.6

2.0.0PHP &gt;=7.2

### Community

Maintainers

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

---

Top Contributors

[![bmilleare](https://avatars.githubusercontent.com/u/21267?v=4)](https://github.com/bmilleare "bmilleare (7 commits)")[![radek77](https://avatars.githubusercontent.com/u/2394459?v=4)](https://github.com/radek77 "radek77 (6 commits)")[![passistdev](https://avatars.githubusercontent.com/u/34277241?v=4)](https://github.com/passistdev "passistdev (4 commits)")[![TraffordFewster](https://avatars.githubusercontent.com/u/82023031?v=4)](https://github.com/TraffordFewster "TraffordFewster (1 commits)")

---

Tags

phpapisdkapiclientpaymentassistpayment-assist.co.ukpayment assist

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

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

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

###  Alternatives

[checkout/checkout-sdk-php

Checkout.com SDK for PHP

563.6M16](/packages/checkout-checkout-sdk-php)[craftcms/cms

Craft CMS

3.6k3.7M3.4k](/packages/craftcms-cms)[tempest/framework

The PHP framework that gets out of your way.

2.3k37.6k20](/packages/tempest-framework)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

353.6k](/packages/eslazarev-wildberries-sdk)[resend/resend-php

Resend PHP library.

608.3M51](/packages/resend-resend-php)[fingerprint/fingerprint-pro-server-api-sdk

Fingerprint Server API allows you to get, search, and update Events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device. The API also supports collection of Automation Intelligence for requests to your server in edge, pre-origin, or middleware contexts.

33302.1k1](/packages/fingerprint-fingerprint-pro-server-api-sdk)

PHPackages © 2026

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