Merge pull request #13 from InsightAppDev/2.0.0

2.0.0
nazarovsa · Mar 19, 2020 · 29a03a8 · 29a03a8
2 parents c285be7 + b90bc9f
commit 29a03a8
Show file tree

Hide file tree

Showing 8 changed files with 1,855 additions and 604 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,38 @@
+2.0.0
+=====================
+Add
+---------------------
+* getAccounts - get wallet accounts
+* createAccount - create account in new currency by alias
+* setDefaultAccount - set default account
+* getPossibleAccountAliases - get possible account aliases
+* getIdentificationData - get wallet identification data
+* getCrossRates - get exchange rates
+* getTransactionInfo - get information about transaction
+* getReceipt - get receipt of transaction
+* checkOnlineCommission - get information about future operation commission
+* identifyWallet - identify wallet 
+* convertCurrency - convert currency at wallet
+* toRequisites - pay by requisites
+
+Update
+---------------------
+* README.md
+* recipients
+* getOperationHistory - update path to v2
+* getOperationStatistics - update path to v2
+* getOperationHistory and getOperationStatistics - now accepts wallet into arguments and not calling getAccountInfo anymore
+
+Rename
+---------------------
+* getOperationStats -> getOperationStatistics
+* requestNewWebHookSecret -> getNewWebHookSecret
+
+Remove
+---------------------
+* getBalance - now you can get same data from getAccounts
+
+Infrastructure
+---------------------
+* Add async api
+* Replace request with axios
diff --git a/README.md b/README.md
@@ -0,0 +1,357 @@
+node-qiwi-api
+================
+[![npm](https://img.shields.io/npm/v/node-qiwi-api)](https://www.npmjs.com/package/node-qiwi-api)
+[![npm](https://img.shields.io/npm/dt/node-qiwi-api.svg)](https://www.npmjs.com/package/node-qiwi-api)
+[![npm](https://img.shields.io/npm/dm/node-qiwi-api.svg)](https://www.npmjs.com/package/node-qiwi-api)
+----------------
+Official [documentation](https://developer.qiwi.com/qiwiwallet/qiwicom_ru.html) for Qiwi api.
+
+Get started
+----------------
+Firstly, get access token at [Qiwi](https://qiwi.com/api).
+```
+npm install node-qiwi-api
+```
+You can use callback and promise based api.
+
+Initialise new wallet instance with your access token:
+```js
+var callbackQiwi = require('node-qiwi-api').callbackApi;
+var asyncQiwi = require('node-qiwi-api').asyncApi;
+
+var callbackWallet = new callbackQiwi(token);
+var asyncWallet = new asyncQiwi(token);
+```
+Now you can get information about your wallet and make money transfers.
+
+Identification data
+----------------
+```js
+wallet.getIdentificationData(wallet, (err, data) => {
+  if(err) {
+    /*hanle error*/
+  }
+  console.log(data);
+})
+```
+**wallet** - wallet number without plus (+) and with prefix (79991234567)
+
+Identify wallet
+----------------
+```js
+wallet.identifyWallet(wallet, requestOptions, (err, data) => {
+  if(err) {
+    /*hanle error*/
+  }
+  console.log(data);
+})
+```
+**wallet** - wallet number without plus (+) and with prefix (79991234567)
+
+requestOptions includes: 
+* **birthDate** - Date of birth (YYYY-MM-DD)
+* **firstName** - First name
+* **middleName** - Middle name
+* **lastName** - Last name
+* **passport** - Serial and number of passport 
+* **snils** - SNILS number
+* **inn** - INN number
+* **oms** - OMS number
+
+Information about account
+----------------
+```js
+wallet.getAccountInfo((err, data) => {
+  if(err) {
+    /*hanle error*/
+  }
+  console.log(data);
+})
+```
+
+Get accounts
+----------------
+```js
+wallet.getAccounts(wallet, (err, data) => {
+  if(err) {
+    /*hanle error*/
+  }
+  console.log(data);
+})
+```
+**wallet** - wallet number without plus (+) and with prefix (79991234567)
+
+Get possible account aliases
+----------------
+Return possible for creation at your wallet account aliases
+```js
+wallet.getPossibleAccountAliases(wallet, (err, data) => {
+  if(err) {
+    /*hanle error*/
+  }
+  console.log(data);
+})
+```
+**wallet** - wallet number without plus (+) and with prefix (79991234567)
+
+Create account
+----------------
+Create account in new currency
+```js
+wallet.createAccount(wallet, accountAlias, (err, data) => {
+  if(err) {
+    /*hanle error*/
+  }
+  console.log(data);
+})
+```
+**wallet** - wallet number without plus (+) and with prefix (79991234567)
+**accountAlias** - Account alias, possible values: *qw_wallet_rub, qw_wallet_kzt, qw_wallet_usd, qw_wallet_eur*
+
+If call was successfull as *data* you will have *{ success: true }*, else *{ success: false }*
+
+Set default account
+----------------
+Set default account for all operations
+```js
+wallet.setDefaultAccount(wallet, accountAlias, (err, data) => {
+  if(err) {
+    /*hanle error*/
+  }
+  console.log(data);
+})
+```
+**wallet** - wallet number without plus (+) and with prefix (79991234567)
+**accountAlias** - Account alias, possible values: *qw_wallet_rub, qw_wallet_kzt, qw_wallet_usd, qw_wallet_eur*
+
+If call was successfull as *data* you will have *{ success: true }*, else *{ success: false }*
+
+Operation history
+----------------
+```js
+wallet.getOperationHistory(wallet, requestOptions, (err, data) => {
+  if(err) {
+    /*hanle error*/
+  }
+  console.log(data);
+})
+```
+**wallet** - wallet number without plus (+) and with prefix (79991234567)
+
+requestOptions includes: 
+* **rows** - Amount of payments in response. Integer from 1 to 50. Required.
+* **operation** - Operation type. ALL - all operations, IN - incoming only, OUT - outgoing only, QIWI_CARD - just payments by QIWI cards (QVC, QVP). Default - ALL
+* **sources** - Payment source. Array of values. Allowable values: QW_RUB - ruble account of wallet, QW_USD - usd account of wallet, QW_EUR - euro account of wallet, CARD - added and not added to wallet cards, MK - account of mobile operator. If not presented, you will receive info from all sources
+* **startDate** - Start date (YYYY-MM-ddThh:mm:ssZ). By default equals yesterday date. Use only with endDate
+* **endDate** - End date (YYYY-MM-ddThh:mm:ssZ). By default equals current date. Use only with startDate
+* **nextTxnDate** - Transaction date (YYYY-MM-ddThh:mm:ssZ), (see nextTxnDate in response). Use only with nextTxnId
+* **nextTxnId** - Previous transaction number (see nextTxnId in response). Use only with nextTxnDate
+Maximum interval between startDate and endDate - 90 days.
+
+As example - information about 25 outgoing payments can be get by next way:
+```js
+wallet.getOperationHistory({rows: 25, operation: "OUT"}, (err, operations) => {
+  /* some code */
+})
+```
+Operations statistics
+----------------
+If you want to see statistics for summs of payments by period of time use this method. Example:
+```js
+wallet.getOperationStatistics(wallet, requestOptions, (err, data) => {
+  if(err) {
+    /*hanle error*/
+  }
+  console.log(data);
+})
+```
+**wallet** - wallet number without plus (+) and with prefix (79991234567)
+
+requestOptions: **operation, sources, startDate, endDate** - Parameters are similar to **getOperationHistory**.
+
+Get transaction info
+----------------
+Example:
+```js
+wallet.getTransactionInfo(transactionId, (err, data) => {
+  if(err) {
+    /*hanle error*/
+  }
+  console.log(data);
+})
+```
+
+Get transaction receipt
+----------------
+Example:
+```js
+wallet.getReceipt(transactionId, requestOptions, (err, data) => {
+  if(err) {
+    /*hanle error*/
+  }
+  console.log(data);
+})
+```
+requestOptions includes: 
+* **type** - Transaction type from getOperationHistory
+* **format** - File format, see wallet.receiptFormat
+
+Transfer to Qiwi wallet
+----------------
+```js
+wallet.toWallet({ amount: '0.01', comment: 'test', account: '+79261234567' }, (err, data) => {
+  if(err) {
+    /* handle err*/
+    }
+  console.log(data);
+})
+```
+* **amount** - Ammount of money
+* **comment** - Commentary for payment.
+* **account** - Receiver phone number (with international prefix)
+
+Transfer to mobile phone
+----------------
+Similar to "transfer to qiwi wallet", but  number without international prefix:
+```js
+wallet.toMobilePhone({ amount: '0.01', comment: 'test', account: '9261234567' }, (err, data) => {
+  if(err) {
+    /* handle err*/
+    }
+  console.log(data);
+})
+```
+
+Transfer to card
+----------------
+Similar to other transfers, but account is card number:
+```js
+wallet.toCard({ amount: '0.01', comment: 'test', account: '5213********0000' }, (err, data) => {
+  if(err) {
+    /* handle err*/
+    }
+  console.log(data);
+})
+```
+
+Transfer to bank account
+----------------
+```js
+wallet.toBank({ amount: '0.01', account: '5213********0000', account_type: '1', exp_date: 'MMYY' }, recipient, (err, data) => {
+  if(err) {
+    /* handle err*/
+    }
+  console.log(data);
+})
+```
+* **ammount** - Ammount of money
+* **account** - Receiver card/account number
+* **account_type** - Type of bank identificator.
+  * for Alfa-bank (Альфа-Банк) - 1
+  * for OTP Bank (АО ОТП БАНК) - 1
+  * for Rosselhozbank (АО РОССЕЛЬХОЗБАНК) - 5
+  * for Russian Standard (Русский Стандарт) - 1
+  * for VTB (ВТБ ПАО) - 5
+  * for Promsvyazbank (Промсвязьбанк) - 7
+  * for Sberbank (ПАО Сбербанк) - 5
+  * for Renessans Credit (Ренессанс Кредит) - 1
+  * for Moscow Credit Bank (ПАО Московский кредитный банк) - 5
+* **exp_date** - Card expiration date (MMYY), в формате ММГГ (as examlpe: 0218 - february 2018). Only for card transfer.
+* **recipient** -
+  * 464 - Alfa-bank (Альфа-Банка)
+  * 466 - Tinkoff Bank (Тинькофф Банк)
+  * 804 - OTP Bank (АО ОТП БАНК)
+  * 810 - Rosselhozbank (АО РОССЕЛЬХОЗБАНК)
+  * 815 - Russian Standard (Русский Стандарт)
+  * 816 - VTB (ВТБ ПАО)
+  * 821 - Promsvyazbank (Промсвязьбанк)
+  * 870 - Sberbank (ПАО Сбербанк)
+  * 881 - Renessans Credit (Ренессанс Кредит)
+  * 1135 - Moscow Credit Bank (ПАО Московский кредитный банк)
+
+Get currency exchange rates
+----------------
+```js
+wallet.getCrossRates((err, data) => {
+  if(err) {
+    /* handle err*/
+    }
+  console.log(data);
+})
+```
+
+Transfer by requisites
+----------------
+```js
+wallet.toCard(requestOptions, (err, data) => {
+  if(err) {
+    /* handle err*/
+    }
+  console.log(data);
+})
+```
+requestOptions includes: 
+* **ammount** - Ammount of money
+* **account** - Receiver account number
+* **bankName** - Receiver bank name 
+* **bik** - Receiver bank bik 
+* **city** - Receiver city 
+* **organizationName** - Receiver organization name 
+* **inn** - Receiver organization inn 
+* **kpp** - Receiver organization kpp 
+* **nds** - 'НДС не облагается' or 'В т.ч. НДС'
+* **purpose** - Purpose of payment
+* **urgent** - 0 or 1. Urgent pay need 10 minutes to complete. Available from 9.00 AM to 8.30 PM (09.00 - 20.30) by Moscow time (GMT+3). Service fee - 25 rubles
+* **senderName** - Sender name 
+* **senderMiddleName** - Sender middle name
+* **senderLastName** - Sender last name
+
+Convert currency at you wallet
+----------------
+```js
+wallet.convertCurrency({amount: 10, currency: wallet.currencyCode.KZT, account:'+79991234567'}, (err, data) => {
+  if(err) {
+    /* handle err*/
+    }
+  console.log(data);
+})
+```
+requestOptions includes: 
+* **account** - Phone number with plus and international prefix, as example +79991234567
+* **currency** - Currency code - 3 number by ISO-4217 (see wallet.currencyCode)
+* **amount** - Amount of money for calculate commission
+* **comment** - Commentary for payment.
+
+Check commission rates
+----------------
+```js
+wallet.checkOnlineCommission(recipient, requestOptions, (err, data) => {
+  if(err) {
+    /* handle err*/
+    }
+  console.log(data);
+})
+```
+**recipient** - Allowable values stored in wallet.recipients
+
+requestOptions includes: 
+* **account** - Phone number with international prefix or card/account number, as example 79991234567
+* **amount** - Amount of money for calculate commission
+
+Check operation commission
+----------------
+```js
+wallet.checkCommission(recipient, (err, data) => {
+  if(err) {
+    /* handle err*/
+    }
+  console.log(data);
+})
+```
+data.content.terms.commission.ranges[i]:
+* **recipient** - Allowable values stored in wallet.recipients
+
+Response contains:
+* **bound** - Payment amount, starting from which the condition applies
+* **rate** - Commission (absolute multiplier)
+* **fixed** - Fixed amount of commission