https://github.com/jfkz/tinkoff-payment-sdk
Tinkoff Payment SDK written in Typescript
https://github.com/jfkz/tinkoff-payment-sdk
api merchant sdk tinkoff tinkoff-api tinkoff-payment tinkoff-sdk typescript
Last synced: 2 months ago
JSON representation
Tinkoff Payment SDK written in Typescript
- Host: GitHub
- URL: https://github.com/jfkz/tinkoff-payment-sdk
- Owner: jfkz
- License: mit
- Created: 2021-04-30T13:24:59.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-02T12:50:55.000Z (4 months ago)
- Last Synced: 2025-03-14T09:18:06.901Z (3 months ago)
- Topics: api, merchant, sdk, tinkoff, tinkoff-api, tinkoff-payment, tinkoff-sdk, typescript
- Language: TypeScript
- Homepage: https://oplata.tinkoff.ru/develop/api/payments/
- Size: 311 KB
- Stars: 16
- Watchers: 3
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# @jfkz/tinkoff-payment-sdk
Original code: Slava Fomin II ([@slavafomin](https://github.com/slavafomin)).
Extended version: [@jfkz](https://github.com/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][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](https://acdn.tinkoff.ru/static/documents/merchant_api_protocoI_e2c.pdf) (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][Got]
(if you are not planning to provide custom implementation):
`npm i -S got`
## RSA key installation
Follow the [official documentation](https://business.tinkoff.ru/openapi/docs#section/Sertifikaty/Vypusk-sertifikata).
## CryptoPro installation and config
1. Download and install CryptoPro 5+ from official site: https://www.cryptopro.ru/products/csp/downloads
2. Configure stores and keys (working manual: http://pushorigin.ru/cryptopro/cryptcp)
3. 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
```js
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)
Copyright (c) 2020 jfkz, Slava Fomin II
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.
[Got]: https://github.com/sindresorhus/got