index._internal_.WalletWebhooksApi.md

QIWI SDK / Modules / index / <internal> / WalletWebhooksApi

Class: WalletWebhooksApi

index..WalletWebhooksApi

Уведомления (вебхуки)

Хуки или уведомления с данными о событии (платеже/пополнении) отправляются на ваш сервер. В настоящее время поддерживаются только вебхуки (webhook) - сообщения, адресованные веб-сервисам. Для приема вебхуков вам необходимо настроить свой сервер на прием и обработку POST-запросов (Формат запросов).

От вашего сервера успешный ответ 200 OK на входящий запрос должен поступить в течение 1-2 сек. Не дождавшись ответа, сервис КИВИ отправляет еще одно уведомление через 10 минут, потом еще одно через 1 час.

Пулы IP-адресов, с которых сервисы QIWI отправляют webhook:

• 79.142.16.0/20
• 195.189.100.0/22
• 91.232.230.0/23
• 91.213.51.0/24

Если ваш сервер обработки вебхуков работает за брандмауэром, необходимо добавить эти IP-адреса в список разрешенных адресов входящих TCP-пакетов.

Export

Hierarchy

• WalletApi

  ↳ WalletWebhooksApi

Table of contents

Constructors

• constructor

Properties

• _options
• activeId
• keys

Accessors

• http
• walletId

Methods

• _getDefaultHookId
• add
• checkSign
• getActiveWebhook
• getSecret
• remove
• testActiveWebhook
• updateSecret

Constructors

constructor

• new WalletWebhooksApi(options)

Creates an instance of OptionsWrapper.

Memberof

OptionsWrapper

Parameters

Name	Type
options	WalletApiOptions

Inherited from

WalletApi.constructor

Defined in

apis/options-wrapper.ts:23

Properties

_options

• Protected Readonly _options: WalletApiOptions

Memberof

OptionsWrapper

Inherited from

WalletApi._options

Defined in

apis/options-wrapper.ts:16

---

activeId

• Optional activeId: string

Defined in

apis/wallet/webhooks.api.ts:37

---

keys

• keys: Map<string, string>

Defined in

apis/wallet/webhooks.api.ts:36

Accessors

http

• Protected get http(): SimpleJsonHttp

Memberof

ApiSubclass

Returns

SimpleJsonHttp

Inherited from

WalletApi.http

Defined in

apis/api.ts:55

---

walletId

• Protected get walletId(): string

Memberof

WalletApi

Returns

string

Inherited from

WalletApi.walletId

Defined in

apis/wallet/api.ts:17

Methods

_getDefaultHookId

▸ Protected _getDefaultHookId(): string

Memberof

WalletWebhooksApi

Returns

string

Defined in

apis/wallet/webhooks.api.ts:46

---

add

▸ add(parameter, txnType): Promise<WebHookInfo>

Регистрирует обработчик вебхука

Parameters

Name	Type	Description
parameter	string	Адрес сервера обработки вебхуков. Внимание! Длина исходного (не URL-encoded) адреса сервиса обработчика не должна превышать 100 символов.
txnType	0 | 2 | 1	Тип транзакций, по которым будут включены уведомления.. 0 - "входящие", 1 - "исходящие". 2 - "все"

Returns

Promise<WebHookInfo>

Defined in

apis/wallet/webhooks.api.ts:58

---

checkSign

▸ checkSign(transaction): Promise<undefined | boolean>

Проверяет подпись уведомления вебхука

Parameters

Name	Type	Description
transaction	WebhookTransaction	Объект уведомления транзакции вебхука

Returns

Promise<undefined | boolean>

Defined in

apis/wallet/webhooks.api.ts:138

---

getActiveWebhook

▸ getActiveWebhook(): Promise<WebHookInfo>

Returns

Promise<WebHookInfo>

Defined in

apis/wallet/webhooks.api.ts:113

---

getSecret

▸ getSecret(hookId?): Promise<string>

Получает секретный ключ вебхука

Parameters

Name	Type	Description
hookId	string	UUID вебхука

Returns

Promise<string>

Defined in

apis/wallet/webhooks.api.ts:88

---

remove

▸ remove(hookId?): Promise<any>

Удаляет обработчик вебхука

Parameters

Name	Type	Description
hookId?	string	UUID вебхука

Returns

Promise<any>

Defined in

apis/wallet/webhooks.api.ts:75

---

testActiveWebhook

▸ testActiveWebhook(): Promise<any>

Отправляет тестовое уведомление

Link

https://developer.qiwi.com/ru/qiwi-wallet-personal/#hook_test

Returns

Promise<any>

Defined in

apis/wallet/webhooks.api.ts:127

---

updateSecret

▸ updateSecret(hookId?): Promise<string>

Изменяет секретный ключ вебхука

Parameters

Name	Type	Description
hookId	string	UUID вебхука

Returns

Promise<string>

Defined in

apis/wallet/webhooks.api.ts:101