B2C

Формирование заявки для заказа карты

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

digital-tariff

Описание

В рамках данного запроса пользователь заполняет необходимую информацию и отправляет заявку на оформление дебетовой карты. В результате пользователь получит информацию о статусе заявки и дальнейших необходимых действиях, связанных с процессом оформления:

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

application/json

Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
embossingName
stringoptional

Имя на дебетовой карте

firstName
stringrequired

Имя

lastName
stringrequired

Фамилия

middleName
stringrequired

Отчество

mobilePhone
stringrequired

Мобильный телефон

email
stringoptional

Адрес электронной почты

passportBirthDate
stringrequired

Дата рождения

previousFormId
stringoptional

formId предыдущей заявки (чтобы помечать её как удалённую)

sex
stringrequired

Пол

sopdConfirmed
booleanrequired

Флаг согласия на обработку персональных данных

array of objectsoptional

Дополнительные продукты (стикер, детская карта). Повторения означают количество

mpkCardType
stringoptional

Идентификатор карты

personification
stringoptional

Признак, на кого заказана карта. Обязательно, если заполнен mpkCardType. Возможные значения:

  • •
    FIRST_PERSON - на клиента;
  • •
    THIRD_PERSON - на другого человека
Пример запроса
Язык
1curl --location 'https://baas.alfabank.ru/api/pp/v1/debit-cards/forms' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data-raw '{
6  "embossingName": "PETROV IVAN",
7  "firstName": "Иван",
8  "lastName": "Петров",
9  "middleName": "Викторович",
10  "mobilePhone": "9012345678",
11  "email": "example@yandex.ru",
12  "passportBirthDate": "1990-09-15",
13  "previousFormId": "AAAA16686C43888CE05CCCAC163B298F",
14  "sex": "f",
15  "sopdConfirmed": true,
16  "additionalProducts": [
17    {
18      "mpkCardType": "LG",
19      "personification": "FIRST_PERSON"
20    }
21  ]
22}'
Параметры ответа
Пример ответа 201 (Created)
1{
2  "formId": "55A42D1698400C9EE0543863BB4C2866",
3  "status": "APPROVAL_REJECT",
4  "draftId": "5DCD7E06A44C463781A87CC3302F0E1D",
5  "payload": {
6    "cause": "NOT_REQUESTED"
7  },
8  "productType": "DC"
9}
BODY
атрибут
описание
formId
stringrequired

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

draftId
stringrequired

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

objectoptional

Дополнительная информация по запросу

requireCodeWord
booleanoptional

Необходимость запроса кодового слова

cardId
stringoptional

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

packageId
stringoptional

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

contractId
stringoptional

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

userStatus
array of stringsoptional

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

  • •
    DT - клиент с цифровым тарифом;
  • •
    NODT - действующий клиент;
  • •
    FAMILY - клиент Семейного Банка
url
stringoptional

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

subscription
stringoptional

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

array of objectsoptional

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

month
stringrequired

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

status
stringrequired

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

cause
stringoptional

Дополнительные данные не запрашивались (ответ оркестратора)

productType
stringoptional

Тип продукта

status
stringrequired

Статус-результат обработки заявки

Пример ответа 201 (Created)
1{
2  "formId": "55A42D1698400C9EE0543863BB4C2866",
3  "status": "APPROVAL_REJECT",
4  "draftId": "5DCD7E06A44C463781A87CC3302F0E1D",
5  "payload": {
6    "cause": "NOT_REQUESTED"
7  },
8  "productType": "DC"
9}
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

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

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

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

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