Справочники¶
Статусы аутентификации 3D-Secure¶
Статус возвращается в объекте threeDsStatus.
| Статус | Описание |
|---|---|
| PASSED | Пройдена |
| NOT_PASSED | Не пройдена |
| WITHOUT | Не требуется |
Статусы QR-кода¶
Статус QR-кода передаётся в параметрах объекта qrCode в ответах на запросы «Создание QR-кода СБП» и «Получение информации о QR-коде СБП». Набор статусов, которые может иметь QR-код, зависит от типа QR-кода.
| Статус | Тип QR-кода | Описание |
|---|---|---|
| CREATED | Все типы | Создан |
| DECLINED | DYNAMIC, TOKEN |
Платёж отклонён |
| EXPIRED | Только DYNAMIC |
Время жизни QR-кода истекло |
| PARTIAL_REFUNDED | Только DYNAMIC |
Произведён частичный возврат |
| REFUNDED | Только DYNAMIC |
Произведён полный возврат |
| PAYED | Только DYNAMIC |
Оплачен |
| INIT_PAYMENT_BY_TOKEN | Только TOKEN |
Создан платёж с использованием токена |
| TOKENIZED | Только TOKEN |
Успешная токенизация |
Статусы операций¶
Статус операции отражает её текущее состояние. API возвращает синхронный статус операции в поле status.value.
В таблице перечислены возможные статусы и типы операций, в которых эти статусы используются.
| Тип операции | Статус операции | Описание статуса |
|---|---|---|
| PAYMENT | WAITING | Ожидание 3D-Secure авторизации |
| PAYMENT | DECLINED | Запрос авторизации отклонен (в синхронном ответе) |
| PAYMENT | DECLINE | Запрос авторизации отклонен (в асинхронном ответе) |
| PAYMENT | COMPLETED | Запрос авторизации успешно обработан |
| CAPTURE | DECLINE | Запрос подтверждения отклонен |
| CAPTURE | DECLINED | Запрос подтверждения отклонен (в ответе API на запрос статуса) |
| CAPTURE | COMPLETED | Запрос подтверждения успешно обработан |
| REFUND | DECLINE | Запрос возврата отклонен |
| REFUND | COMPLETED | Запрос возврата успешно обработан |
| REFUND | WAITING | Ожидание обработки (только для СПБ) |
Статусы проверки карты¶
Статус проверки карты возвращается в ответах на запросы «Проверка карты», «Статус проверки карты» и «Завершение аутентификации при проверке карты».
| Статус | Описание |
|---|---|
| INIT | Сгенерирована ссылка на проверку карты, но клиент ещё ей не воспользовался |
| SUCCESS | Проверка выполнена |
| ERROR | Ошибка во время проверки |
| WAITING_3DS | Ожидается завершение проверки 3D-Secure |
Статусы счёта¶
Передаётся в поле status ответа на запрос статуса счёта.
| Статус | Описание |
|---|---|
| CREATED | Создан |
| PAID | Оплачен |
| EXPIRED | Истёк срок оплаты |
| CANCELED | Отменён |
Статусы уведомления¶
В уведомлениях статус передаётся в поле {operation}.status.value. Возможные статусы и типы операций, в которых эти статусы используются, перечислены в таблице.
| Тип операции | Статус | Описание |
|---|---|---|
| PAYMENT | DECLINE | Запрос отклонён |
| PAYMENT | SUCCESS | Запрос успешно обработан |
| CAPTURE | DECLINE | Запрос отклонён |
| CAPTURE | SUCCESS | Запрос успешно обработан |
| REFUND | DECLINE | Запрос отклонён |
| REFUND | SUCCESS | Запрос успешно обработан |
Типы QR-кода¶
Тип QR-кода передаётся в параметрах объекта qrCode запроса на создание QR-кода СБП и ответа на этот запрос.
| Тип | Описание |
|---|---|
| STATIC | Статический QR-код |
| DYNAMIC | Динамический QR-код, индивидуальный для каждой оплаты |
| TOKEN | Используется для выпуска платёжного токена СБП |
Типы интерфейсов¶
Типы интерфейсов, с помощью которых могут быть созданы счета. Могут передаваться в параметрах объекта customFields.
| Тип интерфейса | Описание |
|---|---|
| PUBLIC_KEY | Счёт выставлен через ссылку на оплату |
| PAYIN_API | Счёт выставлен через API |
| KASSA | Счёт выставлен через личный кабинет |
Типы методов оплаты¶
Тип платёжного метода возвращается в поле {operation}.paymentMethod.type уведомления.
| Тип | Описание |
|---|---|
| CARD | Банковская карта |
| TOKEN | Платёжный токен |
| SBP | Система быстрых платежей |
Типы операций¶
Тип операции возвращается в поле {operation}.type уведомления.
| Тип операции | Описание |
|---|---|
| PAYMENT | Платёж. В уведомлении может присутствовать поле flags: [ "SALE" ] (обычный платёж) или flags: [ "AUTH" ] (платёж с холдированием средств) |
| CAPTURE | Операция подтверждения |
| REFUND | Операция возврата. В уведомлении может присутствовать поле flags: [ "REVERSAL" ]. Это значит, что финансовой операции (списания средств со счёта покупателя) не было, комиссия по операции удержана не будет |
Типы операций с сохранённой картой¶
Тип операции платежа с использованием сохранённой карты может передаваться в поле credentialOnFile.type запроса создания платежа.
| Тип операции | Описание |
|---|---|
| CREDENTIAL_ON_FILE | Операция по сохранённым реквизитам карты, инициированная владельцем карты |
| CREDENTIAL_CAPTURED | Операция с сохранением реквизитов карты для последующих оплат |
| RECURRING | Операция списания по инициативе ТСП по сохранённым реквизитам карты |
| INSTALLMENT | Операция списания по инициативе ТСП по сохранённым реквизитам карты (только код MCC 6538) |
Параметры для обработки транзакций при операциях с сохранёнными картами¶
Параметр предаётся в поле paymentMethod.cardTokenPaymentType запроса создания платежа и служит для корректной обработки транзакций в платёжных системах для операций с сохраненными картами.
| Значение | Тип платёжного метода | Описание |
|---|---|---|
| FIRST_PAYMENT | Только для type=CARD |
Используется, если после этой операции мерчант сохранит карту на своей стороне |
| INITIATED_BY_CLIENT | Для type=CARD, TOKEN |
Транзакция по сохраненной карте инициирована клиентом |
| INITIATED_BY_MERCHANT | Для type=CARD, TOKEN |
Транзакция по сохраненной карте инициирована мерчантом |
| RECURRING_PAYMENT | Для type=CARD, TOKEN |
Повторяющаяся операция по сохраненной карте |
| INSTALLMENT | Для type=CARD, TOKEN |
Повторяющаяся операция по сохраненной карте в соответствии с графиком платежей для погашения кредита |