Получение статуса заявления на изменение лимита (/v1/business-cards/limits/{externalId}/state)
Обновлено 29 ноября 2024
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://fintech.sberbank.ru:9443/fintech/api
Request
/v1/business-cards/limits/:externalId/state
- Модель
- Пример
| Наименование | Тип | Формат | Regexp | Обязательность | Описание |
|---|---|---|---|---|---|
| HEADER | |||||
| Authorization | string | string | ^([a-zA-Z0-9]){38}$ | required | Access token пользователя, полученный через SSO. |
| PATH PARAMETERS | |||||
| externalId | string | UUID | ^([0-9A-Fa-f]{8})-([0-9A-Fa-f]{4})-([0-9A-Za-z]{4})-([0-9A-Fa-f]{12})$ | required | Идентификатор документа, присвоенный вами при создании заявления на изменения лимита по бизнес-карте |
GET /fintech/api/v1/business-cards/limits/f8ad3141-b7e8-4924-92de-3de4fd0a464e-1/state HTTP/1.1
Authorization: Bearer 1382b8bc-4dff-4f07-8cba-c2593e05f2f7-2
Responses
200 (OK)
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| DocState { | |||
| bankComment | string | optional | Банковский комментарий к статусу документа, |
| bankStatus | string | optional | Статус документа, |
| channelInfo | string | optional | Комментарий, специфичный для документа, полученного по данному каналу, |
| } |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"bankComment": "Документ в обработке",
"bankStatus": "PROCESSING",
"channelInfo": "string"
}
400 (Bad request)
| Cause | Message | Description |
|---|---|---|
| DESERIALIZATION_FAULT | Неверный формат запроса | Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос. |
| VALIDATION_FAULT | Ошибка валидации | Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос. |
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| ResourceFault { | |||
| cause | string | optional | Причина или основание сообщения, |
| referenceId | string | optional | Уникальный идентификатор ошибки (UUID), |
| message | string | optional | Сообщение, |
| checks | Array[Check] | optional | Список проверок, приведших к ошибке, |
| fieldNames | Array[string] | optional | Названия полей с некорректным значением (только для VALIDATION_FAULT) |
| } | |||
| Check [ | |||
| { | |||
| level | string | optional | Уровень результата = ['ERROR', 'WARNING'], |
| message | string | optional | Сообщение, |
| fields | Array[string] | optional | Названия полей (при наличии связи с моделью) |
| } | |||
| ] |
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
{
"cause": "VALIDATION_FAULT",
"referenceId": "0d6a80ba-7d35-4858-8443-9a77039ad9f1",
"message": "Параметр \"externalId\" не соответствует регулярному выражению: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
"checks": [],
"fieldNames": null
}
401 (Unauthorized Error)
| Cause | Message | Description |
|---|---|---|
| UNAUTHORIZED | accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х | Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос. |
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| Notice { | |||
| cause | string | optional | Причина или основание сообщения, |
| referenceId | string | optional | Уникальный идентификатор ошибки (UUID), |
| message | string | optional | Сообщение, |
| } |
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
{
"cause": "UNAUTHORIZED",
"referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
"message": "accessToken not found by value = 3513f959-bbd5-490a-9f9f-67fb7380fae5-2"
}
403 (Forbidden)
| Cause | Message | Description |
|---|---|---|
| ACTION_ACCESS_EXCEPTION | Операция не может быть выполнена: доступ к ресурсу запрещен | Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В строке аутентификации СберБизнес ID, в параметре scope, не указана операция BUSINESS_CARD_LIMIT. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти аутентификацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token. |
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| Notice { | |||
| cause | string | optional | Причина или основание сообщения, |
| referenceId | string | optional | Уникальный идентификатор ошибки (UUID), |
| message | string | optional | Сообщение, |
| } |
HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
{
"cause": "ACTION_ACCESS_EXCEPTION",
"referenceId": "7535c2bb-7706-4b16-9882-d68aedbf2fef",
"message": "Операция не может быть выполнена: доступ к ресурсу запрещен"
}
404 (Not found)
| Cause | Message | Description |
|---|---|---|
| NOT_FOUND | Документ с указанным ID не найден |
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| Notice { | |||
| cause | string | optional | Причина или основание сообщения, |
| referenceId | string | optional | Уникальный идентификатор ошибки (UUID), |
| message | string | optional | Сообщение, |
| } |
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
{
"cause": "NOT_FOUND",
"referenceId": "1bd1b8b9-1bd3-4159-9909-d30536211114",
"message": "Документ с указанным ID не найден"
}
500 (Internal Server Error)
| Cause | Message | Description |
|---|---|---|
| UNKNOWN_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| Notice { | |||
| cause | string | optional | Причина или основание сообщения, |
| referenceId | string | optional | Уникальный идентификатор ошибки (UUID), |
| message | string | optional | Сообщение, |
| } |
HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
{
"cause": "UNKNOWN_EXCEPTION",
"referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
"message": "Внутренняя ошибка сервера"
}
503 (Service Temporarily Unavailable)
| Cause | Message | Description |
|---|---|---|
| UNAVAILABLE_RESOURCE_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| Notice { | |||
| cause | string | optional | Причина или основание сообщения, |
| referenceId | string | optional | Уникальный идентификатор ошибки (UUID), |
| message | string | optional | Сообщение, |
| } |
HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: application/json;charset=UTF-8
{
"cause": "UNAVAILABLE_RESOURCE_EXCEPTION",
"referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a67d",
"message": "Внутренняя ошибка сервера"
}