yookassa
v0.1.1
Published
YooKassa API for Node.js
Downloads
857
Readme
YooKassa API для Node.js
Клиент для работы с платежами по API YooKassa. Подходит тем, у кого способ подключения называется API.
Требования
- Node.js
- npm
Установка
npm i yookassa
Начало работы
const YooKassa = require('yookassa');
const yooKassa = new YooKassa({
shopId: '<Идентификатор магазина>',
secretKey: '<Секретный ключ>'
});
const payment = await yooKassa.createPayment({
amount: {
value: "2.00",
currency: "RUB"
},
payment_method_data: {
type: "bank_card"
},
confirmation: {
type: "redirect",
return_url: "https://www.merchant-website.com/return_url"
},
description: "Заказ №72"
});
API кассы
| Метод | Описание |
| --- | --- |
| createPayment
| Создание платежа |
| getPayment
| Информация о платеже |
| capturePayment
| Подтверждение платежа |
| cancelPayment
| Отмена платежа |
| createRefund
| Создание возврата |
| getRefund
| Информация о возврате |
API платежа
Свойства
| Название | Описание |
| --- | --- |
| isPending
| Равен ли статус платежа pending
|
| isWaitingForCapture
| Равен ли статус платежа waiting_for_capture
|
| isSucceeded
| Равен ли статус платежа succeeded
|
| isCanceled
| Равен ли статус платежа canceled
|
| isResolved
| Равен ли статус платежа succeeded
или canceled
|
| confirmationUrl
| URL для подтверждения |
Методы
| Название | Аргументы | Описание |
| --- | --- | --- |
| reload
| | Получить информацию о платеже |
| capture
| amount | Подтвердить платеж |
| cancel
| | Отменить платеж |
| refund
| amount | Вернуть платеж |
API возврата
Методы
| Название | Аргументы | Описание |
| --- | --- | --- |
| reload
| | Получить информацию о возврате |