- Detector
- DetectorApiOptions
- DetectorCompat
- DetectorError
- NodeQiwi
- P2P
- P2PNotificationError
- P2PPaymentError
- P2p
- P2pApiError
- P2pApiErrorResponse
- P2pApiOptions
- P2pAuthorizationError
- P2pBillNotificationError
- P2pCompat
- Personal
- PersonalApiError
- QiwiBillPaymentsAPI
- URL
- URLSearchParameters
- Wallet
- WalletApiError
- WalletApiErrorResponse
- WalletApiOptions
- WalletApiShortError
- WalletApiShortErrorResponse
- WalletAuthorizationError
- WalletCompat
- _P2pCompat
- _P2pCompatBillPayments
- _WalletCompat
- _WalletCompatNodeQiwi
- default
- BillCurrency
- BillPaySource
- BillRefundStatus
- BillStatus
- CardActionStatus
- CardStatus
- ChequeFormat
- CommissionPayer
- Currency
- LimitType
- PaymentHistorySource
- PersonIdentificationLevel
- QuickPayRecipients
- Recipients
- TimeSpan
- TransactionStatus
- TransactionType
- Account
- AccountOffer
- AnyParameters
- AnyRecord
- BillCreateParameters
- BillCreationRequest
- BillCurrencyAny
- BillCurrencyPlain
- BillError
- BillFormParameters
- BillMoneyAmount
- BillPayResponse
- BillPaySourceAny
- BillPaySourcePlain
- BillRefundStatusAny
- BillRefundStatusData
- BillRefundStatusPlain
- BillStatusAny
- BillStatusBody
- BillStatusData
- BillStatusNotificationBody
- BillStatusPlain
- BillsGetParameters
- CardActionStatusAny
- CardActionStatusPlain
- CardRenameResponse
- CardRequisitesResponse
- CardResponse
- CardStatusAny
- CardStatusPlain
- CardUnblockResponse
- ChequeFormatAny
- ChequeFormatPlain
- CodeResponse
- Collection
- CommissionPayerAny
- CommissionPayerPlain
- CommissionResponse
- CurrencyPlain
- FormUrlOptions
- FreePayFields
- GetAccountOffersResponse
- GetAccountsResponse
- GetPaymentHistoryParameters
- GetPaymentHistoryParametersBase
- GetPaymentHistoryParametersStartEnd
- GetPaymentHistoryTotalParameters
- GetPaymentHistoryTotalResponse
- GetTransactionsHistoryResponse
- Headers
- HmacOptions
- IdentificationBase
- IdentificationResponse
- KeyPair
- Limit
- LimitTypeAny
- LimitTypePlain
- LimitsResponse
- LockableField
- MoneyAmount
- MoneyAmountString
- NicknameData
- ObjectKey
- PayParameters
- PayUrlPatchParameters
- PaymentCommissionRequest
- PaymentHistorySourceAny
- PaymentHistorySourcePlain
- PaymentResponse
- PersonIdentificationLevelAny
- PersonIdentificationLevelPlain
- PersonProfile
- PrettyTokenResponse
- ProviderInfo
- QuickPayParameters
- QuickPayRecipientsAny
- QuickPayRecipientsPlain
- Rate
- ReadonlyRecord
- RefundCreationRequest
- Restrictions
- ShortTokenResponse
- StringOrNumber
- TimeSpanKeys
- TimeSpanMapping
- TokenResponse
- Transaction
- TransactionStatusAny
- TransactionStatusPlain
- TransactionTypeAny
- TransactionTypePlain
- URLResult
- WebHookInfo
- WebhookTransaction
- collect
- compareHmac
- compareQiwiHmac
- formatAltLifetimeDate
- formatDate
- formatOffsetAltLifetimeDate
- formatOffsetDate
- formatQuerystring
- generateUUID
- url
Re-exports Detector
Re-exports DetectorApiOptions
Re-exports DetectorCompat
Re-exports DetectorError
Renames and re-exports _WalletCompatNodeQiwi
Renames and re-exports _P2pCompat
Renames and re-exports P2pBillNotificationError
Renames and re-exports P2pApiError
Re-exports P2p
Re-exports P2pApiError
Re-exports P2pApiErrorResponse
Re-exports P2pApiOptions
Re-exports P2pAuthorizationError
Re-exports P2pBillNotificationError
Renames and re-exports _P2pCompat
Renames and re-exports _WalletCompat
Renames and re-exports WalletApiError
Renames and re-exports _P2pCompatBillPayments
Re-exports URL
Re-exports URLSearchParameters
Re-exports Wallet
Re-exports WalletApiError
Re-exports WalletApiErrorResponse
Re-exports WalletApiOptions
Re-exports WalletApiShortError
Re-exports WalletApiShortErrorResponse
Re-exports WalletAuthorizationError
Renames and re-exports _WalletCompat
Re-exports _P2pCompat
Re-exports _P2pCompatBillPayments
Re-exports _WalletCompat
Re-exports _WalletCompatNodeQiwi
Renames and re-exports QIWI
Ƭ Account: Object
Name | Type | Description |
---|---|---|
alias |
string |
Псевдоним пользовательского баланса |
balance |
MoneyAmount | null |
- |
bankAlias |
string |
Псевдоним банка |
currency |
Currency |
Код валюты баланса (number-3 ISO-4217) |
defaultAccount? |
boolean |
- |
fsAlias |
string |
Псевдоним банковского баланса |
hasBalance |
boolean |
Логический признак реального баланса в системе QIWI Кошелек (не привязанная карта, не счет мобильного телефона и т.д.) |
title |
string |
Название соответствующего счета кошелька |
type |
{ id : string ; title : string } |
Сведения о счете |
type.id |
string |
Описание счета |
type.title |
string |
Описание счета |
apis/wallet/wallet.types.ts:727
Ƭ AccountOffer: Object
Name | Type | Description |
---|---|---|
alias |
string |
Псевдоним счета |
currency |
Currency |
ID валюты счета |
apis/wallet/wallet.types.ts:768
Ƭ AnyParameters: any
[]
Ƭ AnyRecord: ReadonlyRecord
<string
, unknown
>
Ƭ BillCreateParameters: BillCreationRequest
& PayUrlPatchParameters
& { billId?
: string
}
Ƭ BillCreationRequest: BillCustomFieldsExtension
& { amount
: BillMoneyAmount
; comment?
: string
; customFields?
: CustomFields
; customer?
: { account?
: string
; email?
: string
; phone?
: string
} ; expirationDateTime?
: string
| Date
}
Ƭ BillCurrencyAny: BillCurrency
| BillCurrencyPlain
Ƭ BillCurrencyPlain: keyof typeof BillCurrency
Ƭ BillError: Object
Name | Type | Description |
---|---|---|
datetime |
string |
Дата и время ответа |
description |
string |
Вот это надо пихать в поле Error.message |
errorCode |
string |
Внутренний код ошибки |
serviceName |
string |
Название сервиса, зачастую начинается на invoicing |
traceId |
string |
Хз что это |
userMessage |
string |
Ƭ BillFormParameters: PayUrlPatchParameters
& BillCustomFieldsExtension
& { amount
: string
| number
; billId?
: string
; comment?
: string
; customFields?
: CustomFields
; lifetime?
: string
; themeCode?
: string
} & BillCreationRequest
["customer"
]
Ƭ BillMoneyAmount: Object
Name | Type | Description |
---|---|---|
currency |
BillCurrencyAny |
Валюта суммы счета. Возможные значения: - RUB - рубли - KZT - тенге |
value |
number | string |
Сумма, на которую выставляется счет, округленная в меньшую сторону до 2 десятичных знаков |
Ƭ BillPayResponse: Object
Name | Type | Description |
---|---|---|
WALLET_ACCEPT_PAY_RESULT |
any |
- |
invoice_status |
string |
Строка кода статуса оплаты счета, PAID_STATUS . Любой другой статус означает неуспех платежной транзакции. |
is_sms_confirm |
boolean |
Признак подтверждения по SMS |
apis/wallet/wallet.types.ts:1471
Ƭ BillPaySourceAny: BillPaySource
| BillPaySourcePlain
Ƭ BillPaySourcePlain: "qw"
| "card"
| "mobile"
Ƭ BillRefundStatusAny: BillRefundStatus
| BillRefundStatusPlain
Ƭ BillRefundStatusData: Object
Name | Type |
---|---|
amount |
BillMoneyAmount |
datetime |
string |
refundId |
string |
status |
BillRefundStatusAny |
Ƭ BillRefundStatusPlain: keyof typeof BillRefundStatus
Ƭ BillStatusAny: BillStatus
| BillStatusPlain
Ƭ BillStatusBody: Object
Name | Type |
---|---|
bill |
BillStatusNotificationBody |
Ƭ BillStatusData: Object
Name | Type | Description |
---|---|---|
amount |
BillMoneyAmount |
Данные о сумме счета |
billId |
string |
Уникальный идентификатор выставляемого счета в вашей системе |
comment? |
string |
Комментарий к счету |
creationDateTime |
string |
Системная дата создания счета. Формат даты: ГГГГ-ММ-ДДTчч:мм:сс |
customFields? |
CustomFields |
Объект строковых дополнительных параметров, переданных вами |
customer? |
BillCreationRequest ["customer" ] |
Идентификаторы пользователя |
expirationDateTime |
string |
Срок действия созданной формы для перевода. Формат даты: ГГГГ-ММ-ДДTчч:мм:сс+\-чч:мм |
payUrl |
string |
Ссылка для переадресации пользователя на созданную форму |
recipientPhoneNumber? |
string |
Номер телефона привязанный к киви кошельку, на который совершается платёж |
siteId |
string |
Ваш идентификатор в системе p2p.qiwi |
status |
{ changedDateTime : string ; value : BillStatusAny } |
- |
status.changedDateTime |
string |
Дата обновления статуса |
status.value |
BillStatusAny |
Текущий статус счета |
Ƭ BillStatusNotificationBody: BillStatusData
Ƭ BillStatusPlain: keyof typeof BillStatus
Ƭ BillsGetParameters: Object
Name | Type | Description |
---|---|---|
max_creation_datetime? |
number |
Верхняя временная граница для поиска счетов, Unix-time |
min_creation_datetime? |
number |
Нижняя временная граница для поиска счетов, Unix-time |
next_creation_datetime? |
number |
Начальное время для поиска (возвращаются только счета, выставленные ранее этого времени), Unix-time. Используется для продолжения списка, разбитого на страницы. |
next_id? |
number |
Начальный идентификатор счета для поиска. Будет возвращен список счетов с идентификаторами, равными или меньше этого значения. Используется для продолжения списка, разбитого на страницы. |
rows? |
number |
Максимальное число счетов в ответе, для разбивки списка на страницы. Целое число от 1 до 50. По умолчанию возвращается не более 50 счетов. |
statuses? |
string |
Статус неоплаченного счета. Обязательный параметр. Только строка READY_FOR_PAY |
apis/wallet/wallet.types.ts:1431
Ƭ CardActionStatusAny: CardActionStatus
| CardActionStatusPlain
apis/wallet/wallet.types.ts:1073
Ƭ CardActionStatusPlain: keyof typeof CardActionStatus
apis/wallet/wallet.types.ts:1072
Ƭ CardRenameResponse: Object
Name | Type | Description |
---|---|---|
error |
string |
Текстовое описание ошибки |
errorCode |
string |
Код ошибки |
status |
OK | FAIL |
- |
apis/wallet/wallet.types.ts:1097
Ƭ CardRequisitesResponse: Object
▪ [key: string
]: any
Name | Type | Description |
---|---|---|
cvv |
string |
CVV карты |
errorCode |
string |
Код ошибки |
pan |
string |
Полный номер карты |
status |
CardActionStatusAny |
- |
apis/wallet/wallet.types.ts:1082
Ƭ CardResponse: Object
Name | Type | Description |
---|---|---|
balance |
MoneyAmount | null |
Данные баланса карты |
info |
{ [key: string] : any ; alias : "qvc-cpa" | "qvc-cpa-debit" | "qvp-gold" ; details : { description : string ; features : string [] ; images : ImageObject [] ; imagesDet : ImageObject [] ; imagesMin : ImageObject [] ; info : string ; offerLink : string ; requisites : NameValueObject [] ; tariffLink : string ; tariffs : NameValueObject [] } ; name : string ; period : string ; price : MoneyAmount } |
Тарифы и банковские реквизиты карты |
info.alias |
"qvc-cpa" | "qvc-cpa-debit" | "qvp-gold" |
Тип карты |
info.details |
{ description : string ; features : string [] ; images : ImageObject [] ; imagesDet : ImageObject [] ; imagesMin : ImageObject [] ; info : string ; offerLink : string ; requisites : NameValueObject [] ; tariffLink : string ; tariffs : NameValueObject [] } |
- |
info.details.description |
string |
Описание карты |
info.details.features |
string [] |
Список возможностей карты на русском |
info.details.images |
ImageObject [] |
Изображения карты для лендинга с "примерными" данными |
info.details.imagesDet |
ImageObject [] |
Изображения карты без данных |
info.details.imagesMin |
ImageObject [] |
Иконки карты |
info.details.info |
string |
Краткое описание тарифа карты. Пример: 99 ₽, действует 1 год |
info.details.offerLink |
string |
Ссылка на договор оферты на выпуск карты |
info.details.requisites |
NameValueObject [] |
Список пар "ключ-значение" с данными банковских реквизитов для пополнения карты |
info.details.tariffLink |
string |
Ссылка на описание тарифа |
info.details.tariffs |
NameValueObject [] |
Список условий обслуживания карты |
info.name |
string |
Название карты |
info.period |
string |
Период обслуживания (по тарифу). Пример: за год |
info.price |
MoneyAmount |
Тариф карты: - amount - Стоимость обслуживания - currency - Код валюты баланса (по ISO) |
qvx |
{ activated : string ; blockedDate : string ; cardAlias : string ; cardExpire : string ; cardExpireMonth : string ; cardExpireYear : string ; cardLimit : null | { currencyCode : Currency ; value : number } ; cardType : CardType ; id : number ; maskedPan : string ; smsResended : string ; status : CardStatus ; txnId : string ; unblockAvailable : boolean } |
Общая информация о карте |
qvx.activated |
string |
Дата активации карты в формате: 2022-01-31T00:00:00+03:00 |
qvx.blockedDate |
string |
Дата блокировки в формате: 2022-01-31T00:00:00+03:00 |
qvx.cardAlias |
string |
Название карты в интерфейсе сайта qiwi.com |
qvx.cardExpire |
string |
Срок действия карты в формате: 2022-01-31T00:00:00+03:00 |
qvx.cardExpireMonth |
string |
Месяц окончания действия карты. Например: 01 |
qvx.cardExpireYear |
string |
Год окончания действия карты. Например: 2022 |
qvx.cardLimit |
null | { currencyCode : Currency ; value : number } |
- |
qvx.cardType |
CardType |
Вид карты |
qvx.id |
number |
ID карты |
qvx.maskedPan |
string |
Маскированный номер карты (отображаются только последние 4 цифры). Пример: ****9078 |
qvx.smsResended |
string |
Дата высылки СМС с реквизитами в формате: 2022-01-31T00:00:00+03:00 |
qvx.status |
CardStatus |
Текущий статус карты |
qvx.txnId |
string |
ID транзакции заказа карты |
qvx.unblockAvailable |
boolean |
Признак возможности разблокировать карту |
apis/wallet/wallet.types.ts:957
Ƭ CardStatusAny: CardStatus
| CardStatusPlain
apis/wallet/wallet.types.ts:934
Ƭ CardStatusPlain: keyof typeof CardStatus
apis/wallet/wallet.types.ts:933
Ƭ CardUnblockResponse: Object
Name | Type |
---|---|
confirmationId |
null |
nextConfirmationRequest |
null |
operationId |
null |
status |
CardActionStatusAny |
apis/wallet/wallet.types.ts:1075
Ƭ ChequeFormatAny: ChequeFormat
| ChequeFormatPlain
apis/wallet/wallet.types.ts:84
Ƭ ChequeFormatPlain: keyof typeof ChequeFormat
apis/wallet/wallet.types.ts:83
Ƭ CodeResponse: Object
Name | Type |
---|---|
code |
string |
apis/wallet/wallet.types.ts:888
Ƭ Collection<T
>: Iterable
<T
> | ArrayLike
<T
>
Name |
---|
T |
Ƭ CommissionPayerAny: CommissionPayer
| CommissionPayerPlain
apis/wallet/wallet.types.ts:1247
Ƭ CommissionPayerPlain: keyof typeof CommissionPayer
apis/wallet/wallet.types.ts:1246
Ƭ CommissionResponse: Object
Name | Type | Description |
---|---|---|
enrollmentSum |
MoneyAmountString |
Сумма зачисления |
fundingSourceCommission |
MoneyAmountString |
Комиссия источника средств. Обычно 0 |
providerId |
number |
ID провайдера |
qwCommission |
MoneyAmountString |
Комиссия КИВИ |
withdrawSum |
MoneyAmountString |
Сумма списания |
withdrawToEnrollmentRate |
number |
- |
apis/wallet/wallet.types.ts:1524
Ƭ CurrencyPlain: keyof typeof Currency
apis/wallet/wallet.types.ts:68
Ƭ FormUrlOptions: Object
Name | Type | Description |
---|---|---|
account? |
string |
Формат совпадает с форматом параметра fields.account при оплате соответствующих провайдеров: для провайдера 99 - номер кошелька получателя; для провайдеров сотовой связи - номер мобильного телефона для пополнения (без префикса 8); для провайдеров перевода на карту - номер банковской карты получателя (без пробелов), для других провайдеров - идентификатор пользователя. Для провайдера 99999 указывается никнейм или номер кошелька получателя (задайте соответствующее значение параметра extra['accountType'] ). |
accountType? |
string |
Параметр используется только для ID=99999. Значение определяет перевод на QIWI кошелек по никнейму или по номеру кошелька. Если вы не хотите, чтобы пользователь видел номер вашего кошелька на форме, используйте перевод по никнейму. - phone - для перевода по номеру - nickname - для перевода по никнейму. |
amount? |
number |
Сумма платежа в рублях |
blocked? |
LockableField [] |
Признак неактивного поля формы. Пользователь не сможет менять значение данного поля. Каждый параметр задает соответствующее поле формы и нумеруется начиная с нуля (blocked[0], blocked[1] и т.д.). Если не указан, пользователь сможет изменить все поля формы. Допустимые значения: - sum - поле "сумма платежа", - account - поле "номер счета/телефона/карты", - comment - поле "комментарий". Пример (неактивное поле суммы платежа): blocked[0]=sum |
comment? |
string |
Комментарий. Параметр используется только для ID=99 |
custom? |
Record <string , unknown > |
- |
apis/wallet/wallet.types.ts:838
Ƭ FreePayFields: Object
Name | Type | Description |
---|---|---|
account |
string |
Номер счета получателя |
city |
string |
Город местонахождения получателя |
extra_to_bik |
string |
БИК банка получателя. Почти всегда равен to_bik |
from_name |
string |
Имя плательщика |
from_name_f |
string |
Фамилия плательщика |
from_name_p |
string |
Отчество плательщика |
goal |
string |
Назначение платежа |
info |
"Коммерческие организации" |
- |
is_commercial |
"1" |
- |
name |
string |
Наименование банка получателя. Например: ПАО "Сбербанк" |
nds |
"НДС не облагается" | "В т.ч. НДС" |
Признак уплаты НДС. Если вы оплачиваете квитанцию и в ней не указан НДС, то строка НДС не облагается . В ином случае, строка В т.ч. НДС . |
requestProtocol |
"qw1" |
- |
toServiceId |
"1717" |
- |
to_bik |
string |
БИК банка получателя |
to_inn |
string |
ИНН организации |
to_kpp |
string |
КПП организации |
to_name |
string |
Наименование организации. Например: ООО "Технический Центр ДЕЛЬТА" |
urgent |
"0" | "1" |
Признак срочного платежа (0 - нет, 1 - да). Срочный платеж выполняется от 10 минут. Возможен по будням с 9:00 до 20:30 по московскому времени. Стоимость услуги — 25 рублей. |
apis/wallet/wallet.types.ts:1107
Ƭ GetAccountOffersResponse: AccountOffer
[]
apis/wallet/wallet.types.ts:776
Ƭ GetAccountsResponse: Object
Name | Type | Description |
---|---|---|
accounts |
Account [] |
Массив балансов |
apis/wallet/wallet.types.ts:763
Ƭ GetPaymentHistoryParameters: GetPaymentHistoryParametersBase
| GetPaymentHistoryParametersBase
& GetPaymentHistoryParametersStartEnd
| GetPaymentHistoryParametersBase
& { nextTxnDate
: string
; nextTxnId
: number
}
apis/wallet/wallet.types.ts:489
Ƭ GetPaymentHistoryParametersBase: Object
Name | Type | Description |
---|---|---|
operation? |
TransactionTypeAny |
Тип операций в отчете, для отбора. Допустимые значения: - ALL - все операции, - IN - только пополнения, - OUT - только платежи, - QIWI_CARD - только платежи по картам QIWI (QVC, QVP). По умолчанию ALL Default "ALL" |
qvxCardId? |
StringOrNumber |
- |
rows |
number |
Число платежей в ответе, для разбивки отчета на страницы. Целое число от 1 до 50. Запрос возвращает указанное число платежей в обратном хронологическом порядке, начиная от текущей даты или даты в параметре startDate |
sources? |
PaymentHistorySourceAny [] |
Список источников платежа, для фильтра. Каждый источник нумеруется, начиная с нуля (sources[0] , sources[1] и т.д.). Допустимые значения: - QW_RUB - рублевый счет кошелька, - QW_USD - счет кошелька в долларах, - QW_EUR - счет кошелька в евро, - CARD - привязанные и непривязанные к кошельку банковские карты, - MK - счет мобильного оператора. Если не указан, учитываются все источники |
apis/wallet/wallet.types.ts:419
Ƭ GetPaymentHistoryParametersStartEnd: Object
Name | Type | Description |
---|---|---|
endDate |
string |
Начальная дата поиска платежей. Используется только вместе с startDate . Максимальный допустимый интервал между startDate и endDate - 90 календарных дней. По умолчанию, равна суточному сдвигу от текущей даты по московскому времени. Дату можно указать в любой временной зоне TZD (формат ГГГГ-ММ-ДД'T'чч:мм:ссTZD ), однако она должна совпадать с временной зоной в параметре startDate . Обозначение временной зоны TZD : +чч:мм или -чч:мм (временной сдвиг от GMT). |
startDate |
string |
Начальная дата поиска платежей. Используется только вместе с endDate . Максимальный допустимый интервал между startDate и endDate - 90 календарных дней. По умолчанию, равна суточному сдвигу от текущей даты по московскому времени. Дату можно указать в любой временной зоне TZD (формат ГГГГ-ММ-ДД'T'чч:мм:ссTZD ), однако она должна совпадать с временной зоной в параметре endDate . Обозначение временной зоны TZD : +чч:мм или -чч:мм (временной сдвиг от GMT). |
apis/wallet/wallet.types.ts:459
Ƭ GetPaymentHistoryTotalParameters: Omit
<GetPaymentHistoryParametersBase
, "rows"
> & GetPaymentHistoryParametersStartEnd
apis/wallet/wallet.types.ts:510
Ƭ GetPaymentHistoryTotalResponse: Object
Name | Type | Description |
---|---|---|
incomingTotal |
MoneyAmount [] |
Данные о входящих платежах (пополнениях), отдельно по каждой валюте |
outgoingTotal |
MoneyAmount [] |
Данные об исходящих платежах, отдельно по каждой валюте |
apis/wallet/wallet.types.ts:516
Ƭ GetTransactionsHistoryResponse: Object
Name | Type | Description |
---|---|---|
data |
Transaction [] |
Список объектов Transaction. Число транзакций в списке меньше или равно параметру rows из запроса |
nextTxnDate |
Transaction ["date" ] | null |
Дата/время следующей транзакции в полном списке, время московское (в формате ГГГГ-ММ-ДД'T'чч:мм:сс+03:00 ) |
nextTxnId |
Transaction ["txnId" ] | null |
ID следующей транзакции в полном списке |
apis/wallet/wallet.types.ts:645
Ƭ Headers: ReadonlyRecord
<string
, string
>
Ƭ HmacOptions: Object
Name | Type |
---|---|
algorithm? |
string |
data |
BinaryAlike |
digest |
BinaryAlike |
key |
BinaryAlike |
Ƭ IdentificationBase: Object
Name | Type | Description |
---|---|---|
birthDate |
string |
Дата рождения пользователя (в формате "ГГГГ-ММ-ДД") |
firstName |
string |
Имя пользователя |
inn |
string |
ИНН пользователя |
lastName |
string |
Фамилия пользователя |
middleName |
string |
Отчество пользователя |
oms |
string |
Номер полиса ОМС пользователя |
passport |
string |
Серия и номер паспорта пользователя (только цифры) |
snils |
string |
Номер СНИЛС пользователя |
apis/wallet/wallet.types.ts:332
Ƭ IdentificationResponse: IdentificationBase
& { id
: number
; type
: SIMPLE
| VERIFIED
| FULL
}
apis/wallet/wallet.types.ts:358
Ƭ KeyPair: Object
Name | Type |
---|---|
publicKey |
string |
secretKey |
string |
apis/wallet/wallet.types.ts:1347
Ƭ Limit<Current
, Type
>: Object
Name | Type |
---|---|
Current |
extends keyof typeof Currency = "RUB" |
Type |
extends LimitTypeAny = LimitTypeAny |
Name | Type | Description |
---|---|---|
currency |
Current |
Валюта операций |
interval |
{ dateFrom : string ; dateTill : string } |
Сведения о периоде действия лимита |
interval.dateFrom |
string |
Начало периода, формат даты ГГГГ-ММ-ДДТЧЧ:ММ:ССtmz |
interval.dateTill |
string |
Конец периода, формат даты ГГГГ-ММ-ДДТЧЧ:ММ:ССtmz |
max |
number |
Значение лимита |
rest |
number |
Остаток лимита, который можно потратить в данный период (период задается в параметре interval ) |
spent |
number |
Сумма, потраченная по данным операциям |
type |
Type |
Тип операций, на которые действует данный лимит |
apis/wallet/wallet.types.ts:686
Ƭ LimitTypeAny: LimitType
| LimitTypePlain
apis/wallet/wallet.types.ts:684
Ƭ LimitTypePlain: keyof typeof LimitType
apis/wallet/wallet.types.ts:683
Ƭ LimitsResponse<RequestedLimits
>: Object
Name | Type |
---|---|
RequestedLimits |
extends LimitTypeAny = LimitTypeAny |
Name | Type | Description |
---|---|---|
limits |
{ KZ : Limit <"KZT" , RequestedLimits >[] ; RU : Limit <"RUB" , RequestedLimits >[] } |
Описание лимитов |
limits.KZ |
Limit <"KZT" , RequestedLimits >[] |
- |
limits.RU |
Limit <"RUB" , RequestedLimits >[] |
Массив лимитов на операции |
apis/wallet/wallet.types.ts:718
Ƭ LockableField: "account"
| "comment"
| "sum"
apis/wallet/wallet.types.ts:836
Ƭ MoneyAmount: Object
Name | Type | Description |
---|---|---|
amount |
number |
Сумма |
currency |
Currency |
Валюты |
apis/wallet/wallet.types.ts:70
Ƭ MoneyAmountString: Object
Name | Type | Description |
---|---|---|
amount |
number |
- |
currency |
string |
Код валюты в строке. - "643" - рубли - "398" - тенге |
apis/wallet/wallet.types.ts:1514
Ƭ NicknameData: Object
Name | Type |
---|---|
canChange |
boolean |
canUse |
boolean |
description |
string |
nickname |
string |
apis/wallet/wallet.types.ts:1501
Ƭ ObjectKey: string
| number
Ƭ PayParameters: Object
See
Name | Type | Description |
---|---|---|
account |
string |
Номер счёта в указанной платёжной системе (у provider 'а) Если он не задан, то следует указывать номер телефона(киви) получателя. Записывается в fields.account , можно поставить "" , если переопределяете в fields |
accountCurrency? |
Currency |
Валюта счёта, с которого производится платёж |
amount |
number |
Сумма платежа в указанной валюте. Если валюта не указана, то в рублях. Советую округлять до 2ух знаков после , |
comment? |
string |
Комментарий к платежу |
currency? |
Currency |
Валюта платежа |
fields? |
Partial <FreePayFields > & Record <string , string > |
Дополнительные параметры платежа. Обычно необходимо для платежа по свободным реквизитам |
provider? |
number | Recipients |
Ака ID в доках, номер провайдера(платёжной системы) у QIWI See Recipients Default 99 |
apis/wallet/wallet.types.ts:1194
Ƭ PayUrlPatchParameters: Object
Name | Type | Description |
---|---|---|
paySource? |
BillPaySourceAny |
Выбранный по умолчанию метод оплаты |
successUrl? |
string |
URL для переадресации в случае успешного перевода с баланса QIWI Кошелька. При ином способе оплаты переадресация не выполняется. Ссылка должна вести на ваш сайт. |
Ƭ PaymentCommissionRequest: Object
Name | Type | Description |
---|---|---|
account |
string |
Пользовательский идентификатор (номер телефона с международным префиксом, номер карты/счета получателя, и т.д., в зависимости от провайдера) |
paymentMethod |
{ accountId : Currency ; type : "Account" } |
Объект, определяющий обработку платежа процессингом QIWI Wallet |
paymentMethod.accountId |
Currency |
Идентификатор счета, только 643 . |
paymentMethod.type |
"Account" |
Метод платежа, только Account |
purchaseTotals |
{ total : MoneyAmount } |
Объект с платежными реквизитами |
purchaseTotals.total |
MoneyAmount |
Объект, содержащий данные о сумме платежа |
apis/wallet/wallet.types.ts:778
Ƭ PaymentHistorySourceAny: PaymentHistorySource
| PaymentHistorySourcePlain
apis/wallet/wallet.types.ts:415
Ƭ PaymentHistorySourcePlain: keyof typeof PaymentHistorySource
apis/wallet/wallet.types.ts:414
Ƭ PaymentResponse: Object
Name | Type | Description |
---|---|---|
comment? |
string |
Копия параметра comment из платежного запроса (возвращается, если присутствует в запросе) |
fields |
Record <string , string > |
Копия объекта fields из платежного запроса. Номер карты (если был выполнен перевод на карту) возвращается в маскированном виде |
id |
string |
Копия параметра id из платежного запроса |
source |
"account_643" |
Константа, account_643 |
sum |
MoneyAmount |
Копия объекта sum из платежного запроса |
terms |
string |
Идентификатор провайдера, на которого был отправлен платеж |
transaction |
{ id : string ; state : { code : "Accepted" } } |
- |
transaction.id |
string |
- |
transaction.state |
{ code : "Accepted" } |
- |
transaction.state.code |
"Accepted" |
- |
apis/wallet/wallet.types.ts:802
Ƭ PersonIdentificationLevelAny: PersonIdentificationLevel
| PersonIdentificationLevelPlain
apis/wallet/wallet.types.ts:18
Ƭ PersonIdentificationLevelPlain: keyof typeof PersonIdentificationLevel
apis/wallet/wallet.types.ts:17
Ƭ PersonProfile: Object
Name | Type | Description |
---|---|---|
authInfo |
{ boundEmail : string | null ; ip : string ; lastLoginDate : string ; mobilePinInfo : { lastMobilePinChange : string ; mobilePinUsed : boolean ; nextMobilePinChange : string } ; passInfo : { lastPassChange : string ; nextPassChange : string ; passwordUsed : boolean } ; personId : number ; pinInfo : { pinUsed : boolean } ; registrationDate : string } |
Текущие настройки авторизации. Объект может отсутствовать, в зависимости от признака authInfoEnabled в запросе. |
authInfo.boundEmail |
string | null |
E-mail, привязанный к кошельку. Если отсутствует, то null |
authInfo.ip |
string |
IP-адрес последней пользовательской сессии |
authInfo.lastLoginDate |
string |
Дата/время последней сессии в QIWI Кошельке |
authInfo.mobilePinInfo |
{ lastMobilePinChange : string ; mobilePinUsed : boolean ; nextMobilePinChange : string } |
Данные о PIN-коде мобильного приложения QIWI Кошелька |
authInfo.mobilePinInfo.lastMobilePinChange |
string |
Дата/время последнего изменения PIN-кода мобильного приложения QIWI Кошелька |
authInfo.mobilePinInfo.mobilePinUsed |
boolean |
Логический признак использования PIN-кода (фактически означает, что мобильное приложение используется) |
authInfo.mobilePinInfo.nextMobilePinChange |
string |
Дата/время следующего (планового) изменения PIN-кода мобильного приложения QIWI Кошелька |
authInfo.passInfo |
{ lastPassChange : string ; nextPassChange : string ; passwordUsed : boolean } |
Данные об использовании пароля к сайту qiwi.com |
authInfo.passInfo.lastPassChange |
string |
Дата/время последнего изменения пароля сайта qiwi.com |
authInfo.passInfo.nextPassChange |
string |
Дата/время следующего (планового) изменения пароля сайта qiwi.com |
authInfo.passInfo.passwordUsed |
boolean |
Логический признак использования пароля (фактически означает использование сайта qiwi.com) |
authInfo.personId |
number |
Номер кошелька |
authInfo.pinInfo |
{ pinUsed : boolean } |
Данные об использовании PIN-кода к приложению QIWI Кошелька на QIWI терминалах самообслуживания |
authInfo.pinInfo.pinUsed |
boolean |
Логический признак использования PIN-кода для терминала (фактически означает факт использования приложения QIWI Кошелька на терминале) |
authInfo.registrationDate |
string |
Дата/время регистрации QIWI Кошелька (через сайт/мобильное приложение, либо другим способом) |
contractInfo |
{ blocked : boolean ; contractId : number ; creationDate : string ; features : object [] ; identificationInfo : { bankAlias : "QIWI" | string ; identificationLevel : PersonIdentificationLevel }[] } |
Информация о кошельке. Объект может отсутствовать, в зависимости от признака contractInfoEnabled в запросе. |
contractInfo.blocked |
boolean |
Логический признак блокировки кошелька |
contractInfo.contractId |
number |
Номер кошелька |
contractInfo.creationDate |
string |
Дата/время создания QIWI Кошелька (через сайт/мобильное приложение, либо при первом пополнении, либо другим способом) |
contractInfo.features |
object [] |
Служебная информация |
contractInfo.identificationInfo |
{ bankAlias : "QIWI" | string ; identificationLevel : PersonIdentificationLevel }[] |
Данные об идентификации пользователя. |
userInfo |
{ defaultPayCurrency : Currency ; defaultPaySource : number ; email : string ; firstTxnId : string ; language : string ; operator : string ; phoneHash : string ; promoEnabled : string } |
Прочие пользовательские данные. Объект может отсутствовать, в зависимости от признака userInfoEnabled в запросе. |
userInfo.defaultPayCurrency |
Currency |
Код валюты баланса кошелька по умолчанию (number-3 ISO-4217) |
userInfo.defaultPaySource |
number |
Служебная информация |
userInfo.email |
string |
E-mail пользователя |
userInfo.firstTxnId |
string |
Номер первой транзакции после регистрации |
userInfo.language |
string |
Служебная информация |
userInfo.operator |
string |
Название мобильного оператора номера пользователя |
userInfo.phoneHash |
string |
Служебная информация |
userInfo.promoEnabled |
string |
Служебная информация |
apis/wallet/wallet.types.ts:185
Ƭ PrettyTokenResponse<C
>: ShortTokenResponse
& { client
: C
}
Name |
---|
C |
apis/wallet/wallet.types.ts:911
Ƭ ProviderInfo: Object
Name | Type |
---|---|
description |
null | string |
extras |
KeyValueObject |
hasPaymentForm |
boolean |
id |
number |
keys |
string |
logoUrl |
string | null |
longName |
string |
searchAvailable |
boolean |
shortName |
string |
siteUrl |
null | string |
type |
"PROVIDER" |
apis/wallet/wallet.types.ts:1487
Ƭ QuickPayParameters: Omit
<PayParameters
, "provider"
> & { commissionPayer?
: CommissionPayer
; provider?
: number
| Recipients
| QuickPayRecipientsAny
}
apis/wallet/wallet.types.ts:1257
Ƭ QuickPayRecipientsAny: QuickPayRecipients
| QuickPayRecipientsPlain
apis/wallet/wallet.types.ts:1255
Ƭ QuickPayRecipientsPlain: "card"
| "phone"
| "qiwi"
| "yoomoney"
apis/wallet/wallet.types.ts:1254
Ƭ Rate: Object
Name | Type |
---|---|
from |
Currency |
rate |
number |
to |
Currency |
apis/wallet/wallet.types.ts:1508
Ƭ ReadonlyRecord<K
, V
>: Readonly
<Record
<K
, V
>>
Name | Type |
---|---|
K |
extends ObjectKey |
V |
V |
Ƭ RefundCreationRequest: Object
Name | Type |
---|---|
amount |
BillMoneyAmount |
refundId? |
string |
Ƭ Restrictions: { restrictionCode
: string
; restrictionDescription
: string
}[]
apis/wallet/wallet.types.ts:377
Ƭ ShortTokenResponse: Object
Name | Type |
---|---|
expiry |
number |
token |
string |
apis/wallet/wallet.types.ts:906
Ƭ StringOrNumber: string
| number
apis/wallet/wallet.types.ts:1345
Ƭ TimeSpanKeys: keyof TimeSpanMapping
Ƭ TimeSpanMapping: typeof TimeSpanMapping
Ƭ TokenResponse: Object
Name | Type | Description |
---|---|---|
access_token |
string |
Токен с расширенным сроком действия |
expires_in |
string |
Кол-во секунд в формате строки: "316224000" |
refresh_token |
string |
Не используется |
token_type |
"Bearer" |
Тип токена |
apis/wallet/wallet.types.ts:892
Ƭ Transaction: Object
Name | Type | Description |
---|---|---|
account |
string |
Для платежей - номер счета получателя. Для пополнений - номер отправителя, терминала или название агента пополнения кошелька |
comment |
string |
Комментарий к платежу |
commission |
MoneyAmount |
Данные о комиссии платежа |
currencyRate |
number |
Курс конвертации (если применяется в транзакции) |
date |
string |
Для запросов истории платежей - Дата/время платежа, во временной зоне запроса (см. параметр startDate ). Формат даты ГГГГ-ММ-ДД'T'чч:мм:сс+03:00 Для запросов данных о транзакции - Дата/время платежа, время московское (в формате ГГГГ-ММ-ДД'T'чч:мм:сс+03:00 ) |
error |
string | null |
Описание ошибки |
errorCode |
number |
Код ошибки платежа |
extras |
object |
Служебная информация |
features |
{ bankDocumentAvailable : boolean ; chequeReady : boolean ; favoritePaymentEnabled : boolean ; regularPaymentEnabled : boolean ; repeatPaymentEnabled : boolean } |
Поидее содержимое этого поля должно быть напрямую в Transaction. Но QIWI возвращает именно так |
features.bankDocumentAvailable |
boolean |
Специальное поле |
features.chequeReady |
boolean |
Специальное поле |
features.favoritePaymentEnabled |
boolean |
Специальное поле |
features.regularPaymentEnabled |
boolean |
Специальное поле |
features.repeatPaymentEnabled |
boolean |
Специальное поле |
personId |
number |
Номер кошелька |
provider |
{ descriptions : string | null ; id : number ; keys : string | null ; logoUrl : string | null ; longName : string ; shortName : string ; siteUrl : string | null } |
Данные о провайдере. |
provider.descriptions |
string | null |
описание провайдера (HTML) |
provider.id |
number |
ID провайдера в QIWI Wallet |
provider.keys |
string | null |
список ключевых слов |
provider.logoUrl |
string | null |
ссылка на логотип провайдера |
provider.longName |
string |
развернутое наименование провайдера |
provider.shortName |
string |
краткое наименование провайдера |
provider.siteUrl |
string | null |
сайт провайдера |
source |
object |
Служебная информация |
status |
TransactionStatus |
Статус платежа. Возможные значения: - WAITING - платеж проводится - SUCCESS - успешный платеж - ERROR - ошибка платежа. |
statusText |
string |
Текстовое описание статуса платежа |
sum |
MoneyAmount |
Данные о сумме платежа или пополнения. |
total |
MoneyAmount |
Данные о фактической сумме платежа или пополнения. |
trmTxnId |
string |
Клиентский ID транзакции |
txnId |
number |
ID транзакции в сервисе QIWI Кошелек |
type |
IN | OUT | QIWI_CARD |
Тип платежа. Возможные значения: - IN - пополнение, - OUT - платеж, - QIWI_CARD - платеж с карт QIWI (QVC, QVP). |
apis/wallet/wallet.types.ts:527
Ƭ TransactionStatusAny: TransactionStatus
| TransactionStatusPlain
apis/wallet/wallet.types.ts:47
Ƭ TransactionStatusPlain: keyof typeof TransactionStatus
apis/wallet/wallet.types.ts:46
Ƭ TransactionTypeAny: TransactionType
| TransactionTypePlain
apis/wallet/wallet.types.ts:34
Ƭ TransactionTypePlain: keyof typeof TransactionType
apis/wallet/wallet.types.ts:33
Ƭ URLResult: (queryParameters?
: AnyRecord
) => string
▸ (queryParameters?
): string
Name | Type |
---|---|
queryParameters? |
AnyRecord |
string
Ƭ WebHookInfo: Object
Name | Type | Description |
---|---|---|
hookId |
string |
UUID действующего обработчика вебхуков |
hookParameters |
{ url : string } |
Набор параметров обработчика (только URL) |
hookParameters.url |
string |
- |
hookType |
"WEB" |
Тип вебхука (только WEB) |
txnType |
TransactionType |
Тип транзакций, по которым отсылаются уведомления (IN - входящие, OUT - исходящие, BOTH - все) |
apis/wallet/wallet.types.ts:1262
Ƭ WebhookTransaction: Object
Name | Type | Description |
---|---|---|
hash |
string |
Хэш цифровой подписи уведомления |
hookId |
string |
Уникальный id хука |
messageId |
string |
Уникальный id уведомления |
payment |
{ account : string ; comment : string ; commission : MoneyAmount | null ; date : string ; errorCode : number ; personId : number ; provider : number | Recipients ; signFields : string ; status : TransactionStatus ; sum : MoneyAmount | null ; total : MoneyAmount | null ; txnId : number ; type : IN | OUT } |
Данные платежа |
payment.account |
string |
- |
payment.comment |
string |
- |
payment.commission |
MoneyAmount | null |
Данные о комиссии для платежа или пополнения |
payment.date |
string |
Для запросов истории платежей - Дата/время платежа, во временной зоне запроса (см. параметр startDate ). Формат даты ГГГГ-ММ-ДД'T'чч:мм:сс+03:00 Для запросов данных о транзакции - Дата/время платежа, время московское (в формате ГГГГ-ММ-ДД'T'чч:мм:сс+03:00 ) |
payment.errorCode |
number |
Код ошибки платежа |
payment.personId |
number |
Номер кошелька |
payment.provider |
number | Recipients |
ID провайдера QIWI Wallet |
payment.signFields |
string |
Список полей объекта payment (через ,), которые хэшируются алгоритмом HmacSHA256 для проверки уведомления (см. параметр hash ) |
payment.status |
TransactionStatus |
Статус платежа |
payment.sum |
MoneyAmount | null |
Данные о сумме платежа или пополнения |
payment.total |
MoneyAmount | null |
Данные об итоговой сумме платежа или пополнения |
payment.txnId |
number |
ID транзакции в процессинге QIWI Wallet |
payment.type |
IN | OUT |
Тип платежа. Возможные значения: - IN - пополнение, - OUT - платеж. |
test |
boolean |
Признак тестового сообщения |
version |
string |
Версия API |
apis/wallet/wallet.types.ts:1276
• Const
Recipient: typeof Recipients
= Recipients
apis/wallet/wallet.types.ts:183
• Const
TimeSpanMapping: Readonly
<{ d
: TimeSpan
= TimeSpan.Day; day
: TimeSpan
= TimeSpan.Day; h
: TimeSpan
= TimeSpan.Hour; hour
: TimeSpan
= TimeSpan.Hour; hr
: TimeSpan
= TimeSpan.Hour; m
: TimeSpan
= TimeSpan.Minute; millisecond
: TimeSpan
= TimeSpan.Millisecond; min
: TimeSpan
= TimeSpan.Minute; minute
: TimeSpan
= TimeSpan.Minute; mn
: TimeSpan
= TimeSpan.Month; mon
: TimeSpan
= TimeSpan.Month; month
: TimeSpan
= TimeSpan.Month; ms
: TimeSpan
= TimeSpan.Millisecond; msec
: TimeSpan
= TimeSpan.Millisecond; s
: TimeSpan
= TimeSpan.Second; sec
: TimeSpan
= TimeSpan.Second; second
: TimeSpan
= TimeSpan.Second; w
: TimeSpan
= TimeSpan.Week; week
: TimeSpan
= TimeSpan.Week; y
: TimeSpan
= TimeSpan.Year; year
: TimeSpan
= TimeSpan.Year; yr
: TimeSpan
= TimeSpan.Year }>
• Const
USER_AGENT: string
• Const
environment: Readonly
<Record
<"QIWI_TOKEN"
| "QIWI_WALLET"
| "QIWI_SECRET_KEY"
| "QIWI_PUBLIC_KEY"
, string
>>
▸ collect<T
>(collection
): T
[]
Export
Name |
---|
T |
Name | Type |
---|---|
collection |
Collection <T > |
T
[]
▸ compareHmac(options
): boolean
Export
Name | Type |
---|---|
options |
HmacOptions |
boolean
▸ compareQiwiHmac(key
, digest
, data
): boolean
Export
Name | Type |
---|---|
key |
BinaryAlike |
digest |
BinaryAlike |
data |
string [] |
boolean
boolean
▸ formatAltLifetimeDate(dateTime
): string
Используется только для параметра lifetime
при создании ссылки на форму оплаты
Форматирует дату в понятную для QIWI строку:
ГГГГ-ММ-ДДTччмм
Export
Name | Type |
---|---|
dateTime |
DateValue |
string
string
▸ formatDate(dateTime
): string
Форматирует дату в понятную для QIWI строку:
ГГГГ-ММ-ДДTЧЧ:ММ:СС+\-ЧЧ:ММ
Name | Type | Description |
---|---|---|
dateTime |
DateValue |
Аргумент для конструктора |
string
▸ formatOffsetAltLifetimeDate(amount
, unit?
, currentDate?
): string
Export
Name | Type | Default value |
---|---|---|
amount |
number |
undefined |
unit |
TimeUnit |
TimeSpan.Millisecond |
currentDate? |
Date |
undefined |
string
string
▸ formatOffsetDate(amount
, unit?
, currentDate?
): string
Используется только для параметра lifetime
при создании ссылки на форму оплаты
Форматирует дату в понятную для QIWI строку:
ГГГГ-ММ-ДДTччмм
Export
Name | Type | Default value |
---|---|---|
amount |
number |
undefined |
unit |
TimeUnit |
TimeSpan.Millisecond |
currentDate? |
Date |
undefined |
string
string
▸ formatQuerystring(object
): string
Создаёт строку запроса, в формате, который понимает QIWI
Name | Type | Description |
---|---|---|
object |
Readonly <Record <string , unknown >> |
Объект для преобразования |
string
▸ generateUUID(): string
Генерирует UUID
Export
string
▸ url(parts
, ...insertions
): URLResult
Export
Name | Type |
---|---|
parts |
TemplateStringsArray |
...insertions |
unknown [] |