Skip to content

Commit 59d45a5

Browse files
committed
chore(docs): add documentation for methods
1 parent ead0f64 commit 59d45a5

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

README.md

+78
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,81 @@ import { YookassaModule } from 'nestjs-yookassa'
5757
})
5858
export class AppModule {}
5959
```
60+
61+
## Методы
62+
63+
**1. Создание платежа**
64+
Создает новый платеж через YooKassa. Этот метод отправляет запрос на создание нового платежа с данными из paymentData и возвращает информацию о созданном платеже.
65+
66+
Параметры:
67+
68+
- paymentData (PaymentCreateRequest): Данные для создания платежа. Пример структуры данных см. ниже.
69+
70+
Пример:
71+
72+
```typescript
73+
const paymentData: PaymentCreateRequest = {
74+
amount: {
75+
value: 1000,
76+
currency: 'RUB'
77+
},
78+
description: 'Test payment',
79+
payment_method_data: {
80+
type: PaymentMethodsEnum.yoo_money
81+
},
82+
confirmation: {
83+
type: 'redirect',
84+
return_url: 'https://example.com/thanks'
85+
},
86+
capture: false
87+
}
88+
89+
const paymentResponse = await this.yookassaService.createPayment(paymentData)
90+
console.log(paymentResponse)
91+
```
92+
93+
**2. Отмена платежа**
94+
Отменяет платеж по его ID.
95+
Параметры:
96+
97+
- paymentId (string): ID платежа, который нужно отменить.
98+
99+
Пример:
100+
101+
```typescript
102+
const paymentId = '123456'
103+
const canceledPaymentDetails =
104+
await this.yookassaService.cancelPayment(paymentId)
105+
console.log(canceledPaymentDetails)
106+
```
107+
108+
**3. Получение платежей**
109+
Получает список всех платежей с возможностью фильтрации по дате и пагинации.
110+
111+
- limit (number): Максимальное количество платежей на страницу (по умолчанию 10).
112+
- from (string): Начальная дата для фильтрации (формат YYYY-MM-DD).
113+
- to (string): Конечная дата для фильтрации (формат YYYY-MM-DD).
114+
115+
Пример:
116+
117+
```typescript
118+
const payments = await this.yookassaService.getPayments(
119+
10,
120+
'2024-01-01',
121+
'2024-12-31'
122+
)
123+
console.log(payments)
124+
```
125+
126+
**3. Получение деталей плтежа**
127+
Получает подробную информацию о платеже по его ID, включая статус, сумму и другие данные.
128+
129+
- paymentId (string): Уникальный идентификатор платежа.
130+
131+
Пример:
132+
133+
```typescript
134+
const paymentId = '123456'
135+
const paymentDetails = await this.yookassaService.getPaymentDetails(paymentId)
136+
console.log(paymentDetails)
137+
```

0 commit comments

Comments
 (0)