# nodejs-payu-sdk

> A lightweight library that allows easy communication with the Polish Payu API v2_1.

Latest version **1.0.2** (published 2020-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install nodejs-payu-sdk
pnpm add nodejs-payu-sdk
yarn add nodejs-payu-sdk
bun add nodejs-payu-sdk
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-11-21 |
| First published | 2020-11-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jakub Paprocki |
| Maintainers | sacrize |
| Keywords | nodejs, payu, sdk |

## Links

- npm: https://www.npmjs.com/package/nodejs-payu-sdk
- Repository: https://github.com/Sacrize/nodejs-payu-sdk
- Homepage: https://github.com/Sacrize/nodejs-payu-sdk#readme
- Issues: https://github.com/Sacrize/nodejs-payu-sdk/issues
- npm.io page: https://npm.io/package/nodejs-payu-sdk

## Recent versions

- 1.0.2 (latest) — 2020-11-21
- 1.0.0 — 2020-11-16

## README

# NodeJs Payu SDK

A lightweight library that allows easy communication with the Polish Payu API v2_1.

## Getting Started
Install it via npm:
```bash
npm install nodejs-payu-sdk --save
```
Use the built-in methods:
```javascript
var Payu = require('nodejs-payu-sdk');
var payu = new Payu(clientId, clientSecret, posId, key, environment);
payu.createOrder({ ... })
    .then((res) => { })
    .catch((err) => { });
```
## Available methods
- getShopData()
- getOrder(orderId)
- getOrderTransactions(orderId)
- createOrder(order)
- cancelOrder(orderId)
- refundOrder(orderId, amount, description)
    - amount(optional): empty means full refund
    - description(optional)
- verifyNotification(json, headers)

## License

[MIT](./LICENSE)

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