Сервис получения параметров аккредитива
Обновлено 3 мая 2024
Сервис для получения детальной информации по аккредитиву. Данный сервис доступен только Партнерам банка, которые являются получателями или плательщиками по данному аккредитиву.
Для вызова сервиса потребуется получить токен доступа.
Получение токена доступа выполняется с помощью API Получение токена OAUTH. Перед тем, как использовать сервис API, необходимо отправить запрос на формирование токена авторизации.
После успешного формирования токена в ответном сообщении будет возвращен идентификатор токена, который необходимо указывать в заголовке Authorization в каждом запросе к API.
Токен нужно получать для каждого нового запроса к API. Срок жизни токена составляет 60 сек.
Scope | auth://tradefin/lc-legal/lc |
Endpoint | https://mc.api.sberbank.ru/prod/tradefin/lc-legal/v1/lc/{reference} |
Method | GET |
Request Body | - |
Request Parameters | path: reference, где reference - Референс аккредитива |
Response | HTTP 200 ОК |
HTTP 404 Аккредитив с \<референс аккредитива> не найден | |
HTTP 403 Проверка токена не пройдена | |
HTTP 500 Внутренняя ошибка сервиса. Обратитесь в поддержку или попробуйте повторить запрос позднее | |
Response Parameters | Объект lcLegal (Параметры аккредитива) |
Заголовки запроса
Наименование заголовка | Описание | Обязательность поля |
---|---|---|
authorization | Токен авторизации, полученный в Токен OAUTH. В начало заголовка необходимо добавить строку «Bearer» с пробелом. | Да |
RqUID | Уникальный идентификатор сообщения, pattern=([0-9]|[a-f]|[A-F]){32})», переданный во входящем сообщении. Необходим для журналирования входящих вызовов и удобства разбора инцидентов.Чтобы обеспечить уникальность, можно использовать стандартные библиотеки и классы для генерации UUID/GUID(см. UUID), убрав из результата разделители «-». | Да |
Тело ответа lcLegal
Наименование | Обязательность | Тип | Описание |
---|---|---|---|
reference | нет | Строка (50) | Референс сделки открытой по заявлению. Передается только по заявлениям в статусе Исполнено |
issueDate | нет | Дата | Дата открытия аккредитива |
expiryDate | да | Дата | Дата истечения аккредитива |
applicantName | да | Строка (500) | Наименование плательщика |
applicantInn | да | Строка (12) | ИНН плательщика |
beneficiaryName | да | Строка (500) | Наименование получателя |
beneficiaryInn | да | Строка (12) | ИНН получателя |
closeDate | нет | Дата | Дата закрытия аккредитива |
status | да | ENUM ( ACTIVE , CLOSED ) | Статус аккредитива ACTIVE - Действующий CLOSED - Закрыт |
amount | да | Число (19,2) | Сумма аккредитива |
currency | да | ENUM (RUB) | Валюта аккредитива |
availableAmount | да | Число (19,2) | Остаток по аккредитиву |
availableAmountC urrency | да | ENUM (RUB) | Валюта остатка по аккредитиву |
Пример запроса
GET https://mc.api.sberbank.ru/prod/tradefin/lc-legal/v1/lc/ROP220000053
Authorization: Bearer 9e783f18-6480-44fe-833b-f316db17ab5c
Content-Type: application/json
RqUID: c6da1b21f459433da289f5684dba5b67
Пример ответа
HTTP/1.1 200 OK
Server: nginx/1.22.1
Date: Mon, 29 May 2023 05:01:45 GMT
Content-Type: application/json
Content-Length: 470
Connection: keep-alive
X-Gravitee-Transaction-Id: 72e8e880-729b-4d43-a8e8-80729b0d43f4
X-Gravitee-Request-Id: 72e8e880-729b-4d43-a8e8-80729b0d43f4
X-Rate-Limit-Limit: 20
X-Rate-Limit-Remaining: 19
X-Rate-Limit-Reset: 1685336505571
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
{
"amount": "20000",
"currency": "RUB",
"status": "ACTIVE",
"reference": "ROP220000053",
"applicantInn": "5630020111",
"applicantName": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"Ромашка - Т\"",
"availableAmount": "2",
"availableAmountCurrency": "RUB",
"beneficiaryInn": "7716763111",
"beneficiaryName": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"Лютик",
"expiryDate": "2025-07-18",
"issueDate": "2022-11-01"
}