pnz-payments-sdk/README.md

PNZ Payments Account and Transaction API

# Getting Started with Account and Transaction API Specification

## Introduction

Swagger for Account and Transaction API Specification. This is heavily derived from the Open Banking UK API - see www.openbanking.org.uk for details.

## Install the Package

Run the following command from your project directory to install the package from npm:

```bash
npm install pnz-payments-sdk@1.0.0
```

For additional package details, see the [Npm page for the pnz-payments-sdk@1.0.0 npm](https://www.npmjs.com/package/pnz-payments-sdk/v/1.0.0).

## Test the SDK

To validate the functionality of this SDK, you can execute all tests located in the `test` directory. This SDK utilizes `Jest` as both the testing framework and test runner.

To run the tests, navigate to the root directory of the SDK and execute the following command:

```bash
npm run test
```

Or you can also run tests with coverage report:

```bash
npm run test:coverage
```

## Initialize the API Client

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

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| `environment` | `Environment` | The API environment. <br> **Default: `Environment.Production`** |
| `timeout` | `number` | Timeout for API calls.<br>*Default*: `0` |
| `httpClientOptions` | `Partial<HttpClientOptions>` | Stable configurable http client options. |
| `unstableHttpClientOptions` | `any` | Unstable configurable http client options. |
| `bearerAuthCredentials` | [`BearerAuthCredentials`](https://www.github.com/sdks-io/pnz-payments-js-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md) | The credential object for bearerAuth |

### HttpClientOptions

| Parameter | Type | Description |
|  --- | --- | --- |
| `timeout` | `number` | Timeout in milliseconds. |
| `httpAgent` | `any` | Custom http agent to be used when performing http requests. |
| `httpsAgent` | `any` | Custom https agent to be used when performing http requests. |
| `retryConfig` | `Partial<RetryConfiguration>` | Configurations to retry requests. |

### RetryConfiguration

| Parameter | Type | Description |
|  --- | --- | --- |
| `maxNumberOfRetries` | `number` | Maximum number of retries. <br> *Default*: `0` |
| `retryOnTimeout` | `boolean` | Whether to retry on request timeout. <br> *Default*: `true` |
| `retryInterval` | `number` | Interval before next retry. Used in calculation of wait time for next request in case of failure. <br> *Default*: `1` |
| `maximumRetryWaitTime` | `number` | Overall wait time for the requests getting retried. <br> *Default*: `0` |
| `backoffFactor` | `number` | Used in calculation of wait time for next request in case of failure. <br> *Default*: `2` |
| `httpStatusCodesToRetry` | `number[]` | Http status codes to retry against. <br> *Default*: `[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]` |
| `httpMethodsToRetry` | `HttpMethod[]` | Http methods to retry against. <br> *Default*: `['GET', 'PUT']` |

The API client can be initialized as follows:

```ts
const client = new Client({
  bearerAuthCredentials: {
    accessToken: 'AccessToken'
  },
  timeout: 0,
  environment: Environment.Production,
});
```

## Environments

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

### Fields

| Name | Description |
|  --- | --- |
| production | **Default** |
| environment2 | - |

## Authorization

This API uses the following authentication schemes.

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

## List of APIs

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

## Classes Documentation

* [ApiResponse](https://www.github.com/sdks-io/pnz-payments-js-sdk/tree/1.0.0/doc/api-response.md)
* [HttpRequest](https://www.github.com/sdks-io/pnz-payments-js-sdk/tree/1.0.0/doc/http-request.md)
* [ApiError](https://www.github.com/sdks-io/pnz-payments-js-sdk/tree/1.0.0/doc/api-error.md)