B2C

Повторная отправка SMS-кода пользователю

Песочница
POST https://sandbox.alfabank.ru/api/pp/v1/debit-cards/forms/{formId}/resending-sms
Пром
POST https://baas.alfabank.ru/api/pp/v1/debit-cards/forms/{formId}/resending-sms
Scope

digital-tariff , plastic-delivery

Описание

Метод используется в случае, если пользователю необходимо запросить новый SMS-код для подтверждения.

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

QUERY
Атрибут
Описание
phase
stringrequired

Этап процесса оформления заявки

PATH
Атрибут
Описание
formId
stringrequired

Идентификатор заявки

Пример запроса
Язык
1curl --location --globoff --request POST 'https://baas.alfabank.ru/api/pp/v1/debit-cards/forms/{formId}/resending-sms?phase={phase}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "formId": "5C2CCE51FD4D47E3AA406B52321B738C",
3  "status": "APPROVAL_REJECT",
4  "draftId": "87A0DA31AD424289A228C9F5A089DC9C",
5  "payload": {
6    "cause": "NOT_REQUESTED"
7  },
8  "productType": "DC"
9}
BODY
атрибут
описание
formId
stringrequired

Идентификатор заявки

draftId
stringoptional

Идентификатор черновика заявки

objectoptional

Опциональный объект с дополнительными данными по заявке

cardId
stringoptional

Идентификатор карты, которую заказал пользователь. Используется только для заявок со статусом SUCCESS или NODT

packageId
stringoptional

Пакет услуг клиента. Используется только для заявок со статусом SUCCESS или NODT

contractId
stringoptional

Карточный контракт пользователя. Используется только для заявок со статусом SUCCESS или NODT

userStatus
array of stringsoptional

Название клиентского пути. Используется только для заявок со статусом SUCCESS или NODT. Принимает возможные значения:

  • •
    DT - клиент ЦТ;
  • •
    NODT - действующий клиент;
  • •
    дополнительно может быть указано FAMILY - клиент Семейного Банка
url
stringoptional

Ссылка на черновик заявки. Используется только для заявок со статусом SUCCESS или NODT

subscription
stringoptional

Подписка. Используется только для заявок со статусом SUCCESS или NODT

array of objectsoptional

Список ответов на запрашиваемые категории кэшбэка по месяцам. Используется только для заявок со статусом SUCCESS или NODT

month
stringrequired

Месяц, на который выбраны категории

status
stringrequired

Статус ответа

cause
stringoptional

Статус-результат обработки заявки. Возможные значения:

  • •
    NOT_REQUESTED - дополнительные данные не запрашивались
productType
stringoptional

Тип продукта. Используется только для заявок со статусом SUCCESS или NODT

status
stringrequired

Статус-результат обработки заявки. Возможные значения:

  • •
    APPROVAL_REJECT - требуется ввод SMS-кода
Пример ответа 200 (OK)
1{
2  "formId": "5C2CCE51FD4D47E3AA406B52321B738C",
3  "status": "APPROVAL_REJECT",
4  "draftId": "87A0DA31AD424289A228C9F5A089DC9C",
5  "payload": {
6    "cause": "NOT_REQUESTED"
7  },
8  "productType": "DC"
9}
BODY
атрибут
описание
objectoptional

Опциональный объект с дополнительными данными по заявке

cardId
stringoptional

Идентификатор карты, которую заказал пользователь. Используется только для заявок со статусом SUCCESS или NODT

packageId
stringoptional

Пакет услуг клиента. Используется только для заявок со статусом SUCCESS или NODT

contractId
stringoptional

Карточный контракт пользователя. Используется только для заявок со статусом SUCCESS или NODT

userStatus
array of stringsoptional

Название клиентского пути. Используется только для заявок со статусом SUCCESS или NODT. Принимает возможные значения:

  • •
    DT - клиент ЦТ;
  • •
    NODT - действующий клиент;
  • •
    дополнительно может быть указано FAMILY - клиент Семейного Банка
url
stringoptional

Ссылка на черновик заявки. Используется только для заявок со статусом SUCCESS или NODT

subscription
stringoptional

Подписка. Используется только для заявок со статусом SUCCESS или NODT

array of objectsoptional

Список ответов на запрашиваемые категории кэшбэка по месяцам. Используется только для заявок со статусом SUCCESS или NODT

month
stringrequired

Месяц, на который выбраны категории

status
stringrequired

Статус ответа

cause
stringoptional

Статус-результат обработки заявки. Возможные значения:

  • •
    NOT_REQUESTED - дополнительные данные не запрашивались
status
stringrequired

Статус-результат обработки заявки. Принимает возможные значения:

  • •
    APPROVAL_REJECT - требуется ввод SMS-кода;
  • •
    REFER_TO_OFFICE - частичный отказ;
  • •
    REJECT_COMPLETELY - полный отказ / пользователь внесён в чёрный список / карта неактивна
Пример ответа 200 (OK)
1{
2  "payload": {
3    "cause": "NOT_REQUESTED"
4  },
5  "status": "NEED_SMS"
6}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_request - неверные входные параметры запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad 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}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. Необходимо получить новый токен доступа
error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)
1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    insufficient_scope - при запросе токена доступа не были переданы все необходимые scopes. Необходимо повторно отправить запрос на получение токена доступа с указанием всех доступных scopes
error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)
1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    unknown_endpoint - эндпоинт не найден или неактивен
error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)
1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки

error_description
stringoptional

Описание ошибки

Пример ошибки 429 (Too Many Requests)
1{
2  "error": "too_many_requests",
3  "error_description": "The client application has surpassed its rate limit, or number of requests they can send in a given period of time - number of sent SMSes isn't less than 3"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    internal_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}
Нет тела ответа