ym88659208ym87991671
Управлять лимитами бизнес-карт компании | Документация для разработчиков

Управлять лимитами бизнес-карт компании

Обновлено 21 февраля 2024

Схема работы функциональности

Шаги

  1. Получить access_token
  2. Получить corpCardId
  3. Получить текущие настройки лимитов
  4. Создать заявление на изменение лимита
  5. Получить статус заявления на изменение лимита

Usecase

Участники

  • Руководитель - представитель ЮЛ/ИП, ответственный за финансовые операции компании и который имеет пользовательский профиль в СберБизнес своей компании с правом подписи;
  • Платформа - любое программное обеспечение для внутреннего использования компании или web-ресурс (интернет-магазин, мобильное приложение и т.д.), который Вы используете в рамках клиентского пути Клиентов;
  • СберБизнес ID - единая учетная запись пользователя ЮЛ/ИП, используемая для регистрации и входа пользователей в продукты и сервисы Банка и партнеров Sber API;
  • Банк - в контексте usecase включает в себя ресурсы Sber API и любые службы ПАО "Сбербанк";

Предусловия

  • Руководитель авторизован на Платформе
  • Руководитель находится на Платформе

Постусловия

  • Руководитель увидел текущие настройки лимитов по бизнес-картам компании
  • Изменены настройки лимита по конкретной бизнес-карте (при необходимости)
Usecase
  • Процесс получения access_token необходимо реализовать с помощью сервиса СберБизнес ID.

Получение списка бизнес-карт (/v1/business-cards)

Alt text https://fintech.sberbank.ru:9443/fintech/api/v1/business-cards

Метод /v1/business-cards позволяет получать список бизнес-карт своей организации с основными данными по ним, для идентификации нужной бизнес-карты и установки для нее динамического лимита.

Запрос списка карт производится постранично. Необходимо запрашивать постранично данные бизнес-карт, начиная с первой страницы и опрашивать следующую до того момента, как в полученном ответе перестанет приходить href c признаком "rel": "next". Отсутствие href будет означать, что следующей страницы нет. На запрос первой страницы в ответе вернется список карт, если они существуют, и контейнер links с параметром (href) на следующую страницу и признаком "rel": "next". На запрос второй страницы в ответе вернется список карт и контейнер links с параметром (href) на следующую и предыдущую страницы и признаками "rel": "prev", "rel": "next". Получение последующих страниц производится по аналогии.

Для получения списка бизнес-карт компании необходимо отправить GET-запрос /v1/business-cards с токеном доступа (access_token) пользователя в параметре Authorization заголовка, необходимой страницей (page) и статусом бизнес-карт (statusCodes) в querry-параметрах запроса.

В параметре scope ссылки авторизации пользователя должен быть указан сервис BUSINESS_CARD_LIMIT для получения доступа к этому методу.


Для обращения к методу необходимо отправлять запрос на:

  • Тестовый контур https://iftfintech.testsbi.sberbank.ru:9443/fintech/api
  • Промышленный контур https://fintech.sberbank.ru:9443/fintech/api

Request

/v1/business-cards
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
AuthorizationstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})-((1)|(2))$requiredAccess token пользователя, полученный через SSO.
QUERRY PARAMETERS
pageintegerinteger^[0-9]$requiredНомер страницы со списком бизнес-карт,
statusCodesstringstring^(ACTIVE|BLOCKED|TO_BE_REISSUED|TO_BE_BLOCKED|NOT_DELIVERED)$requiredСписок статусов бизнес-карт. Указывается в случае, если необходимо получить список бизнес-карт, имеющих один из перечисленных статусов.
Возможные статусы:
ACTIVE – Активна,
BLOCKED – Заблокирована,
TO_BE_REISSUED – Запрошен перевыпуск,
TO_BE_BLOCKED – Запрошена блокировка,
NOT_DELIVERED – Выпущена, но не доставлена

