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

Обновлено 20 декабря 2023

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

Данный сервис доступен только Партнерам банка, которые являются получателями по данному аккредитиву.

Для вызова сервиса потребуется получить токен доступа.

Получение токена доступа выполняется с помощью API Получение токена OAUTH. Перед тем, как использовать сервис API, необходимо отправить запрос на формирование токена авторизации.

После успешного формирования токена в ответном сообщении будет возвращен идентификатор токена, который необходимо указывать в заголовке Authorization в каждом запросе к API.

Токен нужно получать для каждого нового запроса к API. Срок жизни токена составляет 60 сек.

Scope	auth://tradefin/lc-legal/lc
Endpoint	https://mc.api.sberbank.ru/prod/tradefin/lc-legal/v1/execution-lc-document/{id}/status
Method	GET
Request Body	-
Request Parameters	path: id, где id - идентификатор созданного ранее документа на исполнение аккредитива
Response	HTTP 200 ОК
	HTTP 206 Статус документа на исполнение получить удалось, но не удалось получить информацию об оплате документа
	HTTP 403 Проверка токена не пройдена
	HTTP 404 Документ для исполнения {id} не найден
	HTTP 500 Внутренняя ошибка сервиса. Обратитесь в поддержку или попробуйте повторить запрос позднее
Response Parameters	объект executionLcDocumentStatus (Информация о статусе обработки документа для исполнения аккредитива)

Заголовки запроса

Наименование заголовка	Описание	Обязательность поля
authorization	Токен авторизации, полученный в Токен OAUTH. В начало заголовка необходимо добавить строку «Bearer» с пробелом.	Да
RqUID	Уникальный идентификатор сообщения, pattern=([0-9]|[a-f]|[A-F]){32})», переданный во входящем сообщении. Необходим для журналирования входящих вызовов и удобства разбора инцидентов.Чтобы обеспечить уникальность, можно использовать стандартные библиотеки и классы для генерации UUID/GUID(см. UUID), убрав из результата разделители «-».	Да

Объект executionLcDocumentStatus (Информация о статусе обработки документа для исполнения аккредитива)

Наименование	Обязательность	Тип	Описание
status	да	ENUM ( VALIDATION_ERROR, READY_TO_SIGN, PART_SIGNED, SENT_TO_BANK, IN_PROGRESS, REJECTED, DONE, REVOCATION, REVOKED, UNDEFINED)	Статус документа для исполнения VALIDATION_ERROR- Содержит ошибки READY_TO_SIGN- Создан PART_SIGNED - Частично подписан SENT_TO_BANK - Отправлен в Банк IN_PROGRESS - В работе REJECTED - Отклонен банком DONE - Исполнен REVOCATION - Запрошен отзыв REVOKED - Отозван UNDEFINED - Не определен
lastStatusChangeDate	да	Дата и время	Последняя дата и время изменения статуса
rejectReason	нет	Строка (1000)	Причина отказа. Передается только по документу на исполнение в статусе REJECTED (Отклонен банком)
paymentStatus	нет	ENUM ( PAID, NOT_PAID, UNDEFINED )	Статус платежа. Предоставляется только по документу на исполнение в статусе DONE (Исполнен) PAID - Оплачен NOT_PAID - Не оплачен UNDEFINED - Не определен

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

GET https://mc.api.sberbank.ru/prod/tradefin/lc-legal/v1/execution-lc-document/7842126162363942912/status
Authorization: Bearer afe68f25-9b1b-47ee-a512-bf236b985c94
Content-Type: application/json
RqUID: c6da1b21f459433da289f5684dba5b67

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

Обновлено 20 декабря 2023

HTTP/1.1 200 OK
Server: nginx/1.22.1
Date: Mon, 29 May 2023 05:29:19 GMT
Content-Type: application/json
Content-Length: 84
Connection: keep-alive
X-Gravitee-Transaction-Id: ef8bca37-ef8a-42a5-8bca-37ef8ad2a54c
X-Gravitee-Request-Id: ef8bca37-ef8a-42a5-8bca-37ef8ad2a54c
X-Rate-Limit-Limit: 20
X-Rate-Limit-Remaining: 19
X-Rate-Limit-Reset: 1685338160680
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
{
  "status": "DONE",
  "lastStatusChangeDate": "2022-04-13T10:57:23.321+03:00",
  "paymentStatus": "PAID"
}