@jfkz/tinkoff-payment-sdk

Original code: Slava Fomin II (@slavafomin).

Extended version: @jfkz

A Node.js SDK for Tinkoff Bank's Payment API.

Features

provides API client to communicate with Tinkoff API using HTTPS
provides Webhook handler to for easier webhook requests processing
HTTP transport agnostic (you can use any HTTP library), Got is supported out of the box
automatically transforms data to/from convenient JavaScript formats (e.g. string to Date)
type-safe, written in TypeScript and ships with complete type declarations for all data types and API requests/responses
support both CryptoPro and RSA signatures for merchant API (actual at 06/15/2021)

Version difference

0.x - old interface for Merchant provider, only CryptoPro is supported
1.x - updated interface for Merchant provider, support both CryptoPro and RSA signatures for request signatures

Installation

Install the package:

npm i -S @jfkz/tinkoff-payment-sdk

Install the Got HTTP client (if you are not planning to provide custom implementation):

npm i -S got

RSA key installation

Follow the official documentation.

CryptoPro installation and config

Download and install CryptoPro 5+ from official site: https://www.cryptopro.ru/products/csp/downloads
Configure stores and keys (working manual: http://pushorigin.ru/cryptopro/cryptcp)
Configure MerchantApi with options.

CryptoPro official manual: https://www.cryptopro.ru/sites/default/files/products/cryptcp/cryptcp_5.0.x.pdf

Remember: CryptoPro algorithm use intensive file i/o operations by design. Please, reduce count of your operations and/or use fast drive when use this module.

Example: Init Payment

import {
  PayType,
  ApiManager,
  RequestHttpClient,
  InitPaymentResponsePayload
} from '@jfkz/tinkoff-payment-sdk';

import Request from 'request-promise-native'; // need install

const config = {
  terminal : 'TERMINAL_KEY',
  password : 'PASSWORD'
};

const ApiManagerInstance = new ApiManager({
  httpClient : new RequestHttpClient({
    request : Request
  }),
  terminalKey : config.terminal,
  password : config.password
});

ApiManagerInstance.initPayment({
  OrderId: '1',
  Amount: 10,
  PayType: PayType.SingleStage,
}).then((data : InitPaymentResponsePayload) => {
  console.log('Init response:', data);
});

More examples

@todo

License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

TimPchelintsev/tinkoff-payment-sdk