ym88659208ym87991671
Заявление на страхование экспортного контракта | Документация для разработчиков

Заявление на страхование экспортного контракта

Обновлено 19 сентября 2023
Сценарий заявление на страхование экспортного контракта

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

  • Текущий тестовый контур https://edupirfintech.sberbank.ru:9443

  • Новый тестовый контур https://iftfintech.testsbi.sberbank.ru:9443

  • Промышленный контур https://fintech.sberbank.ru:9443

Получение заявления

Ресурс /v1/export-contract-insure/{externalId} позволяет получить заявление на страхование экспортного контракта для того, чтобы получить реквизиты созданного Клиентом документа в СББОЛ.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

Для получения реквизитов по заявлению на страхование экспортного контракта необходимо отправить GET-запрос (/v1/export-contract-insure/{externalId}), в котором передать авторизационный токен к данным организации-клиента (Access Token) и идентификатор заявления. Авторизационный токен передается в параметре Authorization заголовка запроса.

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис EXPORT_CONTRACT_INSURE.

Модель запроса

НаименованиеОписание
Параметры заголовка
Authorization (String)Access token организации-клиента, полученный через SSO
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры запроса
externalId (String)Идентификатор документа заявления, полученный из СББОЛ
Пример: 550e8400-e29b-41d4-a716-446655440000

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

curl -X GET --header 'Accept: application/json' --header
'Authorization: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1'
' `https://edupirfintech.sberbank.ru:9443` /v1/export-contract-insure?
externalId=22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6'

Модель ответа

НаименованиеОписание
ExportContractInsure {
annualRevenue (number)Годовая выручка ,
bankComment (string, optional)Банковский комментарий к статусу заявления на страхование ,
bankStatus (string)Статус заявления на страхование ,
buyerAddress (string, optional)Покупатель. Адрес местонахождения ,
buyerCompanySite (string, optional)Покупатель. Сайт компании ,
buyerCooperationExperienceType (integer, optional)Покупатель. Наличие совместного опыта сотрудничества. 1 - Да, контракты действуют, 2 - Да, контракты исполнены, 3 - Нет. = ['1', '2', '3'],
buyerCountEmployeesType (integer, optional)Покупатель. Количество сотрудников в штате: 1 - Менее 10, 2 - От 10 (включительно) до 50, 3 - От 50 (включительно) = ['1', '2', '3'],
buyerCountry (string, optional)Покупатель. Страна регистрации ,
buyerIsLegalEntityMore2Y (boolean, optional)Покупатель. Является юридическим лицом, деятельность которого осуществляется более 2х лет с даты регистрации ,
buyerMainActivity (string, optional)Покупатель. Основной вид деятельности ,
buyerName (string, optional)Покупатель. Наименование ,
buyerRegNumber (string, optional)Покупатель. Регистрационный номер ,
contactEmail (string, optional)Экспортер. Контактная информация. Электронная почта ,
contactFullname (string, optional)Экспортер. Контактная информация. ФИО контактного лица ,
contactPhoneNumber (string, optional)Экспортер. Контактная информация. Номер телефона ,
contactPosition (string, optional)Экспортер. Контактная информация. Должность ,
contractDestinationCountry (string, optional)Страна назначения экспорта ,
contractEnsuringName (string, optional)Наименование обеспечения, если выбран тип Иное. ,
contractEnsuringType (integer, optional)Вид обеспечения (1 - Поручительство, 2 - Залог, 3 - Банковская гарантия, 4 - Аккредитив, 5 - Иное, 6 - Без обеспечения) = ['1', '2', '3', '4', '5', '6'],
contractExportSubject (string, optional)Предмет экспорта ,
contractIsEqualBuyerCountryPlace (boolean, optional)Страна назначения экспорта совпадает со страной местонахождения покупателя,
contractIsRussianGoods (boolean, optional)Предмет экспорта - российские товары (работы, услуги, в т.ч. Результаты интеллектуальной деятельности) ,
contractNotDefinedInkoterms (boolean, optional)Сделка. Базисные условия поставки еще не определены ,
contractNotProvidedInInkoterms (boolean, optional)Сделка. Инкотермс не предусмотрен в экспортном контракте ,
contractPeriodFrom (string, optional)Период отгрузок. Дата начала ,
contractPeriodTo (string, optional)Период отгрузок. Дата окончания ,
contracts (Array[Contract], optional)Контракты ,
deferredPayL90D (boolean, optional)Отсрочка платежа по указанным экспортным контрактам менее (либо равна) 90 календарных дней ,
digestSignatures (Array[Signature], optional)Электронные подписи по дайджесту документа ,
docDate (string)Дата документа ,
exportTypes (Array[ExportType], optional)Виды экспорта ,
exporterAccount (string, optional)Экспортер. Расчетный счет ,
exporterChDelayCountType (integer, optional)Экспортер. Кредитная история. Просрочки.
1 - Не имеется, 2 - Менее 5 календарных дней, 3 - От 5 (включительно) до 10 календарных дней, 4 - От 11 календарных дней = ['1', '2', '3', '4'],
exporterCompanySite (string, optional)Экспортер. Сайт компании ,
exporterExecutiveBirthdate (string, optional)Экспортер. Дата рождения ЕИО ,
exporterExecutiveBirthplace (string, optional)Экспортер. Место рождения ЕИО ,
exporterExecutiveFullname (string, optional)Экспортер. ФИО ЕИО ,
exporterExecutiveStartDate (string, optional)Экспортер. Дата вступления в должность ЕИО ,
exporterFullname (string, optional)Экспортер. Полное наименование ,
exporterHasExpExperienceType (integer, optional)Экспортер. Наличие опыта экспорта у компании. 0 - Не имеется, 1 - Имеется = ['0', '1'],
exporterInn (string, optional)Экспортер. ИНН ,
exporterIsBeneficarOwnerFp (boolean, optional)Экспортер. Бенефициарный владелец является ФЛ ,
exporterMainActivity (string, optional)Экспортер. Основной вид деятельности ,
exporterMainActivityClient (string, optional)Экспортер. Основной вид деятельности, заполненный клиентом ,
exporterOgrn (string, optional)Экспортер. ОГРН ,
exporterRegDate (string, optional)Экспортер. Дата регистрации юридического лица ,
externalId (string)Идентификатор документа, присвоенный партнером ,
hasBuyerDebtToTheInsure (boolean, optional)На дату заявления на страхование у покупателя отсутствует задолженность перед страхователем ,
inkotermsConditions (Array[InkotermsCondition], optional)Условия Инкотермс ,
insuranceCost (number)Страховая стоимость ,
insuranceCoverage (number)Сумма страхового покрытия ,
offerConsent (boolean, optional)Согласие с условиями оферты ,
owners (Array[Owner], optional)Бенефициарные владельцы
}
Contract {
bankName (string, optional)Наименование банка ,
contractDate (string, optional)Дата контракта ,
contractNumber (string)Номер контракта
}
Signature {
base64Encoded (string)Значение электронной подписи, закодированное в Base64 ,
certificateUuid (string)Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)
}
ExportType {
isExportRusGoodsNoReimport (boolean, optional),
isGrantIntellectualActivity (boolean)Предоставление иностранному юридическому лицу прав использования российских результатов интеллектуальной деятельности ,
isImplRusOutServices (boolean)Осуществление российских работ (услуг) для иностранных юридических лиц за пределами РФ ,
isImplRusOutServicesToResult (boolean)Осуществление российских работ (услуг) для использования результата выполнения работ или оказания услуг за пределами РФ
}
InkotermsCondition {
code (string)Код условия Инкотермс
}
Owner {
age (integer)Возраст бенефициарного владельца
}

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

