QIWI SDK / Modules / index / QIWI / _P2pCompat
Deprecated
Используйте класс P2p и новые сигнатуры методов
Export
-
↳
_P2pCompat
- _options
- bills
- publicKey
- secretKey
- BillCurrency
- BillPaySource
- BillStatus
- BillsApi
- Currency
- PaySource
- Status
- billStatus
- checkNotificationSignature
- createBill
- createBillFormUrl
- getBillStatus
- notificationMiddleware
- rejectBill
- create
- env
- formatLifetime
- formatLifetimeDays
- formatLifetimeMinutes
- httpClientFactory
- patchPayUrl
• new _P2pCompat(secretKey, publicKey?)
Creates an instance of _P2pCompat.
Memberof
_P2pCompat
| Name | Type | Default value |
|---|---|---|
secretKey |
string |
undefined |
publicKey |
string |
"" |
• Protected Readonly _options: P2pApiOptions
Memberof
OptionsWrapper
• Readonly bills: P2pBillsApi
• Readonly publicKey: string = ""
• Readonly secretKey: string
▪ Static Readonly BillCurrency: typeof BillCurrency = BillCurrency
▪ Static Readonly BillPaySource: typeof BillPaySource = BillPaySource
▪ Static Readonly BillStatus: typeof BillStatus = BillStatus
▪ Static Readonly BillsApi: typeof P2pBillsApi = P2pBillsApi
▪ Static Readonly Currency: typeof BillCurrency = BillCurrency
▪ Static Readonly PaySource: typeof BillPaySource = BillPaySource
▪ Static Readonly Status: typeof BillStatus = BillStatus
• get agent(): any
Memberof
WalletCompat
any
P2p.agent
• set agent(agent): void
Memberof
WalletCompat
| Name | Type |
|---|---|
agent |
any |
void
P2p.agent
• get options(): T
Memberof
OptionsWrapperWithGetter
T
P2p.options
▸ billStatus(billId): Promise<BillStatusData>
Метод позволяет проверить статус перевода по счету. Рекомендуется его использовать после получения уведомления о переводе.
Deprecated
Используйте метод getBillStatus
| Name | Type | Description |
|---|---|---|
billId |
string |
Уникальный идентификатор счета в вашей системе. |
Promise<BillStatusData>
Объект счёта
▸ checkNotificationSignature(signature, body): boolean
Проверяет подпись уведомления о статусе счёта
| Name | Type | Description |
|---|---|---|
signature |
string |
Подпись |
body |
BillStatusData | BillStatusBody |
Объект уведомления |
boolean
Признак валидности
▸ createBill(data, billId?): Promise<BillStatusData>
По оплаченным счетам возврат денежных средств не предусмотрен.
Доступно выставление счетов в рублях и тенге.
Надежный способ для интеграции. Параметры передаются
server2server с использованием авторизации. Метод позволяет
выставить счет: при успешном выполнении запроса в ответе
вернется параметр payUrl - ссылка для редиректа
пользователя на форму.
Для тестирования и отладки сервиса рекомендуем выставлять и оплачивать счета суммой 1 рубль.
| Name | Type | Description |
|---|---|---|
data |
BillCreationRequest |
Сформированный запрос на создание счёта |
billId? |
string |
Свой ID счёта. По умолчанию генерируется UUID |
Promise<BillStatusData>
▸ createBillFormUrl(parameters): string
Создаёт ссылку оплаты счёта без запроса к API
| Name | Type | Description |
|---|---|---|
parameters |
PayUrlPatchParameters & BillCustomFieldsExtension & { amount: string | number ; billId?: string ; comment?: string ; customFields?: CustomFields ; lifetime?: string ; themeCode?: string } & { account?: string ; email?: string ; phone?: string } |
GET-параметры ссылки |
string
Ссылка на оплату счёта
▸ getBillStatus(billId): Promise<BillStatusData>
Метод позволяет проверить статус перевода по счету. Рекомендуется его использовать после получения уведомления о переводе.
| Name | Type | Description |
|---|---|---|
billId |
string |
Уникальный идентификатор счета в вашей системе. |
Promise<BillStatusData>
Объект счёта
▸ notificationMiddleware(options?, handler?): RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
[Экспериментально] Упрощает интеграцию с express
| Name | Type | Description |
|---|---|---|
options? |
MiddlewareOptions |
Параметры обработки запроса |
handler? |
BillRequestHandler |
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
В начале файла
const p2p = new QIWI.P2P(process.env.QIWI_PRIVATE_KEY);Вариант 1 - Классический
app.post('/webhook/qiwi', p2p.notificationMiddleware(), (req, res) => {
req.body // Это `BillStatusNotificationBody`
})Вариант 2 - Если нужны подсказки типов
app.post('/webhook/qiwi', p2p.notificationMiddleware({}, (req, res) => {
req.body // Это `BillStatusNotificationBody`
}))Обработка ошибок
app.use((error, request, response, next) => {
console.log(error); // [Error: Notification signature mismatch]
})▸ rejectBill(billId): Promise<BillStatusData>
Метод позволяет отменить счет, по которому не был выполнен перевод.
| Name | Type | Description |
|---|---|---|
billId |
string |
Уникальный идентификатор счета в вашей системе. |
Promise<BillStatusData>
Объект счёта
▸ Static create(secretKey, publicKey?): P2p
Static
Memberof
P2p
| Name | Type | Default value |
|---|---|---|
secretKey |
string |
undefined |
publicKey? |
string |
"" |
P2p
▸ Static env(secretKey?, publicKey?): P2p
Static
Memberof
P2p
| Name | Type | Default value |
|---|---|---|
secretKey? |
string |
environment.QIWI_SECRET_KEY |
publicKey? |
string |
environment.QIWI_PUBLIC_KEY |
P2p
▸ Static formatLifetime(days?): string
Deprecated
Используйте formatLifetimeDays или formatLifetimeMinutes
| Name | Type | Default value | Description |
|---|---|---|---|
days |
number |
1 |
Кол-во дней жизни счёта (может быть не целым числом) |
string
Дата понятная QIWI
▸ Static formatLifetimeDays(days?): string
| Name | Type | Default value | Description |
|---|---|---|---|
days |
number |
1 |
Кол-во дней жизни счёта (может быть не целым числом) |
string
Дата понятная QIWI
▸ Static formatLifetimeMinutes(minutes?): string
| Name | Type | Default value | Description |
|---|---|---|---|
minutes? |
number |
15 |
Кол-во минут жизни счёта (может быть не целым числом) |
string
Дата понятная QIWI
▸ Static httpClientFactory(secretKey): SimpleJsonHttp
Static
Memberof
P2p
| Name | Type |
|---|---|
secretKey |
string |
SimpleJsonHttp
▸ Static patchPayUrl(payUrl, options?): string
Добавляет параметры
| Name | Type |
|---|---|
payUrl |
string |
options? |
PayUrlPatchParameters |
string
Новый URL для оплаты