Skip to content

Commit

Permalink
chore(docs): add documentation for methods
Browse files Browse the repository at this point in the history
  • Loading branch information
TeaCoder52 committed Nov 21, 2024
1 parent ead0f64 commit 59d45a5
Showing 1 changed file with 78 additions and 0 deletions.
78 changes: 78 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,81 @@ import { YookassaModule } from 'nestjs-yookassa'
})
export class AppModule {}
```

## Методы

**1. Создание платежа**
Создает новый платеж через YooKassa. Этот метод отправляет запрос на создание нового платежа с данными из paymentData и возвращает информацию о созданном платеже.

Параметры:

- paymentData (PaymentCreateRequest): Данные для создания платежа. Пример структуры данных см. ниже.

Пример:

```typescript
const paymentData: PaymentCreateRequest = {
amount: {
value: 1000,
currency: 'RUB'
},
description: 'Test payment',
payment_method_data: {
type: PaymentMethodsEnum.yoo_money
},
confirmation: {
type: 'redirect',
return_url: 'https://example.com/thanks'
},
capture: false
}

const paymentResponse = await this.yookassaService.createPayment(paymentData)
console.log(paymentResponse)
```

**2. Отмена платежа**
Отменяет платеж по его ID.
Параметры:

- paymentId (string): ID платежа, который нужно отменить.

Пример:

```typescript
const paymentId = '123456'
const canceledPaymentDetails =
await this.yookassaService.cancelPayment(paymentId)
console.log(canceledPaymentDetails)
```

**3. Получение платежей**
Получает список всех платежей с возможностью фильтрации по дате и пагинации.

- limit (number): Максимальное количество платежей на страницу (по умолчанию 10).
- from (string): Начальная дата для фильтрации (формат YYYY-MM-DD).
- to (string): Конечная дата для фильтрации (формат YYYY-MM-DD).

Пример:

```typescript
const payments = await this.yookassaService.getPayments(
10,
'2024-01-01',
'2024-12-31'
)
console.log(payments)
```

**3. Получение деталей плтежа**
Получает подробную информацию о платеже по его ID, включая статус, сумму и другие данные.

- paymentId (string): Уникальный идентификатор платежа.

Пример:

```typescript
const paymentId = '123456'
const paymentDetails = await this.yookassaService.getPaymentDetails(paymentId)
console.log(paymentDetails)
```

0 comments on commit 59d45a5

Please sign in to comment.