B2C

Проверка наличия у заявки состояния 'Черновик'

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

plastic-delivery

Описание

Метод используется для проверки, находится ли заявка в статусе "Черновик". В случае, если заявка находится в статусе "Черновик", пользователю доступна доставка пластиковой карты. Чтобы узнать способы доставки, необходимо использовать метод «Получение способов доставки».

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

application/json

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

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

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/pp/v1/debit-cards/forms/{formId}/draft' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "formId": "46989F6E808248F3BDC2EB19E6558AB5",
3  "shortMobilePhone": "3855",
4  "cardId": "RR",
5  "userStatus": [
6    "DT"
7  ],
8  "lastDtPathStatus": "SUCCESS",
9  "passportBirthDate": "1999-10-23",
10  "suggestionDeliveryAddress": "г Москва, ул Академика Анохина, д 9"
11}
BODY
атрибут
описание
formId
stringrequired

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

shortMobilePhone
stringrequired

Последние 4 цифры мобильного телефона, указанного в заявке

cardId
stringrequired

Идентификатор карты, заказанной пользователем

userStatus
array of stringsrequired

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

  • •
    DT - клиент с открытым счетом (цифровым тарифом);
  • •
    NODT - действующий клиент;
  • •
    NODT_ALL_CW - действующий клиент (идентификатор не определен);
  • •
    дополнительно может быть указано FAMILY - клиент Семейного Банка
lastDtPathStatus
stringrequired

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

  • •
    SUCCESS - успешно пройден первый шаг для клиентов, у которых не было открытого счета (цифрового тарифа);
  • •
    NODT_ALL - действующий клиент, доступны все типы доставки;
  • •
    NODT_ALL_CW - клиент, у которого не определен идентификатор в системе, доступны все типы доставки;
  • •
    NODT_O - действующий клиент, доступно только отделение;
  • •
    NODT_EXTD - новый клиент цифрового тарифа, который пока не получил карту, доступны все типы доставки
passportBirthDate
stringrequired

Дата рождения пользователя

suggestionDeliveryAddress
stringoptional

Адрес предыдущей доставки пользователя (для отображения подсказки при новом заказе)

Пример ответа 200 (OK)
1{
2  "formId": "46989F6E808248F3BDC2EB19E6558AB5",
3  "shortMobilePhone": "3855",
4  "cardId": "RR",
5  "userStatus": [
6    "DT"
7  ],
8  "lastDtPathStatus": "SUCCESS",
9  "passportBirthDate": "1999-10-23",
10  "suggestionDeliveryAddress": "г Москва, ул Академика Анохина, д 9"
11}
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

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

  • •
    conflict - заявка не является черновиком
error_description
stringoptional

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

Пример ошибки 409 (Conflict)
1{
2  "error": "conflict",
3  "error_description": "The request is valid, but cannot be completed due to some kind of mismatch"
4}
BODY
атрибут
описание
error
stringrequired

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

  • •
    failed_dependency - заявка не прошла первый шаг (phase = CREATION)
error_description
stringoptional

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

Пример ошибки 424 (Failed Dependency)
1{
2  "error": "failed_dependency",
3  "error_description": "The requested resource depends on another resource that has failed"
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}
Нет тела ответа