apis_p2p.md

QIWI SDK / Modules / apis/p2p

Module: apis/p2p

Table of contents

References

• P2P
• P2PNotificationError
• P2PPaymentError
• P2p
• P2pApiError
• P2pApiErrorResponse
• P2pApiOptions
• P2pAuthorizationError
• P2pBillNotificationError
• P2pCompat
• QiwiBillPaymentsAPI
• _P2pCompat
• _P2pCompatBillPayments

Enumerations

• BillCurrency
• BillPaySource
• BillRefundStatus
• BillStatus

Type Aliases

• BillCreateParameters
• BillCreationRequest
• BillCurrencyAny
• BillCurrencyPlain
• BillError
• BillFormParameters
• BillMoneyAmount
• BillPaySourceAny
• BillPaySourcePlain
• BillRefundStatusAny
• BillRefundStatusData
• BillRefundStatusPlain
• BillStatusAny
• BillStatusBody
• BillStatusData
• BillStatusNotificationBody
• BillStatusPlain
• PayUrlPatchParameters
• RefundCreationRequest

References

P2P

Renames and re-exports _P2pCompat

---

P2PNotificationError

Renames and re-exports P2pBillNotificationError

---

P2PPaymentError

Renames and re-exports P2pApiError

---

P2p

Re-exports P2p

---

P2pApiError

Re-exports P2pApiError

---

P2pApiErrorResponse

Re-exports P2pApiErrorResponse

---

P2pApiOptions

Re-exports P2pApiOptions

---

P2pAuthorizationError

Re-exports P2pAuthorizationError

---

P2pBillNotificationError

Re-exports P2pBillNotificationError

---

P2pCompat

Renames and re-exports _P2pCompat

---

QiwiBillPaymentsAPI

Renames and re-exports _P2pCompatBillPayments

---

_P2pCompat

Re-exports _P2pCompat

---

_P2pCompatBillPayments

Re-exports _P2pCompatBillPayments

Type Aliases

BillCreateParameters

Ƭ BillCreateParameters: BillCreationRequest & PayUrlPatchParameters & { billId?: string }

Defined in

apis/p2p/p2p.types.ts:256

---

BillCreationRequest

Ƭ BillCreationRequest: BillCustomFieldsExtension & { amount: BillMoneyAmount ; comment?: string ; customFields?: CustomFields ; customer?: { account?: string ; email?: string ; phone?: string } ; expirationDateTime?: string | Date }

Defined in

apis/p2p/p2p.types.ts:88

---

BillCurrencyAny

Ƭ BillCurrencyAny: BillCurrency | BillCurrencyPlain

Defined in

apis/p2p/p2p.types.ts:21

---

BillCurrencyPlain

Ƭ BillCurrencyPlain: keyof typeof BillCurrency

Defined in

apis/p2p/p2p.types.ts:20

---

BillError

Ƭ BillError: Object

Type declaration

Name	Type	Description
datetime	string	Дата и время ответа
description	string	Вот это надо пихать в поле Error.message
errorCode	string	Внутренний код ошибки
serviceName	string	Название сервиса, зачастую начинается на invoicing
traceId	string	Хз что это
userMessage	string

Defined in

apis/p2p/p2p.types.ts:188

---

BillFormParameters

Ƭ BillFormParameters: PayUrlPatchParameters & BillCustomFieldsExtension & { amount: string | number ; billId?: string ; comment?: string ; customFields?: CustomFields ; lifetime?: string ; themeCode?: string } & BillCreationRequest["customer"]

Defined in

apis/p2p/p2p.types.ts:217

---

BillMoneyAmount

Ƭ BillMoneyAmount: Object

Type declaration

Name	Type	Description
currency	BillCurrencyAny	Валюта суммы счета. Возможные значения: - RUB - рубли - KZT - тенге
value	number | string	Сумма, на которую выставляется счет, округленная в меньшую сторону до 2 десятичных знаков

Defined in

apis/p2p/p2p.types.ts:56

---

BillPaySourceAny

Ƭ BillPaySourceAny: BillPaySource | BillPaySourcePlain

Defined in

apis/p2p/p2p.types.ts:30

---

BillPaySourcePlain

Ƭ BillPaySourcePlain: "qw" | "card" | "mobile"

Defined in

apis/p2p/p2p.types.ts:29

---

BillRefundStatusAny

Ƭ BillRefundStatusAny: BillRefundStatus | BillRefundStatusPlain

Defined in

apis/p2p/p2p.types.ts:272

---

BillRefundStatusData

Ƭ BillRefundStatusData: Object

Type declaration

Name	Type
amount	BillMoneyAmount
datetime	string
refundId	string
status	BillRefundStatusAny

Defined in

apis/p2p/p2p.types.ts:274

---

BillRefundStatusPlain

Ƭ BillRefundStatusPlain: keyof typeof BillRefundStatus

Defined in

apis/p2p/p2p.types.ts:271

---

BillStatusAny

Ƭ BillStatusAny: BillStatus | BillStatusPlain

Defined in

apis/p2p/p2p.types.ts:13

---

BillStatusBody

Ƭ BillStatusBody: Object

Type declaration

Name	Type
bill	BillStatusNotificationBody

Defined in

apis/p2p/p2p.types.ts:184

---

BillStatusData

Ƭ BillStatusData: Object

Type declaration

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	Текущий статус счета

Defined in

apis/p2p/p2p.types.ts:131

---

BillStatusNotificationBody

Ƭ BillStatusNotificationBody: BillStatusData

Defined in

apis/p2p/p2p.types.ts:182

---

BillStatusPlain

Ƭ BillStatusPlain: keyof typeof BillStatus

Defined in

apis/p2p/p2p.types.ts:12

---

PayUrlPatchParameters

Ƭ PayUrlPatchParameters: Object

Type declaration

Name	Type	Description
paySource?	BillPaySourceAny	Выбранный по умолчанию метод оплаты
successUrl?	string	URL для переадресации в случае успешного перевода с баланса QIWI Кошелька. При ином способе оплаты переадресация не выполняется. Ссылка должна вести на ваш сайт.

Defined in

apis/p2p/p2p.types.ts:203

---

RefundCreationRequest

Ƭ RefundCreationRequest: Object

Type declaration

Name	Type
amount	BillMoneyAmount
refundId?	string

Defined in

apis/p2p/p2p.types.ts:261