Сценарии использования

Можно выделить три базовых сценария взаимодействия платформы Cardsmobile и эмитента: 
1.Выпуск продукта эмитентом для пользователя приложения «Кошелёк».
2.Доставка выпущенного продукта в Кошелёк пользователя.
3.Получение клиентом информации о продукте, выпущенном для него эмитентом.
1. Выпуск продукта
Выпуск продукта инициируется пользователем, который выбирает интересующий его банковский продукт в каталоге приложения. После этого пользователь принимает условия выпуска продукта и заполняет анкету. Анкета может быть заполнена пользователем как в приложении, так и на стороннем ресурсе (например, на веб-сайте эмитента).
1.1. Запрос выпуска продукта со стороны Cardsmobile
Запрос на выпуск продукта осуществляется со стороны Cardsmobile путем передачи эмитенту запроса API requestProduct.
Запрос на выпуск продукта
1.2. Ответ на запрос выпуска продукта со стороны эмитента
В случае успешной обработки запроса со стороны эмитента производится передача запроса notifyRequestProductResult.
Ответ на запрос выпуска продукта со стороны эмитента
Ответ notifyRequestProductResult содержит в себе поле status, определяющее результат обработки запроса эмитентом. Это поле может содержать следующие статусы:
APPROVED (Одобрено) — эмитент одобрил выпуск экземпляра продукта в Кошельке пользователя, можно переходить к процедуре доставки.
DECLINED (Отказано) — эмитент не одобрил выпуск экземпляра выбранного продукта в Кошельке пользователя. Следует повторить процедуру запроса.
AUTHENTICATION_REQUIRED (Требуется аутентификация) — для выпуска экземпляра продукта в Кошельке пользователь должен пройти процедуру аутентификации любым из предложенных эмитентом методов.
1.3. Аутентификация пользователя эмитентом
В случае если ответ эмитента на запрос выпуска продукта содержит статус AUTHENTICATION_REQUIRED, платформа Cardsmobile должна произвести аутентификацию пользователя любым из методов аутентификации, перечень которых возвращается эмитентом в сообщении.
(для просмотра в полном разрешении откройте изображение в новой вкладке)
Cardsmobile передает эмитенту выбранный пользователем метод аутентификации в запросе selectedMethod.
Методы аутентификации IN_CALL, OUT_CALL, WEB_LINK и MOBILE_LINK предусматривают аутентификацию пользователя эмитентом вне API Cardsmobile. 
Метод аутентификации OTP_CODE предполагает отправку эмитентом пользователю одноразового кода аутентификации. Платформа Cardsmobile передает введенный пользователем код эмитенту в запросе authenticate.
В случае успешного прохождения пользователем аутентификации со стороны эмитента, платформа может переходить к этапу доставки выпущенного продукта в Кошелёк пользователя.
2. Доставка продукта пользователю
Экземпляр выпущенного эмитентом продукта доставляется пользователю, если на предыдущем шаге от эмитента по API был получен ответ notifyRequestProductResult с полем status в значении APPROVED. При этом продукт эмитента может быть выпущен как в приложении «Кошелёк», так и в приложении Apple Wallet (для устройств на платформе iOS).
(для просмотра в полном разрешении откройте изображение в новой вкладке)
2.1. Запрос доставки продукта пользователю со стороны Cardsmobile
Cardsmobile передает запрос доставки экземпляра выпущенного продукта пользователю через запрос API provisionRequest.
Если предполагается загрузка экземпляра продукта в приложение Apple Wallet, запрос обязательно должен содержать заполненное поле appleWalletProvisionRequest.
2.2. Ответ на запрос доставки продукта со стороны эмитента
В случае успешной обработки запроса, со стороны эмитента производится передача запроса provisionResult. 
Если экземпляр продукта должен быть загружен в приложение Apple Wallet, запрос обязательно должен содержать заполненное поле appleWalletProvisionResponse.
Запросы provisionRequest и provisionResult содержат зашифрованные данные.
3. Информационное обслуживание выпущенного экземпляра продукта
После того, как экземпляр продукта успешно выпущен в Кошельке пользователя, платформа Cardsmobile и эмитент обеспечивают информационное обслуживание пользователя выпущенного экземпляра продукта. Информационное обслуживание может включать в себя следующие процессы:
1.Запрос пользователем у эмитента данных по выпущенному продукту, доставляемых по альтернативному (вне Кошелька) каналу.
2.Оповещение пользователя со стороны эмитента об изменении статуса выпущенного экземпляра продукта (например, уведомление о блокировке).
3.Запрос пользователем действия по изменению статуса выпущенного экземпляра продукта (например, блокировка).
4.Запрос пользователем истории транзакций и баланса выпущенного продукта.
5.Уведомление пользователя о транзакции, совершенной при помощи выпущенного экземпляра продукта.
Перечень запросов, обеспечивающих информационное обслуживание пользователя продукта, согласовывается эмитентом и Cardsmobile отдельно.
3.1. Запрос пользователем данных по выпущенному продукту
Cardsmobile передает эмитенту запрос пользователя на получение от эмитента сведений о продукте, выпущенном в Кошельке пользователя, через запрос API requestProductInfo.
Запрос данных по выпущенному продукту
В случае успешной обработки запроса эмитент отправит пользователю сведения о продукте с использованием указанного канала связи (СМС и т.п., согласуется с эмитентом отдельно).
3.2. Оповещение пользователя об изменении статуса продукта
Эмитент может оповестить пользователя об изменении статуса продукта, выпущенного в Кошельке пользователя, отправив запрос API notifyProductInstanceUpdated.
Оповещение пользователя об изменении статуса продукта
3.3. Запрос пользователем изменения статуса продукта
Эмитент может предоставить пользователю возможность запрашивать действия по изменению статуса экземпляра продукта, выпущенного в Кошельке. Запрос пользователя на изменение статуса экземпляра продукта реализуется путем отправки эмитенту со стороны Cardsmobile запроса API сhangeProductInstanceRequest.
Запрос изменения статуса продукта пользователем
В случае успешной обработки запроса эмитент должен отправить платформе Cardsmobile запрос API notifyProductInstanceUpdated (см. выше).
3.4. Запрос пользователем баланса продукта
Эмитент может предоставить пользователю возможность запрашивать текущий баланс продукта, выпущенного в Кошельке. Запрос пользователем баланса продукта реализуется путем отправки эмитенту со стороны Cardsmobile запроса API statusRequest.
При необходимости платформа Cardsmobile, используя тот же запрос, может получать сведения о текущем балансе без предварительного запроса со стороны пользователя.
Запрос баланса продукта
В случае успешной обработки запроса эмитент должен отправить платформе Cardsmobile запрос API notifyStatusDetails.
3.5. Получение сведений о транзакциях
Эмитент может предоставить пользователю возможность запрашивать историю транзакций экземпляра продукта, выпущенного в Кошельке. Запрос пользователем истории транзакций реализуется путем отправки эмитенту со стороны Cardsmobile запроса API getTransactionHistory.
При необходимости платформа Cardsmobile, используя тот же запрос, может получать сведения об истории транзакций без предварительного запроса со стороны пользователя.
Получение сведений о транзакциях
В случае успешной обработки запроса эмитент должен отправить платформе Cardsmobile запрос API notifyTransactionHistory.
3.6. Информирование пользователя о транзакциях
Эмитент может оперативно оповещать пользователя о каждой транзакции, совершенной экземпляром продукта, выпущенного в Кошельке. Оповещение пользователя о транзакции реализуется путем отправки эмитентом запроса API notifyActualTransaction.
Информирование пользователя о транзакциях