/qiwi-sdk

:kiwi_fruit: QIWI Bank (qiwi.com) API SDK for node JS. Fully Typed. Covers (Personal & P2P API's)

Primary LanguageTypeScriptMIT LicenseMIT

🥝 NodeJS QIWI SDK

Язык: (🇷🇺 Русский / 🇬🇧 English)

license MIT npm GitHub last commit

QIWI SDK

🍬 Почему именно эта библиотека?

  1. Она написана на TypeScript
  2. Покрывает Personal и P2P секции API
  3. Документация появляется прямо в редакторе, так-как используется JSDoc

📦 Установка

Используя NPM

npm i -S qiwi-sdk

Используя Yarn

yarn add qiwi-sdk

Используя pnpm

pnpm add qiwi-sdk

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

Импорт

// TypeScript
import { P2P, Personal, Detector } from "qiwi-sdk";

// CommonJS
const { P2P, Personal, Detector } = require("qiwi-sdk");

// ESM
import QIWI from "qiwi-sdk";
const { P2P, Personal, Detector } = QIWI;

Выбор API

// Personal - API, отвечающее за работу с конкретным кошельком
const qiwi = new Personal(process.env.QIWI_TOKEN, process.env.QIWI_WALLET);

// P2P - удобное API для выставления счетов
const p2p = new P2P(process.env.QIWI_SECRET_KEY, process.env.QIWI_PUBLIC_KEY);

// Detector - API для определения Provider ID по номеру телефона или карты
const detector = new Detector();

Переменные окружения:

  • QIWI_TOKEN - токен киви, полученный на https://qiwi.com/api
  • QIWI_WALLET - номер телефона кошелька, к которому привязан токен. Формат: 79123456789
  • QIWI_SECRET_KEY и QIWI_PUBLIC_KEY - пара ключей, созданные на https://qiwi.com/p2p-admin/transfers/api

🤝 Интеграция

Примеры:

  1. 🥝 Получение информации о кошельке
  2. 📬 Отправка платежа куда угодно
  3. 🛠️ Создание ключей P2P и создание счёта
  4. 🔐 Получение лимитов (на ESM)
  5. 🤖 Телеграм бот с оплатой напрямую (по номеру кошелька)
  6. 🖥️ Магазин на Express

Документация:

  1. ⚙️ Список методов
  2. 🧑‍⚖️ Лицензия - MIT
  3. 🆙 Список изменений