Проверить возможность использования лояльности при оплате подписки

Обновлено 11 марта 2025

POST

/info/subscriptions/recurrentLoyalty

Проверить возможность использования лояльности при оплате подписки

Запрос

Header Parameters

RqUID

string

required

Возможные значения: <= 32 characters, Value must match regular expression ^[0-9a-fA-F]{32}$

Уникальный идентификатор запроса

Sberx-System-Id
string
Значение должно соответствовать регулярному выражению ^[0-9A-Z_. -]{1,50}$
Идентификатор внешней системы
Example: SUPERAPP
Sberx-Sub-System-Id
string
Значение должно соответствовать регулярному выражению ^[0-9A-Z_. -]{1,50}$
Идентификатор внешней подсистемы
Example: SBER_PRIME

• application/json

Body

required

subscriptionId

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

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

Ответы

• 200
• 400
• 401
• 403
• 404
• 408
• 409
• 422
• 500
• 503

OK

• application/json

• Схема
• Пример из схемы

Schema

possibleUsage

boolean

required

Признак возможной доступности лояльности (Без учета факта подключения к системе лояльности)

countUsage

int32

required

Возможные значения: >= 0 и <= 1000000

Количество раз использования баллов лояльности платежным инструментом

possibleRecurrentUsage

boolean

required

Признак возможного использования лояльности в рекуренте (без учета факта подключения к системе лояльности и использования лояльности внешними платежными системами или с их искажением)

countRecurrentUsage

int32

required

Возможные значения: >= 0 и <= 1000000

Количество раз использования баллов лояльности платежным инструментом в рекуренте (без учета использования лояльности внешними платежными системами или с их искажением)

lastUsage

string

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d\d\d$

Дата время последнего использования баллов лояльности платежным инструментом

loyaltyPointsAvailable

number

Возможные значения: >= 0 и <= 999999999

Доступно баллов лояльности

loyaltyState

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,100}$

Статус потребителя в системе лояльности

system

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,10}$

Система платежного инструмента

issuer

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Эмитент платежного инструмента

maskNumber

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Z\\*]{1,25}$

Маскированный номер платежного инструмента

expired

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Z]{1,6}$

Срок действия платежного инструмента

{
  "possibleUsage": true,
  "countUsage": 1,
  "possibleRecurrentUsage": true,
  "countRecurrentUsage": 5,
  "lastUsage": "2022-05-15T12:12:12.123+0300",
  "loyaltyPointsAvailable": 499.99,
  "loyaltyState": "не участник",
  "system": "MIR",
  "issuer": "SBERBANK OF RUSSIA",
  "maskNumber": "123456XXXX7890",
  "expired": "202905"
}

Bad Request

• application/json

• Схема
• Пример из схемы

Schema

oneOf

• SberapiError
• HttpError

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

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

moreInformation

string

required

Возможные значения: <= 250 characters, Value must match regular expression ^(.*)$

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

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

Перечень параметров ошибки для локализации

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{}

Unauthorized

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

Перечень параметров ошибки для локализации

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Forbidden

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

Перечень параметров ошибки для локализации

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Not Found

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

Перечень параметров ошибки для локализации

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Request Timeout

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

Перечень параметров ошибки для локализации

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Conflict

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

Перечень параметров ошибки для локализации

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Unprocessable Entity

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

Перечень параметров ошибки для локализации

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Internal Server Error

• application/json

• Схема
• Пример из схемы

Schema

oneOf

• SberapiError
• HttpError

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

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

moreInformation

string

required

Возможные значения: <= 250 characters, Value must match regular expression ^(.*)$

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

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

Перечень параметров ошибки для локализации

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{}

Service Unavailable

• application/json

• Схема
• Пример из схемы

Schema

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$

Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)

status

int32

required

Возможные значения: >= -2147483648 и <= 2147483647

Статус

error

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Описание статуса

errorCode

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Бизнес-код ошибки

message

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$

Сообщение об ошибке для отображения на UI без локализации

reason

string

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$

Описание причины ошибки

params

object[]

Possible values: <= 100

Перечень параметров ошибки для локализации

Array [

code

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$

Код параметра ошибки

value

string

required

Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$

Значение параметра ошибки

]

{
  "timestamp": "2020-12-18T06:12:44.672+00:00",
  "status": 404,
  "error": "Not Found",
  "errorCode": "UNKNOWN_ERROR",
  "message": "Запись не найдена в БД",
  "reason": "Ошибка БД",
  "params": [
    {
      "code": "id",
      "value": "b439162d-e60d-426d-979d-17641f2b6ae4"
    }
  ]
}

Loading...

Loading...