Передается в формате: statusCodes=ACTIVE,NOT_DELIVERED

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
BusinessCards {
   _linksArray[Link]optionalСсылки на связанные ресурсы,
businessCardsArray[BusinessCardBase]optionalСписок бизнес-карт организации
}
Link [
   {
      hrefstringrequaredАбсолютный или относительный адрес,
      relstringrequaredОтношение ссылки к текущей сущности (next, prev)
   }
]
BusinessCardBase [
   {
      businessCardIdstringoptionalУникальный идентификатор бизнес-карты,
      cardExpiredDatestringoptionalСрок действия карты,
      cardPanstringoptionalМаскированный номер карты,
      cardholderNamestringoptionalФИО держателя,
      accountNumberstringoptionalНомер счета, к которому привязана бизнес-карта,
      bankBicstringoptionalБИК банка, в котором открыт счет бизнес-карты,
      embossedTextstringoptionalЭмбоссированные имя и фамилия держателя,
      cardholderBirthdaydateoptionalДата рождения держателя,
      cardTypestringoptionalПлатежная система и тип карты,
      statusstringoptionalВозможные статусы:
ACTIVE – Активна,
BLOCKED – Заблокирована,
TO_BE_REISSUED – Запрошен перевыпуск,
TO_BE_BLOCKED – Запрошена блокировка,
NOT_DELIVERED – Выпущена, но не доставлена
   }
]
400 (Bad request)
CauseMessageDescription
DESERIALIZATION_FAULTНеверный формат запросаДанные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request метода. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULTОшибка валидацииДанные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request метода, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.
НаименованиеТипОбязательностьОписание
ResourceFault {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
   checksArray[Check]optionalСписок проверок, приведших к ошибке,
   fieldNamesArray[string]optionalНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check [
   {
      levelstringoptionalУровень результата = ['ERROR', 'WARNING'],
      messagestringoptionalСообщение,
      fieldsArray[string]optionalНазвания полей (при наличии связи с моделью)
   }
]
401 (Unauthorized Error)
CauseMessageDescription
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
403 (Forbidden)
CauseMessageDescription
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.
В строке аутентификации СберБизнес ID, в параметре scope, не указана операция BUSINESS_CARD_LIMIT. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти аутентификацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}

Получение информации по бизнес-карте (/v1/corporate-cards/{corpCardId})

Alt text https://fintech.sberbank.ru:9443/fintech/api/v1/corporate-cards/{corpCardId}

Метод /v1/corporate-cards/{corpCardId} позволяет получить информацию по открытой бизнес-карте.

Для получения информации по бизнес-карте необходимо отправить GET-запрос /v1/corporate-cards/{corpCardId} с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатор бизнес-карты (corpCardId) в path-параметре запроса.

В параметре scope ссылки авторизации пользователя вашей компании должен быть указан сервис CORPORATE_CARDS для получения доступа к этому методу.


Для обращения к методу необходимо отправлять запрос на:

  • Тестовый контур https://iftfintech.testsbi.sberbank.ru:9443/fintech/api
  • Промышленный контур https://fintech.sberbank.ru:9443/fintech/api

Request

/v1/corporate-cards/:corpCardId
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
AuthorizationstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})-((1)|(2))$requiredAccess token пользователя, полученный через SSO.
PATH PARAMETERS
corpCardIdstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})$requiredИдентификатор бизнес-карты, который вы ранее получили в рамках процесса выпуска бизнес-карты либо запросили на предыдущем шаге с помощью метода /v1/business-cards.

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
CorpCardBase {
   cardExpiredDatestringoptionalДата окончания действия карты,
   cardIssuedDatestringoptionalДата выдачи карты,
   cardPanstringoptionalНомер карты,
   corpCardIdstringoptionalИдентификатор бизнес-карты,
   embossedTextstringoptionalЭмбоссированные имя и фамилия держателя,
   accountstringoptionalНомер счета, к которому привязана бизнес-карта,
   cardTypestringoptionalПлатежная система и тип карты,
   limitsArray[CorpCardLimit]optionalЛимиты по карте
}
CorpCardLimit [
   {
      amountnumberoptionalЗначение лимита,
      codestringoptionalКод типа лимита
   }
]
400 (Bad request)
CauseMessageDescription
DESERIALIZATION_FAULTНеверный формат запросаДанные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request метода. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULTОшибка валидацииДанные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request метода, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.
НаименованиеТипОбязательностьОписание
ResourceFault {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
   checksArray[Check]optionalСписок проверок, приведших к ошибке,
   fieldNamesArray[string]optionalНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check [
   {
      levelstringoptionalУровень результата = ['ERROR', 'WARNING'],
      messagestringoptionalСообщение,
      fieldsArray[string]optionalНазвания полей (при наличии связи с моделью)
   }
]
401 (Unauthorized Error)
CauseMessageDescription
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
403 (Forbidden)
CauseMessageDescription
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.
В строке аутентификации СберБизнес ID, в параметре scope, не указана операция CORPORATE_CARDS. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти аутентификацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
404 (Not Found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найденУказан некорректный corpCardId в path-параметре запроса.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}

Создание заявления на изменение лимита бизнес-карты (/v1/business-cards/limits)

Alt text https://fintech.sberbank.ru:9443/fintech/api/v1/business-cards/limits

Метод /v1/business-cards/limits позволяет создавать документ: «Заявления на изменение лимита бизнес-карты». Документ можно создать без подписи в виде черновика либо сразу с подписью. Банк начинает обработку заявления при наличии подписи.

Для создания заявления на изменение лимита по бизнес-карте необходимо отправить POST-запрос /v1/business-cards/limits с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизиты заявления в теле запроса.

В параметре scope ссылки авторизации пользователя должен быть указан сервис BUSINESS_CARD_LIMIT для получения доступа к этому методу.


Для обращения к методу необходимо отправлять запрос на:

  • Тестовый контур https://iftfintech.testsbi.sberbank.ru:9443/fintech/api
  • Промышленный контур https://fintech.sberbank.ru:9443/fintech/api

Request

/v1/business-cards/limits
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
AuthorizationstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})-((1)|(2))$requiredAccess token пользователя, полученный через SSO.
BODY
BusinessCardLimitChange {
   businessCardIdstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})$requiredИдентификатор бизнес-карты,
   codestringstring^[a-zA-Z0-9._ -]{1-19}$

