[QIWI SDK](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / [<internal\>](../modules/index._internal_.md) / WalletPaymentsApi

# Class: WalletPaymentsApi

[index](../modules/index.md).[<internal>](../modules/index._internal_.md).WalletPaymentsApi

# Платежное API
[Документация QIWI](https://developer.qiwi.com/ru/qiwi-wallet-personal/#payments)

**`Export`**

## Hierarchy

- [`WalletApi`](index._internal_.WalletApi.md)

  ↳ **`WalletPaymentsApi`**

## Table of contents

### Constructors

- [constructor](index._internal_.WalletPaymentsApi.md#constructor)

### Properties

- [\_options](index._internal_.WalletPaymentsApi.md#_options)

### Accessors

- [http](index._internal_.WalletPaymentsApi.md#http)
- [walletId](index._internal_.WalletPaymentsApi.md#walletid)

### Methods

- [\_resolveProvider](index._internal_.WalletPaymentsApi.md#_resolveprovider)
- [createFormUrl](index._internal_.WalletPaymentsApi.md#createformurl)
- [getCommission](index._internal_.WalletPaymentsApi.md#getcommission)
- [getRates](index._internal_.WalletPaymentsApi.md#getrates)
- [pay](index._internal_.WalletPaymentsApi.md#pay)
- [quickPay](index._internal_.WalletPaymentsApi.md#quickpay)
- [createFormUrl](index._internal_.WalletPaymentsApi.md#createformurl-1)

## Constructors

### constructor

• **new WalletPaymentsApi**(`options`)

Creates an instance of OptionsWrapper.

**`Memberof`**

OptionsWrapper

#### Parameters

| Name | Type |
| :------ | :------ |
| `options` | [`WalletApiOptions`](../interfaces/index.QIWI.WalletApiOptions.md) |

#### Inherited from

[WalletApi](index._internal_.WalletApi.md).[constructor](index._internal_.WalletApi.md#constructor)

#### Defined in

[apis/options-wrapper.ts:23](https://github.com/AlexXanderGrib/node-qiwi-sdk/blob/501d75e/src/apis/options-wrapper.ts#L23)

## Properties

### \_options

• `Protected` `Readonly` **\_options**: [`WalletApiOptions`](../interfaces/index.QIWI.WalletApiOptions.md)

**`Memberof`**

OptionsWrapper

#### Inherited from

[WalletApi](index._internal_.WalletApi.md).[_options](index._internal_.WalletApi.md#_options)

#### Defined in

[apis/options-wrapper.ts:16](https://github.com/AlexXanderGrib/node-qiwi-sdk/blob/501d75e/src/apis/options-wrapper.ts#L16)

## Accessors

### http

• `Protected` `get` **http**(): [`SimpleJsonHttp`](index.QIWI.SimpleJsonHttp.md)

**`Memberof`**

ApiSubclass

#### Returns

[`SimpleJsonHttp`](index.QIWI.SimpleJsonHttp.md)

#### Inherited from

WalletApi.http

#### Defined in

[apis/api.ts:55](https://github.com/AlexXanderGrib/node-qiwi-sdk/blob/501d75e/src/apis/api.ts#L55)

___

### walletId

• `Protected` `get` **walletId**(): `string`

**`Memberof`**

WalletApi

#### Returns

`string`

#### Inherited from

WalletApi.walletId

#### Defined in

[apis/wallet/api.ts:17](https://github.com/AlexXanderGrib/node-qiwi-sdk/blob/501d75e/src/apis/wallet/api.ts#L17)

## Methods

### \_resolveProvider

▸ `Protected` **_resolveProvider**(`provider`, `account`): `Promise`<`number`\>

**`Throws`**

**`Memberof`**

WalletPaymentsApi

#### Parameters

| Name | Type |
| :------ | :------ |
| `provider` | `undefined` \| `number` \| ``"card"`` \| ``"phone"`` \| ``"qiwi"`` \| ``"yoomoney"`` \| [`Card`](../enums/index.QIWI.QuickPayRecipients.md#card) \| [`Phone`](../enums/index.QIWI.QuickPayRecipients.md#phone) |
| `account` | `string` |

#### Returns

`Promise`<`number`\>

Promise<number>

#### Defined in

[apis/wallet/payments.api.ts:209](https://github.com/AlexXanderGrib/node-qiwi-sdk/blob/501d75e/src/apis/wallet/payments.api.ts#L209)

___

### createFormUrl

▸ **createFormUrl**(`provider`, `options?`): `string`

Данный метод создаёт ссылку на предзаполненную форму оплаты

**`Memberof`**

WalletPaymentsApi

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `provider` | `number` | Идентификатор провайдера |
| `options?` | [`FormUrlOptions`](../modules/index.QIWI.md#formurloptions) | Параметры формы |

#### Returns

`string`

string Ссылка

#### Defined in

[apis/wallet/payments.api.ts:107](https://github.com/AlexXanderGrib/node-qiwi-sdk/blob/501d75e/src/apis/wallet/payments.api.ts#L107)

___

### getCommission

▸ **getCommission**(`provider`, `account`, `amount`, `«destructured»?`): `Promise`<`number`\>

## Комиссионные тарифы

Чтобы узнать комиссию за платеж до его совершения по заданному
набору платежных реквизитов, используйте этот запрос.
Возвращается полная комиссия QIWI Кошелька за платеж в пользу
указанного провайдера с учетом всех тарифов.

**`Memberof`**

WalletPaymentsApi

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `provider` | `number` | Идентификатор провайдера |
| `account` | `string` | Пользовательский идентификатор (номер телефона с международным префиксом, номер карты/счета получателя, и т.д., в зависимости от провайдера) |
| `amount` | `number` | Сумма |
| `«destructured»` | `Object` | - |
| › `accountCurrency` | `undefined` \| [`Currency`](../enums/index.QIWI.Currency.md) | - |
| › `paymentCurrency` | `undefined` \| [`Currency`](../enums/index.QIWI.Currency.md) | - |

#### Returns

`Promise`<`number`\>

#### Defined in

[apis/wallet/payments.api.ts:40](https://github.com/AlexXanderGrib/node-qiwi-sdk/blob/501d75e/src/apis/wallet/payments.api.ts#L40)

___

### getRates

▸ **getRates**(): `Promise`<[`Rate`](../modules/index.QIWI.md#rate)[]\>

Получение курсов валют

**`Memberof`**

WalletPaymentsApi

#### Returns

`Promise`<[`Rate`](../modules/index.QIWI.md#rate)[]\>

Promise<Rate[]>

#### Defined in

[apis/wallet/payments.api.ts:252](https://github.com/AlexXanderGrib/node-qiwi-sdk/blob/501d75e/src/apis/wallet/payments.api.ts#L252)

___

### pay

▸ **pay**(`params`): `Promise`<[`PaymentResponse`](../modules/index.QIWI.md#paymentresponse)\>

[Документация QIWI по методу оплаты](https://developer.qiwi.com/ru/qiwi-wallet-personal/#payments)

**`Memberof`**

WalletPaymentsApi

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | [`PayParameters`](../modules/index.QIWI.md#payparameters) | Параметры платежа |

#### Returns

`Promise`<[`PaymentResponse`](../modules/index.QIWI.md#paymentresponse)\>

Promise<PaymentResponse>

#### Defined in

[apis/wallet/payments.api.ts:129](https://github.com/AlexXanderGrib/node-qiwi-sdk/blob/501d75e/src/apis/wallet/payments.api.ts#L129)

___

### quickPay

▸ **quickPay**(`parameters`): `Promise`<[`PaymentResponse`](../modules/index.QIWI.md#paymentresponse)\>

Метод для отправки платежа с возможностью автоматического вычета
комиссии и распознавания `provider`'а

[Документация QIWI по методу оплаты](https://developer.qiwi.com/ru/qiwi-wallet-personal/#payments)

**`Throws`**

Под капотом создаётся и вызывается `Detector`. Он может выкинуть эту ошибку

**`Memberof`**

WalletPaymentsApi

#### Parameters

| Name | Type |
| :------ | :------ |
| `parameters` | [`QuickPayParameters`](../modules/index.QIWI.md#quickpayparameters) |

#### Returns

`Promise`<[`PaymentResponse`](../modules/index.QIWI.md#paymentresponse)\>

Promise<PaymentResponse>

#### Defined in

[apis/wallet/payments.api.ts:167](https://github.com/AlexXanderGrib/node-qiwi-sdk/blob/501d75e/src/apis/wallet/payments.api.ts#L167)

___

### createFormUrl

▸ `Static` **createFormUrl**(`provider`, `options?`): `string`

Данный метод создаёт ссылку на предзаполненную форму оплаты

**`Static`**

**`Memberof`**

WalletPaymentsApi

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `provider` | `number` | Идентификатор провайдера |
| `options?` | [`FormUrlOptions`](../modules/index.QIWI.md#formurloptions) | Параметры формы |

#### Returns

`string`

string Ссылка

#### Defined in

[apis/wallet/payments.api.ts:75](https://github.com/AlexXanderGrib/node-qiwi-sdk/blob/501d75e/src/apis/wallet/payments.api.ts#L75)