# pnz-apicentre-sandbox-sdk

> The sandbox, powered by Middleware New Zealand, is a dedicated environment that mimics an API Provider, as defined in the [Payments NZ API Centre standards](https://paymentsnz.atlassian.net/wiki/spaces/PaymentsNZAPIStandards/overview). This SDK is generat

Latest version **2.3.1** (published 2023-02-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install pnz-apicentre-sandbox-sdk
pnpm add pnz-apicentre-sandbox-sdk
yarn add pnz-apicentre-sandbox-sdk
bun add pnz-apicentre-sandbox-sdk
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.3.1 |
| Published | 2023-02-27 |
| First published | 2023-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10.4.0 |
| Dependencies | 6 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | APIMATIC Ltd |
| Maintainers | sohaibtariq |
| Keywords | SDK, Fintech, Openbanking |

## Links

- npm: https://www.npmjs.com/package/pnz-apicentre-sandbox-sdk
- Homepage: https://www.apimatic.io
- npm.io page: https://npm.io/package/pnz-apicentre-sandbox-sdk

## Dependencies (6)

- [uuid](https://npm.io/package/uuid.md) ^9.0.0
- [request](https://npm.io/package/request.md) ^2.88.2
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^9.0.0
- [@apimatic/core](https://npm.io/package/@apimatic/core.md) ^0.7.9
- [@apimatic/schema](https://npm.io/package/@apimatic/schema.md) ^0.6.0
- [@types/jsonwebtoken](https://npm.io/package/@types/jsonwebtoken.md) ^9.0.1

## Recent versions

- 2.3.1 (latest) — 2023-02-27
- 2.3.0 — 2023-02-27

## README

# Getting Started with Account information PNZ-API-Centre

## Introduction
  The PNZ sandbox, powered by Middleware New Zealand, is a dedicated environment that mimics an API Provider, as defined in the [Payments NZ API Centre standards](https://paymentsnz.atlassian.net/wiki/spaces/PaymentsNZAPIStandards/overview).  
  This client SDK is generated using [APIMatic](https://www.apimatic.io) to enable developers to quickly get up-and-running with the Middleware Sandbox. It contains helper methods for Auth as well as for Initiating Payments.  

  For a more complete SDK reach out to APIMatic at info@apimatic.io


## Initialize the API Client

**_Note:_** Documentation for the client can be found [here.](https://bnz-demo-app.azurewebsites.net/#/typescript/step-by-step-tutorial)

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. |

### 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({
  timeout: 0,
  environment: Environment.Production,
});
```

---
_Source: https://npm.io/package/pnz-apicentre-sandbox-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._