Актуальный список значений можно получить с помощью справочника CorpCardLimitType
requiredКод лимита,
   digestSignaturesArray[Signature]      optionalЭлектронные подписи по дайджесту документа,
   externalIdstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})$requiredВнешний идентификатор заявления на изменение лимита,
   limitnumberfloat^[0-9]+(.[0-9]+)?$requiredРазмер лимита на период
}
Signature [
   {
      base64Encodedstringbase64^[a-zA-Z0-9]+$optionalЗначение электронной подписи (ЭП), закодированное в Base64.
Можно передать одну или две ЭП вместе с реквизитами создаваемого документа - ссылка на ЭП.
Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу.
Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе СберБизнес,
      certificateUuidstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})$optionalУникальный идентификатор сертификата ключа проверки электронной подписи
   }
]

digestSignatures

Передача электронной подписи

Передача электронной подписи (ЭП) осуществляется с использованием массива digestSignatures, где каждый элемент представляет собой подпись (Signature). Каждая подпись должна содержать следующие обязательные поля:

Наименование поляОписание поляПример
base64Encoded (string)Значение ЭП документаHlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==
certificateUuid (string)Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto или /v1/crypto/eio)22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6

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

Документ может быть подписан следующими наборами подписей:

  • одна (единственная) подпись;
  • первая и вторая подписи.

При этом нельзя сочетать подпись, имеющую единственное полномочие, с подписью, имеющей первую или вторую подписи.

Порядок наложения подписи не имеет значения при наложении первой и второй подписей. Состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля при создании пользователя в СберБизнес.

Алгоритм сортировки
  1. Поля дайджеста должны быть отсортированы по алфавиту.
  2. Разделитель строк должен быть в формате unix (одиночный \n).
  3. Последняя строка дайджеста не должна содержать перевод строки.
  4. Перевод строк должен быть экранирован как \n.
Формат дайджеста
Наименование поляОписание поляПример
businessCardIdИдентификатор бизнес-картыccf62938-cbda-4785-a008-12bd300bef80
limitРазмер лимита на период2650000.00
codeКод лимитаNON_RENEW
externalIdИдентификатор заявления31663ef5-7975-4016-b0f3-f1d70a4e9c22

Responses

