PHPackages                             sdksio/pnz-payments-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. [API Development](/categories/api)
4. /
5. sdksio/pnz-payments-sdk

ActiveLibrary[API Development](/categories/api)

sdksio/pnz-payments-sdk
=======================

PNZ Payments Account and Transaction API

1.0.0(1y ago)02MITPHPPHP ^7.2 || ^8.0

Since Mar 20Pushed 1y agoCompare

[ Source](https://github.com/sdks-io/pnz-payments-php-sdk)[ Packagist](https://packagist.org/packages/sdksio/pnz-payments-sdk)[ Docs](https://pnz-app.azurewebsites.net/)[ RSS](/packages/sdksio-pnz-payments-sdk/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (6)Versions (2)Used By (0)

Getting Started with Account and Transaction API Specification
==============================================================

[](#getting-started-with-account-and-transaction-api-specification)

Introduction
------------

[](#introduction)

Swagger for Account and Transaction API Specification. This is heavily derived from the Open Banking UK API - see [www.openbanking.org.uk](http://www.openbanking.org.uk) for details.

Install the Package
-------------------

[](#install-the-package)

Run the following command to install the package and automatically add the dependency to your composer.json file:

```
composer require "sdksio/pnz-payments-sdk:1.0.0"
```

Or add it to the composer.json file manually as given below:

```
"require": {
    "sdksio/pnz-payments-sdk": "1.0.0"
}
```

You can also view the package at:

Test the SDK
------------

[](#test-the-sdk)

Unit tests in this SDK can be run using PHPUnit.

1. First install the dependencies using composer including the `require-dev` dependencies.
2. Run `vendor\bin\phpunit --verbose` from commandline to execute tests. If you have installed PHPUnit globally, run tests using `phpunit --verbose` instead.

You can change the PHPUnit test configuration in the `phpunit.xml` file.

Initialize the API Client
-------------------------

[](#initialize-the-api-client)

***Note:*** Documentation for the client can be found [here.](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/client.md)

The following parameters are configurable for the API Client:

ParameterTypeDescription`environment``Environment`The API environment.
 **Default: `Environment.PRODUCTION`**`timeout``int`Timeout for API calls in seconds.
*Default*: `0``enableRetries``bool`Whether to enable retries and backoff feature.
*Default*: `false``numberOfRetries``int`The number of retries to make.
*Default*: `0``retryInterval``float`The retry time interval between the endpoint calls.
*Default*: `1``backOffFactor``float`Exponential backoff factor to increase interval between retries.
*Default*: `2``maximumRetryWaitTime``int`The maximum wait time in seconds for overall retrying requests.
*Default*: `0``retryOnTimeout``bool`Whether to retry on request timeout.
*Default*: `true``httpStatusCodesToRetry``array`Http status codes to retry against.
*Default*: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524``httpMethodsToRetry``array`Http methods to retry against.
*Default*: `'GET', 'PUT'``bearerAuthCredentials`[`BearerAuthCredentials`](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md)The Credentials Setter for OAuth 2 Bearer tokenThe API client can be initialized as follows:

```
$client = AccountAndTransactionAPISpecificationClientBuilder::init()
    ->bearerAuthCredentials(
        BearerAuthCredentialsBuilder::init(
            'AccessToken'
        )
    )
    ->environment(Environment::PRODUCTION)
    ->build();
```

Environments
------------

[](#environments)

The SDK can be configured to use a different environment for making API calls. Available environments are:

### Fields

[](#fields)

NameDescriptionproduction**Default**environment2-Authorization
-------------

[](#authorization)

This API uses the following authentication schemes.

- [`HTTPBearerAuthentication (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md)

List of APIs
------------

[](#list-of-apis)

- [Direct Debits](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/controllers/direct-debits.md)
- [Scheduled Payments](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/controllers/scheduled-payments.md)
- [Standing Orders](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/controllers/standing-orders.md)
- [Accounts](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/controllers/accounts.md)
- [Balances](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/controllers/balances.md)
- [Beneficiaries](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/controllers/beneficiaries.md)
- [Offers](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/controllers/offers.md)
- [Party](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/controllers/party.md)
- [Statements](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/controllers/statements.md)
- [Transactions](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/controllers/transactions.md)

Classes Documentation
---------------------

[](#classes-documentation)

- [ApiException](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/api-exception.md)
- [HttpRequest](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/http-request.md)
- [HttpResponse](https://www.github.com/sdks-io/pnz-payments-php-sdk/tree/1.0.0/doc/http-response.md)

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance46

Moderate activity, may be stable

Popularity2

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 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

418d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/ef06f97b4ff5db714f2a124525216538f97338487cd4e2bca22baa32c0bf90cd?d=identicon)[developer-sdksio](/maintainers/developer-sdksio)

---

Top Contributors

[![developer-sdksio](https://avatars.githubusercontent.com/u/135820708?v=4)](https://github.com/developer-sdksio "developer-sdksio (1 commits)")

---

Tags

apipaymentsapimaticsdksioPNZPayment Newzealand

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/sdksio-pnz-payments-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/sdksio-pnz-payments-sdk/health.svg)](https://phpackages.com/packages/sdksio-pnz-payments-sdk)
```

###  Alternatives

[square/square

Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.

793.4M21](/packages/square-square)[transbank/transbank-sdk

Transbank SDK

62626.4k12](/packages/transbank-transbank-sdk)

PHPackages © 2026

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