Получение списка бонусных номеров

Песочница

GET https://sandbox.alfabank.ru/api/pp/v1/bonus-numbers

Пром

GET https://baas.alfabank.ru/api/pp/v1/bonus-numbers

Scope

loyalty-program

Описание

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

Параметры запроса

HEADERS

Атрибут

Описание

Authorization

stringrequired

Bearer {access_token}, полученный по Authorization Code Flow

stringrequired

application/json

Пример запроса

Язык

1curl --location 'https://baas.alfabank.ru/api/pp/v1/bonus-numbers' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'

Параметры ответа

Пример ответа 200 (OK)

1{
2  "bonusNumbers": [
3    {
4      "number": "123456789",
5      "typeLoyalty": "AlfaTravel"
6    },
7    {
8      "number": "987654321",
9      "typeLoyalty": "AlfaMiles"
10    }
11  ]
12}

BODY

атрибут

описание

array of objectsoptional

Бонусный номер карты и соответствующий тип лояльности

number

stringoptional

Номер бонусной карты клиента

typeLoyalty

stringoptional

Тип лояльности

Пример ответа 200 (OK)

1{
2  "bonusNumbers": [
3    {
4      "number": "123456789",
5      "typeLoyalty": "AlfaTravel"
6    },
7    {
8      "number": "987654321",
9      "typeLoyalty": "AlfaMiles"
10    }
11  ]
12}

BODY

атрибут

описание

error

stringrequired

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

•

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

error_description

stringoptional

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

Пример ошибки 400 (Bad Request)

1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}

BODY

атрибут

описание

error

stringrequired

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

•

invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_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 и параметра prompt=consent

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 - эндпоинт не найден или неактивен;
•

not_found - бонусный номер не найден

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}

Нет тела ответа