B2C

Получение способов доставки

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

plastic-delivery

Описание

Метод предназначен для получения информации о доступных способах доставки пластиковой карты по заданному адресу. Возможные варианты доставки:

  • •
    в офис Банка;
  • •
    курьерская доставка.
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

QUERY
Атрибут
Описание
accuracy
integerrequired

Точность определения координат

address
stringrequired

Адрес, в радиусе которого ведётся поиск

kladrId
stringrequired
latitude
numberrequired

Широта

longitude
numberrequired

Долгота

radius
numberoptional

Радиус поиска относительно указанных координат, м

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

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

Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/pp/v1/debit-cards/forms/{formId}/delivery-type?accuracy={accuracy}&address={address}&kladrId={kladrId}&latitude={latitude}&longitude={longitude}&radius={radius}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "onlyCourierDelivery": true,
3  "courier": {
4    "cardAttributes": {
5      "unnamedCardEnabled": true,
6      "namedCardEnabled": false
7    },
8    "cityId": 21,
9    "latitude": 55.659348,
10    "longitude": 37.472996,
11    "uuid": "07a91616-53e1-4ee1-8045-0544e4590a18",
12    "availableDates": [
13      {
14        "date": "2024-06-03",
15        "slots": [
16          {
17            "isAvailable": true,
18            "slotFrom": "10:00",
19            "slotTo": "11:00",
20            "express": false
21          }
22        ]
23      }
24    ]
25  },
26  "offices": [
27    {
28      "pid": "0610",
29      "uuid": "83e92bd6-60cd-4924-91a0-571a635c3244",
30      "mnemonic": "MOES",
31      "title": "ДО «ЮГО-ЗАПАДНАЯ»",
32      "address": "пр-кт Вернадского, д.119",
33      "addressOfficial": "119571, г. Москва, пр-кт Вернадского, д. 119",
34      "cardAttributes": {
35        "unnamedCardEnabled": true,
36        "namedCardEnabled": false,
37        "anyOfficeUnnamedEnabled": false
38      },
39      "metro": [
40        {
41          "id": "1.162",
42          "title": "Юго-Западная",
43          "distance": 604,
44          "lineId": 1,
45          "lineColor": "E42313",
46          "lineName": "Сокольническая"
47        }
48      ],
49      "clientAvailability": "OPENED",
50      "embossingEnabled": true,
51      "prodType": [
52        "pointone",
53        "pointtwo",
54        "serviceoffice"
55      ],
56      "schedule": [
57        "пн-пт: 10:00-20:00",
58        "сб: 10:00-18:00",
59        "вс: выходной"
60      ],
61      "temporarySchedule": [
62        {
63          "date": "с 10.02.2023 по 12.02.2023",
64          "times": [
65            "пн-ср: 10:00-18:00"
66          ]
67        }
68      ],
69      "constraints": [
70        {
71          "date": "1 сентября",
72          "times": "c 10:00 до 19:00"
73        }
74      ],
75      "distance": 3441,
76      "city": {
77        "name": "Москва",
78        "fiasId": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
79        "kladrId": "7700000000000"
80      }
81    }
82  ],
83  "availableAdditionalCards": [
84    {
85      "card": "LG",
86      "score": 0.003126000054180622
87    },
88    {
89      "card": "LK",
90      "score": 0.002501
91    }
92  ],
93  "availableServices": [
94    {
95      "service": "ALPHA_CHECK",
96      "score": 0.003126000054180622
97    },
98    {
99      "service": "COMBO_ACCOUNT",
100      "score": 0.0012
101    }
102  ]
103}
BODY
атрибут
описание
onlyCourierDelivery
booleanrequired

Признак доступности только курьерской доставки

objectrequired

Параметры курьерской доставки

objectrequired

Атрибуты карты и её доступности

unnamedCardEnabled
booleanrequired

Признак доступности неименной карты

namedCardEnabled
booleanrequired

Признак доступности именной карты

cityId
integerrequired

Код города доставки

latitude
numberrequired

Широта

longitude
numberrequired

Долгота

uuid
stringrequired

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

array of objectsrequired

Список дат с доступными тайм-слотами

date
stringoptional

Дата доступных тайм-слотов

array of objectsrequired

Список слотов

isAvailable
booleanoptional

Признак доступности слота

slotFrom
stringoptional

Время начала слота

slotTo
stringoptional

Время окончания слота

express
booleanoptional

Признак экспресс-доставки

array of objectsrequired

Список офисов, доступных в указанном радиусе для получения карты

pid
stringrequired

Внутрибанковский цифровой код (идентификатор) офиса

uuid
stringrequired

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

mnemonic
stringrequired

Мнемоника офиса

title
stringrequired

Наименование офиса

address
stringrequired

Адрес офиса

addressOfficial
stringoptional

Юридический адрес офиса

objectrequired

Атрибуты карты и её доступности

unnamedCardEnabled
booleanrequired

Признак доступности неименной карты

namedCardEnabled
booleanrequired

