Scope
digital-tariff
Описание
В случае, если по данным, полученным в созданной заявке, пользователь однозначно не идентифицирован, то Банку потребуются паспортные данные пользователя (в ответе для метода будет получен статус NEED_DUL ), которые необходимо отправить в рамках данного запроса.
Параметры запроса
Bearer {access_token}, полученный по Client Credentials Flow
application/json
application/json
Идентификатор заявки
Серия и номер паспорта
1curl --location --globoff 'https://baas.alfabank.ru/api/pp/v1/debit-cards/forms/{formId}/verification-passport' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6 "passportFullNumber": "4015678904"
7}'Параметры ответа
1{
2 "formId": "F8C1C36417BB43AA9963DE3CEECF7BAC",
3 "status": "APPROVAL_REJECT",
4 "draftId": "06780FADBBA845D69F2C98065D6BBF6D",
5 "payload": {
6 "cause": "NOT_REQUESTED"
7 },
8 "productType": "DC",
9 "lastDtPathStatus": "SUCCESS"
10}Идентификатор заявки
Идентификатор черновика заявки
Дополнительная информация по запросу
Идентификатор карты, которую заказал пользователь. Используется только для заявок со статусом SUCCESS или NODT
Пакет услуг клиента. Используется только для заявок со статусом SUCCESS или NODT
Карточный контракт пользователя. Используется только для заявок со статусом SUCCESS или NODT
Статус пользователя. Используется только для заявок со статусом SUCCESS или NODT. Принимает возможные значения:
-
•
DT- клиент с цифровым тарифом; -
•
NODT- действующий клиент Банка; -
•дополнительно может быть указано значение
FAMILY- клиент Семейного Банка
Ссылка на черновик заявки. Используется только для заявок со статусом SUCCESS или NODT
Статус подписки. Используется только для заявок со статусом SUCCESS или NODT
Список ответов на запрашиваемые категории кэшбэка по месяцам. Используется только для заявок со статусом SUCCESS или NODT
Месяц, на который выбраны категории
Статус ответа МАПЛа
Ответ оркестратора. Принимает возможные значения:
-
•
NOT_REQUESTED- дополнительные данные не запрашивались
Тип продукта
Статус-результат обработки заявки. Принимает возможные значения:
-
•
APPROVAL_REJECT- требуется ввод SMS-кода; -
•
REFER_TO_OFFICE- частичный отказ; -
•
REJECT_COMPLETELY- полный отказ / пользователь внесён в чёрный список / карта неактивна
Статус-результат этапа создания заявки (phase = CREATION). Принимает возможные значения:
-
•
SUCCESS- заявка создана успешно (для клиентов без открытого счёта/цифрового тарифа); -
•
NODT_ALL- действующий клиент, доступны все типы доставки; -
•
NODT_ALL_CW- клиент с неопределённым идентификатором в системе, доступны все типы доставки; -
•
NODT_O- действующий клиент, доступно только отделение; -
•
NODT_EXTD- новый клиент цифрового тарифа, который пока не получил карту, доступны все типы доставки
1{
2 "formId": "F8C1C36417BB43AA9963DE3CEECF7BAC",
3 "status": "APPROVAL_REJECT",
4 "draftId": "06780FADBBA845D69F2C98065D6BBF6D",
5 "payload": {
6 "cause": "NOT_REQUESTED"
7 },
8 "productType": "DC",
9 "lastDtPathStatus": "SUCCESS"
10}Код ошибки. Принимает возможные значения:
-
•
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}Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}