Сервис получения информации о статусах обработки заявлений на открытие аккредитива
Обновлено 20 декабря 2023
Сервис предоставляет информацию о статусах заявлений на открытие аккредитива. За один запрос возможно получить информацию о статусах не более чем по 100 заявлениям на открытие аккредитива.
Для вызова сервиса потребуется получить токен доступа.
Получение токена доступа выполняется с помощью API Получение токена OAUTH. Перед тем, как использовать сервис API, необходимо отправить запрос на формирование токена авторизации.
После успешного формирования токена в ответном сообщении будет возвращен идентификатор токена, который необходимо указывать в заголовке Authorization в каждом запросе к API.
Токен нужно получать для каждого нового запроса к API. Срок жизни токена составляет 60 сек.
| Scope | auth://tradefin/lc-legal/application |
| Endpoint | https://mc.api.sberbank.ru/prod/tradefin/lc-legal/v1/application/open-domestic-lc/statuses |
| Method | GET |
| Request Body | - |
| Request Parameters | query: коллекция applicationId, где applicationId - идентификатор созданного ранее черновика заявления на открытие аккредитива |
| Response | HTTP 200 ОК |
| H TTP 400 Ошибка валидации запроса: \<Текст ошибки валидации> | |
| HTTP 403 Проверка токена не пройдена | |
| HTTP 500 Ошибка сервиса. Попробуйте еще раз, если ошибка повторяется, то обратитесь в службу поддержки. | |
| Response Parameters | Коллекция объектов openLcDomesticStatus (Информация по статусу обработки заявления) |
Заголовки запроса
| Наименование заголовка | Описание | Обязательность поля |
|---|---|---|
| authorization | Токен авторизации, полученный в Токен OAUTH. В начало заголовка необходимо добавить строку «Bearer» с пробелом. | Да |
| RqUID | Уникальный идентификатор сообщения, pattern=([0-9]|[a-f]|[A-F]){32})», переданный во входящем сообщении. Необходим для журналирования входящих вызовов и удобства разбора инцидентов.Чтобы обеспечить уникальность, можно использовать стандартные библиотеки и классы для генерации UUID/GUID(см. UUID), убрав из результата разделители «-». | Да |
Тело ответа openLcDomesticStatus (Информация по статусу обработки заявления)
| Наименование | Обязательность | Тип | Описание | |
|---|---|---|---|---|
| applicationId | да | Строка (19) | Идентификатор черновика заявления в формате \^\d+\$ | |
| number | да | Строка (20) | Номер заявления | |
| status | да | ENUM ( VALIDATION_ERROR, READY_TO_SIGN, PART_SIGNED, CONSULT_REQUESTED,CONSULT_IN_PROGRESS, CONSULT_RECEIVED,READY_FOR_CLIENT, SENT_TO_BANK, IN_PROGRESS, REJECTED, DONE, REVOCATION, REVOKED, MARKETPLACE_DRAFT, UNDEFINED ) | Статус заявления: VALIDATION_ERROR- Содержит ошибки READY_TO_SIGN- Создан PART_SIGNED - Частично подписан MARKETPLACE_DRAFT - Черновик из магазина CONSULT_REQUESTED - Черновик отправлен в банк CONSULT_IN_PROGRESS - Черновик в работе CONSULT_RECEIVED - Черновик из банка (черновик был инициирован плательщиком) READY_FOR_CLIENT - Черновик из банка (черновик был инициирован банком) SENT_TO_BANK - Отправлен в Банк IN_PROGRESS - В работе REJECTED - Отклонен банком DONE - Исполнен REVOCATION - Запрошен отзыв REVOKED - Отозван UNDEFINED - Не определен | |
| lastStatusChangeDateTime | нет | Дата время | Последняя дата и время изменения статуса | |
| statusAdditionalInfo | нет | Объект statusAdditionalInfo | Дополнительная информация по статусу | |
| reference | нет | Строка (50) | Референс аккредитива открытого по заявлению. Передается только по заявлениям в статусе Исполнено (DONE) | |
| rejectReason | нет | Строка (1000) | Причина отказа. Передается только по заявлениям в статусе Отклонен банком (REJECTED) |
Пример запроса
GET https://mc.api.sberbank.ru/prod/tradefin/lc-legal/v1/service-allowed?inn=5630020111&ogrn=1105658002111&kpp=563001001
Authorization: Bearer 5a9143e9-e39b-4130-958e-558524dc622a
Content-Type: application/json
RqUID: c6da1b21f459433da289f5684dba5b67
Пример ответа
HTTP/1.1 200 OK
Server: nginx/1.22.1
Date: Mon, 29 May 2023 05:37:37 GMT
Content-Length: 0
Connection: keep-alive
X-Gravitee-Transaction-Id: ac1272eb-fba4-4c59-9272-ebfba44c591b
X-Gravitee-Request-Id: ac1272eb-fba4-4c59-9272-ebfba44c591b
X-Rate-Limit-Limit: 20
X-Rate-Limit-Remaining: 19
X-Rate-Limit-Reset: 1685338657848
x-content-type-options: nosniff
x-xss-protection: 1; mode=block
cache-control: no-cache, no-store, max-age=0, must-revalidate
pragma: no-cache
expires: 0
strict-transport-security: max-age=31536000 ; includeSubDomains
x-frame-options: DENY
Accept-Ranges: bytes
<Response body is empty>