Признак доступности именной карты

anyOfficeUnnamedEnabled
booleanrequired

Признак доступности получения неименной карты в любом офисе

array of objectsoptional

Список ближайших к офису станций метро

id
stringrequired

Идентификатор станции метро

title
stringrequired

Наименование станции метро

distance
integerrequired

Расстояние до офиса, м.

lineId
integerrequired

Идентификатор линии метро

lineColor
stringrequired

Цвет линии метро

lineName
stringrequired

Наименование линии метро

clientAvailability
stringrequired

Признак доступности офиса

embossingEnabled
booleanrequired

Признак возможности эмбоссирования карты

prodType
array of stringsrequired

Список характеристик (сервисов) офиса

schedule
array of stringsrequired

Расписание работы офиса (дни недели и время)

array of objectsoptional

Временное расписание работы офиса

date
stringoptional

Даты работы в рамках временного расписания

times
array of stringsoptional

Время работы в рамках временного расписания

array of objectsoptional

Ограничения в работе отделения

date
stringoptional

Даты работы

times
stringoptional

Время работы

distance
numberrequired

Расстояние от адреса пользователя до офиса, м.

objectrequired

Город расположения офиса

name
stringrequired

Наименование города отделения

fiasId
stringrequired

Код ФИАС (Федеральная информационная адресная система) города отделения

kladrId
stringrequired
array of objectsoptional

Доступные карточные продукты

card
stringrequired

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

  • •
    LG - детская карта;
  • •
    LK - стикер
score
numberrequired

Вес карточного продукта, рассчитанный ДПА моделью (если продукта нет в модели - ставится 0).

array of objectsoptional

Доступные некарточные продукты

service
stringrequired

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

  • •
    ALPHA_CHECK - Альфа-чек;
  • •
    COMBO_ACCOUNT - комбо счёт;
  • •
    BROKERAGE_ACCOUNT - брокерский счёт
score
numberrequired

Вес некарточного продукта, рассчитанный ДПА моделью (если продукта нет в модели - ставится 0).

Пример ответа 200 (OK) 
1{
2  "onlyCourierDelivery": true,
3  "courier": {
4    "cardAttributes": {
5      "unnamedCardEnabled": true,
6      "namedCardEnabled": false
7    },
8    "cityId": 21,
9    "latitude": 55.659348,
10    "longitude": 37.472996,
11    "uuid": "07a91616-53e1-4ee1-8045-0544e4590a18",
12    "availableDates": [
13      {
14        "date": "2024-06-03",
15        "slots": [
16          {
17            "isAvailable": true,
18            "slotFrom": "10:00",
19            "slotTo": "11:00",
20            "express": false
21          }
22        ]
23      }
24    ]
25  },
26  "offices": [
27    {
28      "pid": "0610",
29      "uuid": "83e92bd6-60cd-4924-91a0-571a635c3244",
30      "mnemonic": "MOES",
31      "title": "ДО «ЮГО-ЗАПАДНАЯ»",
32      "address": "пр-кт Вернадского, д.119",
33      "addressOfficial": "119571, г. Москва, пр-кт Вернадского, д. 119",
34      "cardAttributes": {
35        "unnamedCardEnabled": true,
36        "namedCardEnabled": false,
37        "anyOfficeUnnamedEnabled": false
38      },
39      "metro": [
40        {
41          "id": "1.162",
42          "title": "Юго-Западная",
43          "distance": 604,
44          "lineId": 1,
45          "lineColor": "E42313",
46          "lineName": "Сокольническая"
47        }
48      ],
49      "clientAvailability": "OPENED",
50      "embossingEnabled": true,
51      "prodType": [
52        "pointone",
53        "pointtwo",
54        "serviceoffice"
55      ],
56      "schedule": [
57        "пн-пт: 10:00-20:00",
58        "сб: 10:00-18:00",
59        "вс: выходной"
60      ],
61      "temporarySchedule": [
62        {
63          "date": "с 10.02.2023 по 12.02.2023",
64          "times": [
65            "пн-ср: 10:00-18:00"
66          ]
67        }
68      ],
69      "constraints": [
70        {
71          "date": "1 сентября",
72          "times": "c 10:00 до 19:00"
73        }
74      ],
75      "distance": 3441,
76      "city": {
77        "name": "Москва",
78        "fiasId": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
79        "kladrId": "7700000000000"
80      }
81    }
82  ],
83  "availableAdditionalCards": [
84    {
85      "card": "LG",
86      "score": 0.003126000054180622
87    },
88    {
89      "card": "LK",
90      "score": 0.002501
91    }
92  ],
93  "availableServices": [
94    {
95      "service": "ALPHA_CHECK",
96      "score": 0.003126000054180622
97    },
98    {
99      "service": "COMBO_ACCOUNT",
100      "score": 0.0012
101    }
102  ]
103}
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}
Нет тела ответа
Проверка наличия у заявки состояния 'Черновик'Бронирование тайм-слота для курьерской доставки