Add files via upload

d33a3070 · kravets · GitHub · 220feb42 · d33a3070 · d33a3070
--- a/LICENSE
+++ b/LICENSE
--- a/README.md
+++ b/README.md
-# payok
- Node JS module for payok.io
+# PAYOK
+
+> NODE JS модуль, который позволит принимать платежи платёжного агрегатора payok.io
+
+<center>
+  <img src="logo.png" alt="PAYOK" /> 
+</center>
+
+## 📦 Установка
+
+-   **используя `npm`**
+    ```shell
+    npm i payok
+    ```
+-   **используя `Yarn`**
+    ```shell
+    yarn add payok
+    ```
+-   **используя `pnpm`**
+    ```shell
+    pnpm add payok
+    ```
+
+# 🛠️ Использование
+
+```js
+const { PAYOK } = require("payok");
+const payok = new PAYOK({
+    apiId: 1,
+    apiKey: "yourApiKey",
+    secretKey: "yourSecretKey",
+    shop: 2000,
+});
+```
+
+| Параметр  | Тип    | Описание                                    | Обязательный |
+| --------- | ------ | ------------------------------------------- | ------------ |
+| apiId     | number | Ваш идентификатор (ID) API ключа            | +            |
+| apiKey    | string | Ваш API ключ                                | +            |
+| secretKey | string | Секретный ключ, который принадлежит проекту | +            |
+| shop      | number | Идентификатор (ID) проекта                  | +            |
+
+## 💳 Создание ссылки на форму оплаты
+
+---
+
+```js
+payok
+    .getPaymentLink({
+        amount: 10,
+        desc: "Описание вашего товара",
+        success_url: `https://github.com/kravetsone/payok`,
+        email: "email@gmail.ru",
+        id: 123456,
+    })
+    .then((bill) => {
+        console.log(bill); // { payUrl: "https://payok.io/pay?...", paymentId: "98dd5-51e1-a0644"}
+    });
+```
+
+| Параметр    | Тип    | Описание                                                                | Обязательный |
+| ----------- | ------ | ----------------------------------------------------------------------- | ------------ |
+| amount      | number | Сумма платежа                                                           | +            |
+| desc        | string | Название или описание вашего товара                                     | +            |
+| success_url | string | Ссылка, на которую переадресует пользователя после успешной оплаты      | -            |
+| email       | string | Email пользователя                                                      | -            |
+| method      | string | [Способ оплаты](https://payok.io/cabinet/documentation/doc_methods.php) | -            |
+| lang        | string | Язык интерфейса (`RU`/`ENG`)                                            | -            |
+| \*          | any    | Любой ваш параметр, который придёт к вам на вебхук в случае оплаты      | -            |
+
+## ⚙ Создание вебхука (обработчик успешной оплаты)
+
+---
+
+> 🚧 Параметр sign, приходящий вместе с платежём, уже проверен библиотекой, так что с ним вам взаимодействовать не потребуется.
+
+```js
+payok.createWebhook(3000, (payment) => {
+    console.log(payment);
+    /*{
+        payment_id: '51387-77a3-d3724',
+        shop: '2000',
+        amount: '10',
+        profit: '10',
+        desc: 'Описание вашего товара',
+        currency: 'RUB',
+        currency_amount: '10.69',
+        sign: 'b7453a35683171d235dfb13a16b61f41',
+        email: 'email@gmail.ru',
+        date: '11.06.2022 12:13:15',
+        method: 'Qiwi', 
+        custom: { id: '123456' } 
+    }*/
+});
+```
+
+| Параметр | Тип      | Описание                                         | Обязательный |
+| -------- | -------- | ------------------------------------------------ | ------------ |
+| port     | number   | Порт на котором вы хотите раскрыть вебхук        | +            |
+| handler  | function | Функция, которая выполниться при успешной оплате | +            |
+
+### 💰 Получение баланса
+
+---
+
+```js
+payok.api.getBalance().then((res) => {
+    console.log(res); //{ balance: "10.00", ref_balance: "0" }
+});
+```
+
+Без параметров
+
+### 👉 Получить список транзакций
+
+---
+
+```js
+payok.api.getTransaction({ offset: 1 }).then((res) => {
+    console.log(res);
+    /*{
+        {
+            "status": "success"
+            "1": {
+                "transaction": 10000,
+                "email": "example@ex.com",
+                "amount": "1065",
+                "currency": "USD",
+                "currency_amount": "14.26",
+                "comission_percent": 5 ,
+                "comission_fixed": "15",
+                "amount_profit": "1000",
+                "method": Visa/Mastercard,
+                "payment_id": "10500",
+                "description": "Описание транзакции",
+                "date": "26.09.2021 20:40:07",
+                "pay_date": "26.09.2021 21:00:00"
+                "transaction_status": 0
+                "custom_fields": null
+                "webhook_status": 1
+                "webhook_amount": 1
+            }
+        }
+    }*/
+});
+```
+
+| Параметр | Тип    | Описание                          | Обязательный |
+| -------- | ------ | --------------------------------- | ------------ |
+| payment  | string | Идентификатор (ID) платежа        | -            |
+| offset   | number | Пропуск определённого числа строк | -            |
+
+### 👈 Получить список выплат
+
+---
+
+```js
+payok.api.getPayouts({ offset: 1 }).then((res) => {
+    console.log(res);
+    /*{
+        {
+            "status": "success"
+            "1": {
+                "payout": 10000,
+                "method": "card",
+                "reciever": "5000400030002000",
+                "type": "main",
+                "amount": "1000",
+                "comission_percent": 2 ,
+                "comission_fixed": "50",
+                "amount_profit": 930,
+                "date_create": "26.09.2021 20:40:07",
+                "date_pay": "26.09.2021 20:55:01",
+                "status": 0
+            }
+        }
+    }*/
+});
+```
+
+| Параметр  | Тип    | Описание                          | Обязательный |
+| --------- | ------ | --------------------------------- | ------------ |
+| payout_id | string | Идентификатор (ID) выплаты        | -            |
+| offset    | number | Пропуск определённого числа строк | -            |
+
+### ✨ Создание выплаты
+
+---
+
+```js
+payok.api
+    .createPayout({
+        amount: 10,
+        method: "qiwi",
+        reciever: "+79851628442",
+        comission_type: "balance",
+    })
+    .then((res) => {
+        console.log(res);
+        /*{
+            {
+                "status":"success",
+                "remain_balance":"229.44",
+                "data": {
+                    "payout_id": 100,
+                    "method": "card",
+                    "reciever": "5000400030002000",
+                    "amount": 1000,
+                    "comission_percent": 2 ,
+                    "comission_fixed": "50",
+                    "amount_profit": 930,
+                    "date": "26.09.2021 20:40:07",
+                    "payout_status_code": 0,
+                    "payout_status_text": "WAIT"
+                }
+            }
+        }*/
+    });
+```
+
+| Параметр       | Тип    | Описание                                                                | Обязательный |
+| -------------- | ------ | ----------------------------------------------------------------------- | ------------ |
+| amount         | number | Сумма выплаты                                                           | +            |
+| method         | string | [Способ оплаты](https://payok.io/cabinet/documentation/doc_methods.php) | +            |
+| reciever       | string | Реквезиты на которые придёт выплата                                     | +            |
+| comission_type | string | Комиссия с баланса - `balance`, а если с выплаты - `payment`            | +            |
+| reciever       | string | Реквезиты на которые придёт выплата                                     | +            |
+| webhook_url    | string | URL вебхука для отправки статуса выплаты                                | -            |
+
+> Если нашли ошибку, то создайте [ISSUES](https://github.com/kravetsone/payok/issues/new)
--- a/logo.png
+++ b/logo.png
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
+{
+  "name": "payok",
+  "version": "1.0.1",
+  "description": "Node JS module for payok.io",
+  "main": "./lib/index.js",
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kravetsone/payok.git"
+  },
+  "keywords": [
+    "qiwi",
+    "payment",
+    "payment-manager",
+    "cards",
+    "payok",
+    "qiwi-p2p"
+  ],
+  "author": "kravets",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/kravetsone/payok/issues"
+  },
+  "homepage": "https://github.com/kravetsone/payok#readme",
+  "dependencies": {
+    "@fastify/formbody": "^7.0.1",
+    "crypto": "^1.0.1",
+    "fastify": "^4.0.0",
+    "md5": "^2.3.0",
+    "node-fetch": "^2.6.7",
+    "qs": "^6.10.5",
+    "query-string": "^7.1.1"
+  }
+}