Запрос информации валютного контроля

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

Ресурс /v1/curr-control-info-reqs

Ресурс позволяет создать запрос информации валютного контроля.

Шаги:

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

2. Сформировать ЭП.

3. Получить статус.

4. Получить документ.

Для создания запроса необходимо отправить POST-запрос (/v1/curr-control-info-reqs), в котором передать авторизационный токен организации (Access Token) и запрос. Авторизационный токен передается в параметре Authorization заголовка запроса.

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

Модель запроса и ответа

Наименование Описание
Параметры заголовка
Authorization String
Access token собственной/дочерней организации, полученный через SSO.
Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1
Параметры запроса
CurrControlInfoReq {
authPersonName (string) ФИО сотрудника организации, ответственного за подготовку документа,
authPersonTelfax (string) Телефон сотрудника организации, ответственного за подготовку документа,
bankComment (string, optional, read only) Банковский комментарий к статусу документа,
bankStatus (string, optional, read only) Статус документа,
date (string) Дата составления документа,
declarationInfo (CurrControlDeclarationInfo, optional) Информация о поступивших в банк декларациях на товары,
externalId (string) Идентификатор документа в организации-партнере,
number (string, optional) Номер документа,
violationInfo (CurrControlViolationInfo, optional) Информация о зафиксированных банком нарушениях валютного законодательства
}
CurrControlDeclarationInfo {
dateSince (string) Дата начала периода,
dateUntil (string) Дата окончания периода,
info (string, optional) Информация о декларациях на товары
}
CurrControlViolationInfo {
dateSince (string) Дата начала периода,
dateUntil (string) Дата окончания периода,
info (Array[CurrControlViolationInfoItem], optional) Информация о зафиксированных банком нарушениях валютного законодательства
}
CurrControlViolationInfoItem {
amount (Amount, optional) Сумма зафиксированного нарушения валютного законодательства,
contractDate (string, optional) Дата договора,
contractNum (string, optional) Номер договора,
normativeLegalAct (string, optional) Нормативный правовой акт,
passportNum (string, optional) Номер паспорта сделки,
violatedRule (string, optional) Нарушенная норма,
violationDate (string, optional) Дата зафиксированного нарушения валютного законодательства
}
Amount {
amount (number, optional) Сумма,
currencyName (string, optional) Буквенный ISO-код валюты
}

Пример:

{
   "authPersonName":"Иванов Иван Иванович",
   "authPersonTelfax":"89269999999",
   "bankComment":"Документ в обработке",
   "bankStatus":"PROCESSING",
   "date":"2018-31",
   "declarationInfo":{
      "dateSince":"2018-12-31",
      "dateUntil":"2018-12-31",
      "info":"Информация о декларациях на товары"
   },
   "externalId":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
   "number":"23",
   "violationInfo":{
      "dateSince":"2018-12-31",
      "dateUntil":"2018-12-31",
      "info":[
         {
            "amount":{
               "amount":1.01,
               "currencyName":"USD"
            },
            "contractDate":"2018-12-31",
            "contractNum":"1",
            "normativeLegalAct":"Акт номер 2.2.14 пункт 3.7. Описание акта",
            "passportNum":"120123A0/1234/GU23/1/2",
            "violatedRule":"Норма 1.1. Описание нормы",
            "violationDate":"2018-12-31"
         }
      ]
   }
}

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

Ресурс /v1/curr-control-info-reqs/{externalId}/state

Ресурс позволяет получить статус ранее отправленного запроса информации валютного контроля.

Шаги:

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

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

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

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

Наименование Описание
Параметры заголовка
Authorization String
Access token, полученный через SSO.
Пример: Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1
Параметры запроса
externalId String Идентификатор документа, присвоенный клиентом

Пример:

curl -X GET --header 'Accept: application/json' --header
'Authorization: Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1'
'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/curr-control-info-reqs/
22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6/state'

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

Наименование Описание
DocState
bankComment (string, optional, read only) Банковский комментарий к статусу документа,
bankStatus (string, optional) Статус документа,
channelInfo (string, optional, read only) Комментарий, специфичный для документа, полученного по данному каналу,

Пример:

{
    "bankStatus": "DELIVERED",
    "bankComment": null,
    "channelInfo": null,
}

Возможные статусы

Код состояние документа Наименование статуса
Промежуточные статусы/Продолжать опрашивать
ACCEPTED Принят
ACCEPTED_BY_ABS Принят АБС
CREATED Создан
DELAYED Приостановлен
PROCESSING_RZK Согласование контролилующей организацией
Окончательные статусы/Прекратить опрос
CHECKERROR Ошибка контроля
DELETED Удален
REQUISITEERROR Ошибка реквизитов
REFUSEDBYABS Отказан АБС
REFUSEDBBANK Отвергнут Банком
RECALL Отозван
Окончательные(Успешные) статусы/Прекратить опрос
PROCESSED Обработан

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

Ресурс /v1/curr-control-info-reqs/{externalId}

Ресурс позволяет получить ранее отправленный запрос информации валютного контроля.

Шаги:

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

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

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

Модель запроса и ответа

Наименование Описание
Параметры заголовка
Authorization String
Access token, полученный через SSO.
Пример: Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1
Параметры запроса
externalId String
Идентификатор документа, присвоенный клиентом

Пример:

curl -X GET --header 'Accept: application/json' --header
'Authorization: Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1'
'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/curr-control-info-reqs/22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6'

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

Соответствует модели запроса и ответа /v1/curr-control-info-reqs.

Подписание запроса транспортной подписью (JWS).

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

Код возврата Описание кода возврата Причина возникновения
200 (GET-запрос) ОК
400 DESERIALIZATION_FAULT
Неверный формат запроса Неверный формат запроса
401 UNAUTHORIZED
accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х Указан некорректный или просроченный access_token.
403 ACTION_ACCESS_EXCEPTION
Операция не может быть выполнена: доступ к ресурсу запрещен У пользователя нет прав на использование соответствующего сервиса SberBusinessAPI, доступ к которому не предусмотрен настройками scope; У пользователя отсутствует оферта с внешним сервисом.
404 NOT_FOUND
Документ с указанным ID не найден Невозможно найти документ с указанным внешним идентификатором.
500 UNKNOWN_EXCEPTION
Внутренняя ошибка сервера
503 UNAVAILABLE_RESOURCE_EXCEPTION
Сервис временно недоступен Проводятся технические работы

Заметили ошибку?

Выделите текст и нажмите Ctrl + Enter, чтобы сообщить нам о ней