{
"annualRevenue":1.01,
"bankComment":"Текст комментария",
"bankStatus":"REFUSED",
"buyerAddress":"Baker Street, London",
"buyerCompanySite":"https://example.com",
"buyerCooperationExperienceType":1,
"buyerCountEmployeesType":1,
"buyerCountry":"Англия",
"buyerIsLegalEntityMore2Y":true,
"buyerMainActivity":"Производство мебели",
"buyerName":"Example LTD",
"buyerRegNumber":"12348765",
"contactEmail":"address@email.ru",
"contactFullname":"Иванов Иван Иванович",
"contactPhoneNumber":"7916*****88",
"contactPosition":"Менеджер",
"contractDestinationCountry":"Австралия",
"contractEnsuringName":"Обеспечение",
"contractEnsuringType":2,
"contractExportSubject":"Мебельные изделия",
"contractIsEqualBuyerCountryPlace":true,
"contractIsRussianGoods":true,
"contractNotDefinedInkoterms":true,
"contractNotProvidedInInkoterms":true,
"contractPeriodFrom":"2018-12-31",
"contractPeriodTo":"2018-12-31",
"contracts":[
{
"bankName":"ПАО СБЕРБАНК",
"contractDate":"2018-12-31",
"contractNumber":"8981272"
}
],
"deferredPayL90D":true,
"digestSignatures":[
{
"base64Encoded":"HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"docDate":"2018-12-31",
"exportTypes":[
{
"isExportRusGoodsNoReimport":true,
"isGrantIntellectualActivity":true,
"isImplRusOutServices":false,
"isImplRusOutServicesToResult":false
}
],
"exporterAccount":"40802840600000200000",
"exporterChDelayCountType":3,
"exporterCompanySite":"https://example.com",
"exporterExecutiveBirthdate":"2018-12-31",
"exporterExecutiveBirthplace":"Сейшеллы 1003/2",
"exporterExecutiveFullname":"Иванов Иван Иванович",
"exporterExecutiveStartDate":"2018-12-31",
"exporterFullname":"ООО \"Организация\"",
"exporterHasExpExperienceType":1,
"exporterInn":"7707083893",
"exporterIsBeneficarOwnerFp":true,
"exporterMainActivity":"Производство мебели",
"exporterMainActivityClient":"Деятельность в области связи на базе проводных технологий",
"exporterOgrn":"380123456789012",
"exporterRegDate":"2018-12-31",
"externalId":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"hasBuyerDebtToTheInsure":true,
"inkotermsConditions":[
{
"code":"EXW"
}
],
"insuranceCost":1.01,
"insuranceCoverage":1.01,
"offerConsent":true,
"owners":[
{
"age":40
}
]
}

Смена статуса заявления

Ресурс /v1/export-contract-insure/{externalId}/change-state позволяет сменить статус заявления на страхование экспортного контракта для того, чтобы передать решение о согласовании или отклонении заявления, полученное от клиента.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

Для смены статуса заявления экспортного контракта необходимо отправить POST-запрос (/v1/export-contract-insure/{externalId}/change-state), в котором передать авторизационный токен к данным организации-клиента (Access Token), идентификатор заявления и запрос на смену статуса. Авторизационный токен передается в параметре Authorization заголовка запроса.

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис EXPORT_CONTRACT_INSURE.

Модель запроса

НаименованиеОписание
Параметры заголовка
Authorization (String)Access token организации-клиента, полученный через SSO
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры запроса
externalId (String)Идентификатор документа заявления, полученный из СББОЛ
Пример: 550e8400-e29b-41d4-a716-446655440000
Параметры тела запроса
ExportContractInsureState {
fileId (string, optional)Идентификатор файла, который необходимо прилинковать к заявлению на страхование ,
statusComment (string, optional)Текстовый комментарий к статусу/Причина отказа ,
statusName (string)Наименование статуса = [RECEIVED_EKSAR, REFUSED, WAITING_FOR_PAY, POLICE_ACTIVATED]
}

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

{
“statusName”: RECEIVED_EKSAR
“statusComment”: некорректные условия сделки на экспорт
“fileId”: 00000000000000000000000000000000000000
}

Модель ответа

НаименованиеОписание
DocStateShort {
bankComment (string, optional, read only)Банковский комментарий к статусу документа ,
bankStatus (string, optional)Статус документа

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

{
"bankComment": "string",
"bankStatus": "string"
}

Наименование статуса

СтатусСобытиеПояснение
RECEIVED_EKSARПартнер успешно получил данные заяви по GET сервису
REFUSEDПартнер принял отрицательное решение по заявке (отказ)Статус REFUSED является конечным, он не может смениться на какой-либо другой
WAITING_FOR_PAYПартнер принял положительное решение по заявке (полис сформирован, ожидается оплата)Когда для заявления на страхование приходит статус WAITING_FOR_PAY, то поле fileId должно быть обязательно заполнено. В противном случае поле fileId должно оставаться пустым
POLICE_ACTIVATEDПартнер получил денежные средства, полис вступил в силуСтатус POLICE_ACTIVATED является конечным, он не может смениться на какой-либо другой

Коды возврата

Код возвратаОписание кода возвратаПричина возникновения
200 (GET-запроса)OK
201 (POST-запрос)CREATED
Создан
400DESERIALIZATION_FAULT
Неверный формат запросаНеверный формат запроса
VALIDATION_FAULT
Ошибка валидацииОшибка валидации данных запроса с указанием некорректных значений. Значения полей модели или параметров запроса не соответствуют допустимым и определенным в модели.
401UNAUTHORIZED
accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан некорректный или просроченный access_token.
403ACTION_ACCESS_EXCEPTION
Операция не может быть выполнена: доступ к ресурсу запрещенУ пользователя нет прав на использование соответствующего сервиса SberBusinessAPI, доступ к которому не предусмотрен настройками scope; У пользователя отсутствует оферта с внешним сервисом.
404NOT_FOUND
Документ с указанным ID не найденНевозможно найти документ с указанным внешним идентификатором.
415JWS_EXCEPTED
В соответствии с текущими настройками сервиса с clientId=%s необходимо использовать запрос в формате JWS Compact SerializationОшибка возникает, если в настройках внешних сервисов выставлен флаг «Требуется подпись для внешнего сервиса»
500UNKNOWN_EXCEPTION
Внутренняя ошибка сервера
503UNAVAILABLE_RESOURCE_EXCEPTION
Сервис временно недоступенПроводятся технические работы
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.