201 (Created)
НаименованиеТипОбязательностьОписание
BusinessCardLimitChangeRes {
   bankCommentstringoptionalБанковский комментарий к статусу документа,
   bankStatusstringoptionalСтатус документа,
   businessCardIdstringrequiredИдентификатор бизнес-карты,
   codestringrequiredКод лимита,
   datestringrequiredДата составления документа,
   digestSignaturesArray[Signature]optionalЭлектронные подписи по дайджесту документа,
   externalIdstringrequiredВнешний идентификатор заявления на изменение лимита,
   limitnumberrequiredРазмер лимита на период,
   numberstringrequiredНомер документа
}
Signature [
   {
      base64EncodedstringoptionalЗначение электронной подписи (ЭП), закодированное в Base64.
Можно передать одну или две ЭП вместе с реквизитами создаваемого документа - ссылка на ЭП.
Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу.
Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе СберБизнес,
      certificateUuidstringoptionalУникальный идентификатор сертификата ключа проверки электронной подписи
   }
]
202 (Accepted)
CauseMessageDescription
WORKFLOW_FAULTДокумент сохранен, но обработка ЭП или принятие документа завершились ошибкой. ЭП не может быть принятаНеизвестный идентификатор сертификата. Проверьте корректность отправленной ЭП в запросе.
Возможно, была отправлена ЭП с типом "Первая подпись" или "Вторая подпись". Для случаев, когда используется ЭП подписантов с типом "Первая подпись" или "Вторая подпись" для принятия документа в обработку требуется передать в запросе данные обеих подписей.
НаименованиеТипОбязательностьОписание
WorkflowFault {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
   checksArray[Check]optionalСписок проверок, приведших к ошибке,
   fieldNamesArray[string]optionalНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check [
   {
      levelstringoptionalУровень результата = ['ERROR', 'WARNING'],
      messagestringoptionalСообщение,
      fieldsArray[string]optionalНазвания полей (при наличии связи с моделью)
   }
]
400 (Bad request)
CauseMessageDescription
DESERIALIZATION_FAULTНеверный формат запросаДанные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request метода. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULTОшибка валидацииДанные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request метода, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.
НаименованиеТипОбязательностьОписание
ResourceFault {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
   checksArray[Check]optionalСписок проверок, приведших к ошибке,
   fieldNamesArray[string]optionalНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check [
   {
      levelstringoptionalУровень результата = ['ERROR', 'WARNING'],
      messagestringoptionalСообщение,
      fieldsArray[string]optionalНазвания полей (при наличии связи с моделью)
   }
]
401 (Unauthorized Error)
CauseMessageDescription
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
403 (Forbidden)
CauseMessageDescription
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.
В строке аутентификации СберБизнес ID, в параметре scope, не указана операция BUSINESS_CARD_LIMIT. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти аутентификацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}

Получение статуса заявления на изменение лимита (/v1/business-cards/limits/{externalId}/state)

Alt text https://fintech.sberbank.ru:9443/fintech/api/v1/business-cards/limits/{externalId}/state

Метод /v1/business-cards/limits/{externalId}/state позволяет получить статус ранее отправленного электронного документа\черновика – «Заявление на изменение лимита бизнес-карты».

Для получения информации о статусе рассмотрения заявления на изменение лимита бизнес-карты необходимо отправить GET-запрос /v1/business-cards/limits/{externalId}/state с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатор заявления (externalId) в path-параметре запроса.

В параметре scope ссылки авторизации пользователя вашей компании должен быть указан сервис BUSINESS_CARD_LIMIT для получения доступа к этому методу.


Для обращения к методу необходимо отправлять запрос на:

  • Тестовый контур https://iftfintech.testsbi.sberbank.ru:9443/fintech/api
  • Промышленный контур https://fintech.sberbank.ru:9443/fintech/api

Request

/v1/business-cards/limits/:externalId/state
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
AuthorizationstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})-((1)|(2))$requiredAccess token пользователя, полученный через SSO.
PATH PARAMETERS
externalIdstringUUID^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})$requiredИдентификатор документа, присвоенный вами при создании заявления на изменения лимита по бизнес-карте

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
DocState {
   bankCommentstringoptionalБанковский комментарий к статусу документа,
   bankStatusstringoptionalСтатус документа,
   channelInfostringoptionalКомментарий, специфичный для документа, полученного по данному каналу,
}
400 (Bad request)
CauseMessageDescription
DESERIALIZATION_FAULTНеверный формат запросаДанные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request метода. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULTОшибка валидацииДанные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request метода, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.
НаименованиеТипОбязательностьОписание
ResourceFault {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
   checksArray[Check]optionalСписок проверок, приведших к ошибке,
   fieldNamesArray[string]optionalНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check [
   {
      levelstringoptionalУровень результата = ['ERROR', 'WARNING'],
      messagestringoptionalСообщение,
      fieldsArray[string]optionalНазвания полей (при наличии связи с моделью)
   }
]
401 (Unauthorized Error)
CauseMessageDescription
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
403 (Forbidden)
CauseMessageDescription
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.
В строке аутентификации СберБизнес ID, в параметре scope, не указана операция BUSINESS_CARD_LIMIT. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти аутентификацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найден 
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
   causestringoptionalПричина или основание сообщения,
   referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
   messagestringoptionalСообщение,
}
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.