# @ponchopay/pp-nodejs

> Tools to integrate PonchoPay on NodeJS

Latest version **1.5.0** (published 2026-03-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ponchopay/pp-nodejs
pnpm add @ponchopay/pp-nodejs
yarn add @ponchopay/pp-nodejs
bun add @ponchopay/pp-nodejs
```

## Health

**Score 60/100 (C)** — status: active.

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2026-03-25 |
| First published | 2023-09-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 41.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | info@ponchopay.com |
| Maintainers | carlosv2 |
| Keywords | ponchopay, nodejs, fetch, tools |

## Links

- npm: https://www.npmjs.com/package/@ponchopay/pp-nodejs
- Repository: https://github.com/ponchocare/pp-nodejs
- Homepage: https://github.com/ponchocare/pp-nodejs#readme
- Issues: https://github.com/ponchocare/pp-nodejs/issues
- npm.io page: https://npm.io/package/@ponchopay/pp-nodejs

## Dependencies (2)

- [jose](https://npm.io/package/jose.md) ^6.0.10
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.2

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 1.5.0 (latest) — 2026-03-25
- 1.4.0 — 2026-02-05
- 1.3.0 — 2025-07-21
- 1.2.0 — 2025-04-17
- 1.1.0 — 2024-01-16
- 1.0.1 — 2023-09-13

## README

# pp-nodejs

Tools to integrate PonchoPay on NodeJS

## Installation

Install it from `npm`:

```bash
npm i @ponchopay/pp-nodejs
```

You can also use your favourite package manger like `yarn` or `pnpm`.

## Usage

This package declares the following functions:
- [createToken](https://github.com/ponchocare/pp-nodejs/blob/master/docs/token/createToken.md): This function allows the creation of tokens for the initialisation endpoints.
- [createJWT](https://github.com/ponchocare/pp-nodejs/blob/master/docs/token/createJWT.md): This function allows the creation of JWTs for the payment manipulation endpoints.
- [isValidCallback](https://github.com/ponchocare/pp-nodejs/blob/master/docs/token/isValidCallback.md): Verifies that a request from Poncho does indeed come from Poncho and hasn't been tampered in any way.
- [parseCallback](https://github.com/ponchocare/pp-nodejs/blob/master/docs/token/parseCallback.md): Securely parses a callback received from Poncho only if the callback is verified to come from Poncho.

And the `Client` class which provides the following methods:
- [validateLocationUrn](https://github.com/ponchocare/pp-nodejs/blob/master/docs/client/validateLocationUrn.md): This method allows to validate a location to ensure it is ready to process payments.
- [initiatePayment](https://github.com/ponchocare/pp-nodejs/blob/master/docs/client/initiatePayment.md): This method allows to initialise a payment in PonchoPay.
- [initiateSubscription](https://github.com/ponchocare/pp-nodejs/blob/master/docs/client/initiateSubscription.md): This method allows to initialise a subscription in PonchoPay.
- [updatePaymentMethod](https://github.com/ponchocare/pp-nodejs/blob/master/docs/client/updatePaymentMethod.md): This method allows to change the Payment Method properties.
- [refundPaymentMethod](https://github.com/ponchocare/pp-nodejs/blob/master/docs/client/refundPaymentMethod.md): This method allows to fully or partially refund a Payment Method.
- [cancelPayment](https://github.com/ponchocare/pp-nodejs/blob/master/docs/client/cancelPayment.md): This method allows to cancel a Payment.
- [cancelRecursion](https://github.com/ponchocare/pp-nodejs/blob/master/docs/client/cancelRecursion.md): This method allows to cancel a Recurring Payment.

## Development

### Linting and formatting

To scan the project for linting and formatting errors, run

```bash
npm run lint
```

To automatically fix linting and formatting errors, run

```bash
npm run format
```

### Testing

To ensure the project is bug-free, run

```bash
npm run test
```

---
_Source: https://npm.io/package/@ponchopay/pp-nodejs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._