Формат уведомления PAYMENT

Заголовки

• Signature: XXX
• Accept: application/json
• Content-type: application/json

Параметры тела уведомления

Поле	Описание	Тип	В каких случаях используется
type	Тип уведомления — только PAYMENT	string	Всегда
version	Версия уведомления	string	Всегда
payment	Описание платежа	object	Всегда

Формат объекта payment

Поле	Описание	Тип	В каких случаях используется
type	Тип операции — только PAYMENT	string(200)	Всегда
paymentId	Идентификатор платежа в системе ТСП	string(200)	Всегда
createdDateTime	Дата создания операции	URL-закодированная строка ГГГГ-ММ-ДДTчч:мм:ссZ	Всегда
billId	Идентификатор счёта, соответствующего операции	string(200)	Всегда
qrCodeUid	Идентификатор операции выпуска QR-кода в системе ТСП	string	Если операция была выполнена через СБП
amount	Информация о сумме операции	object	Всегда
status	Информация о статусе операции	object	Всегда
paymentMethod	Информация о средстве платежа	object	Всегда
paymentCardInfo	Информация о карте	object	Всегда
credentialOnFile	Сведения о сохранённой карте	object	Если в платеже используется токенизированнаяя карта
merchantSiteUid	Строковый идентификатор сайта ТСП в QIWI Кассе	String	Всегда
customer	Информация о покупателе	object	Всегда
customFields	Поля с произвольной информацией, дополняющей данные по операции	object	Всегда
flags	Дополнительные команды, переданные в API	Массив. Возможные элементы: SALE, REVERSAL	Всегда
tokenData	Объект с информацией о выпущенном платёжном токене	object	Если в платеже был запрошен выпуск платёжного токена
settlementAmount	Сведения о сумме расчёта с мерчантом	object	Если валюта платежа и расчёта с мерчантом различаются

Формат объекта amount

Поле	Описание	Тип	В каких случаях используется
value	Сумма операции, округленная до двух десятичных знаков в меньшую сторону	number(6.2)	Всегда
currency	Идентификатор валюты операции (Alpha-3 ISO 4217 код)	string(3)	Всегда

Формат объекта status

Поле	Описание	Тип	В каких случаях используется
value	Строковое значение статуса	string	Всегда
changedDateTime	Дата обновления статуса	URL-закодированная строка ГГГГ-ММ-ДДTчч:мм:ссZ	Всегда
reasonCode	Код причины отклонения	string(200)	В случае отклонения операции
reasonMessage	Описание причины отклонения	string(200)	В случае отклонения операции
errorCode	Код ошибки	number	В случае ошибки
psErrorCode	Оригинальный код ошибки, полученный от платёжной системы	string	В случае отклонения операции

Формат объекта paymentMethod

Поле	Описание	Тип	В каких случаях используется
type	Тип метода оплаты	string	Всегда
paymentToken	Платёжный токен карты	string	При оплате платёжным токеном
maskedPan	Маскированный PAN карты	string	При оплате платёжным токеном или картой
rrn	RRN платежа (по ISO 8583)	number	При оплате платёжным токеном или картой
authCode	Auth-code платежа	number	При оплате платёжным токеном или картой
phone	Телефон, с которого выполнялась оплата через СБП	string	При оплате через СБП

Формат объекта paymentCardInfo

Поле	Описание	Тип	В каких случаях используется
issuingCountry	Код страны эмитента	string(3)	Всегда
issuingBank	Банк-эмитент	string	Всегда
paymentSystem	Тип платёжной системы	string	Всегда
fundingSource	Тип карты	string	Всегда
paymentSystemProduct	Категория карты	string	Всегда

Формат объекта credentialOnFile

Поле	Описание	Тип	В каких случаях используется
type	Тип операции платежа	string	Если в платеже используется токенизированнаяя карта
trn	Идентификатор транзакции, в которой была привязана карта	string	Если в платеже используется токенизированнаяя карта

Формат объекта customer

Поле	Описание	Тип	В каких случаях используется
phone	Номер телефона покупателя	string	Всегда
email	E-mail покупателя	string	Всегда
account	Идентификатор покупателя в системе ТСП	string	Всегда
ip	IP адрес покупателя	string	Всегда
country	Страна адреса покупателя	string	Всегда
bankAccountNumber	Номер счёта плательщика	string	Только для платежей через СБП
bic	БИК банка, выпустившего карту	string	Только для платежей через СБП
lastName	Фамилия покупателя	string	Только для платежей через СБП
firstName	Имя покупателя	string	Только для платежей через СБП
middleName	Отчество покупателя	string	Только для платежей через СБП
simpleAddress	Адрес покупателя	string	Только для платежей через СБП
inn	ИНН покупателя	string	Только для платежей через СБП
bankMemberId	Идентификатор банка покупателя	string	Только для платежей через СБП

Формат объекта customFields

Поле	Описание	Тип	В каких случаях используется
cf1	Поле с произвольной информацией, дополняющей данные по операции	string(256)	Всегда
cf2	Поле с произвольной информацией, дополняющей данные по операции	string(256)	Всегда
cf3	Поле с произвольной информацией, дополняющей данные по операции	string(256)	Всегда
cf4	Поле с произвольной информацией, дополняющей данные по операции	string(256)	Всегда
cf5	Поле с произвольной информацией, дополняющей данные по операции	string(256)	Всегда

Формат объекта tokenData

Поле	Описание	Тип	В каких случаях используется
paymentToken	Строка платёжного токена	string	Если в платеже был запрошен выпуск платёжного токена
expiredDate	Дата окончания срока действия платёжного токена	string	Если в платеже был запрошен выпуск платёжного токена

Формат объекта settlementAmount

Поле	Описание	Тип	В каких случаях используется
value	Сумма расчёта с мерчантом	number(6.2)	Если валюта платежа и расчёта с мерчантом различаются
currency	Идентификатор валюты расчёта с мерчантом (Alpha-3 ISO 4217 код)	string(3)	Если валюта платежа и расчёта с мерчантом различаются

Пример тела уведомления

Пример тела уведомления PAYMENT

{
  "payment": {
    "paymentId": "A22170834426031500000733E625FCB3",
    "customFields": {},
    "type": "PAYMENT",
    "createdDateTime": "2022-08-05T11:34:42+03:00",
    "status": {
      "value": "SUCCESS",
      "changedDateTime": "2022-08-05T11:34:44+03:00"
    },
    "amount": {
      "value": 5.00,
      "currency": "RUB"
    },
    "paymentMethod": {
      "type": "SBP",
      "phone": "79111112233"
    },
    "merchantSiteUid": "test-00",
    "customer": {
      "phone": "0",
      "bankAccountNumber": "4081710809561219555",
      "bic": "044525974",
      "lastName": "ИВАНОВ",
      "firstName": "ИВАН",
      "middleName": "ИВАНОВИЧ",
      "simpleAddress": "",
      "bankMemberId": "100000000008"
    },
    "billId": "autogenerated-6cd20922-b1d0-4e67-ba61-e2b7310c4006",
    "flags": [
      "SALE"
    ],
    "qrCodeUid": "acfd9"
  },
  "type": "PAYMENT",
  "version": "1"
}