Scope
digital-tariff , plastic-delivery
Описание
В рамках процесса оформления заявки пользователю потребуется с помощью SMS-кода:
-
•подтвердить создание заявки (
phase = CREATION); -
•в случае, если в процессе оформления заявки токен станет невалидным из-за истечения срока действия - подтвердить завершение формирования заявки (
phase = COMPLETION).
Параметры запроса
Bearer {access_token}, полученный по Client Credentials Flow
application/json
application/json
Этап процесса оформления заявки
Идентификатор заявки
SMS-код для подтверждения действия
1curl --location --globoff 'https://baas.alfabank.ru/api/pp/v1/debit-cards/forms/{formId}/verification-sms?phase={phase}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6 "smsCode": "41851"
7}'Параметры ответа
1{
2 "formId": "90DE4466625343719F5822D53F34AFD4",
3 "status": "SUCCESS",
4 "draftId": "B957D9C350B246569FC44241C4B357F2",
5 "payload": {
6 "cardId": "RR",
7 "packageId": "T00",
8 "contractId": "PDRR",
9 "requireCodeWord": false,
10 "userStatus": [
11 "DT"
12 ],
13 "url": "https://baas.alfabank.ru/dc-form/draft/?rp-draftId=B957D9C350B246569FC44241C4B357F2"
14 },
15 "productType": "DC",
16 "lastDtPathStatus": "SUCCESS"
17}Идентификатор заявки
Идентификатор черновика заявки
Дополнительная информация по запросу
Идентификатор карты, которую заказал пользователь. Используется только для заявок со статусом SUCCESS или NODT
Пакет услуг клиента. Используется только для заявок со статусом SUCCESS или NODT
Карточный контракт пользователя. Используется только для заявок со статусом SUCCESS или NODT
Название клиентского пути. Принимает возможные значения:
-
•
DT- клиент с цифровым тарифом; -
•
NODT- действующий клиент; -
•
FAMILY- клиент Семейного Банка
Ссылка на черновик заявки. Используется только для заявок со статусом SUCCESS или NODT
Статус подписки. Используется только для заявок со статусом SUCCESS или NODT
Список ответов на запрашиваемые категории кэшбэка по месяцам. Используется только для заявок со статусом SUCCESS или NODT
Месяц, на который выбраны категории
Статус ответа
Дополнительные данные не запрашивались (ответ оркестратора)
Тип продукта
Статус-результат обработки заявки. Возможные значения:
-
•
NEED_DUL- требуется ввод паспортных данных; -
•
REFER_TO_OFFICE- частичный отказ; -
•
REJECT_COMPLETELY- полный отказ/ пользователь внесён в чёрный список / карта неактивна; -
•
NO_OFFER- пользователю не найдено предложение по его текущему пакету услуг; -
•
NODT- пользователь уже является действующим клиентом Банка; -
•
SUCCESS- заявка успешно создана; -
•
SMS_ERROR- введенный SMS-код некорректен; -
•
DT_CLIENT- у пользователя уже есть пластиковая карта с цифровым тарифом
Статус-результат этапа создания заявки (phase = CREATION). Принимает возможные значения:
-
•
SUCCESS- заявка создана успешно (для клиентов без открытого счёта/цифрового тарифа); -
•
NODT_ALL- действующий клиент, доступны все типы доставки; -
•
NODT_ALL_CW- клиент с неопределённым идентификатором в системе, доступны все типы доставки; -
•
NODT_O- действующий клиент, доступно только отделение; -
•
NODT_EXTD- новый клиент цифрового тарифа, который пока не получил карту, доступны все типы доставки
1{
2 "formId": "90DE4466625343719F5822D53F34AFD4",
3 "status": "SUCCESS",
4 "draftId": "B957D9C350B246569FC44241C4B357F2",
5 "payload": {
6 "cardId": "RR",
7 "packageId": "T00",
8 "contractId": "PDRR",
9 "requireCodeWord": false,
10 "userStatus": [
11 "DT"
12 ],
13 "url": "https://baas.alfabank.ru/dc-form/draft/?rp-draftId=B957D9C350B246569FC44241C4B357F2"
14 },
15 "productType": "DC",
16 "lastDtPathStatus": "SUCCESS"
17}Статус-результат обработки заявки. Принимает возможные значения:
-
•
SMS_ERROR- введенный SMS-код некорректен; -
•
SUCCESS- заявка успешно оформлена
1{
2 "status": "SUCCESS"
3}Код ошибки. Принимает возможные значения:
-
•
invalid_request- неверные входные параметры запроса
Сообщение об ошибке
1{
2 "error": "invalid_request",
3 "error_description": "The request is missing a required parameter, includes an unsupported parameter or parameter value, repeats the same parameter, uses more than one method for including an access token, or is otherwise malformed"
4}Код ошибки. Принимает возможные значения:
-
•
invalid_token- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. Необходимо получить новый токен доступа
Сообщение об ошибке
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}Код ошибки. Принимает возможные значения:
-
•
insufficient_scope- при запросе токена доступа не были переданы все необходимые scopes. Необходимо повторно отправить запрос на получение токена доступа с указанием всех доступных scopes
Сообщение об ошибке
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}Код ошибки. Принимает возможные значения:
-
•
unknown_endpoint- эндпоинт не найден или неактивен
Сообщение об ошибке
1{
2 "error": "unknown_endpoint",
3 "error_description": "Endpoint is not found or not active"
4}Код ошибки. Принимает возможные значения:
-
•
conflict- заявка не является черновиком
Сообщение об ошибке
1{
2 "error": "conflict",
3 "error_description": "The request is valid, but cannot be completed due to some kind of mismatch"
4}Код ошибки. Принимает возможные значения:
-
•
gone- выбранный для бронирования слот недоступен
Сообщение об ошибке
1{
2 "error": "gone",
3 "error_description": "The requested resource is no longer available"
4}Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
Сообщение об ошибке
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}