PAYOK

NODE JS модуль, который позволит принимать платежи платёжного агрегатора payok.io

PAYOK

📦 Установка

  • используя npm 
    npm i payok
  • используя Yarn 
    yarn add payok
  • используя pnpm 
    pnpm add payok

🛠️ Использование

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) проекта +

💳 Создание ссылки на форму оплаты

payok    .getPaymentLink({        amount: 10,        desc: "Описание вашего товара",        success_url: `https://github.com/kravetsone/payok`,        email: "[email protected]",        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 Способ оплаты –
lang string Язык интерфейса (RU/ENG) –
* any Любой ваш параметр, который придёт к вам на вебхук в случае оплаты –

⚙ Создание вебхука (обработчик успешной оплаты)

💰 Получение баланса 

payok.api.getBalance().then((res) => {    console.log(res); //{ balance: "10.00", ref_balance: "0" }});

👉 Получить список транзакций 

payok.api.getTransaction({ offset: 1 }).then((res) => {    console.log(res);    /*{        {            "status": "success"            "1": {                "transaction": 10000,                "email": "[email protected]",                "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 Пропуск определённого числа строк –

👈 Получить список выплат

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 Пропуск определённого числа строк –

✨ Создание выплаты

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 Способ оплаты +
reciever string Реквезиты на которые придёт выплата +
comission_type string Комиссия с баланса – balance, а если с выплаты – payment +
reciever string Реквезиты на которые придёт выплата +
webhook_url string URL вебхука для отправки статуса выплаты –

Changelog:

1.0.2 – Исправлены проблемы с API запросами (был неверно передан Content-Type). Убраны лишние зависимости (7 => 3)1.0.1 – Фикс множества ошибок.1.0.0 – Релиз библиотеки. Добавлен Readme

GitHub

View Github