Информация по офертам клиента

Обновлено 29 февраля 2024

Ресурс /v1/partner-info/offers позволяет Партнеру получить информацию по офертам клиента, которые были заключены пользователями этого клиента.

Шаги

1. При авторизации пользователя партнера передать в scope сервис GET_ADVANCE_ACCEPTANCES.

2. Отправить GET-запрос (/v1/partner-info/offers), в котором необходимо передать авторизационный токен к данным клиента (Access Token), хэш от идентификатора организации клиента (client), и статус запрашиваемых оферт (status). Авторизационный токен передается в параметре Authorization заголовка запроса. Хэш от идентификатора организации клиента можно узнать из запроса Получение информации о клиенте (т.е. из запроса user-info (значение атрибута HashOrgId в ответе на запрос user-info) по данному клиенту). Информацию необходимо хранить на своей стороне для последующего использования.

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

Наименование	Описание
Параметры заголовка
Authorization (String)	Access token организации-клиента, полученный через SSO Пример: Bearer c5e7110b-394a-45eb-9a4b-d8759cf6f9eb-1
Параметры запроса
client (String)	Хэш от идентификатора организации. Значение атрибута HashOrgId в ответе на запрос user-info
status (String)	Статус оферт
clientId (String)	Идентификатор сервиса

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

curl -X GET --header 'Accept: application/json' --header
'Authorization: Bearer c5e7110b-394a-45eb-9a4b-d8759cf6f9eb-1'
'https://iftfintech.testsbi.sberbank.ru:9443/fintech/api/v1/partner-info/offers?client=66e018dc56ac32363f3afdc92e86c092943bba97c16986327ab2f4f6b6ce1435'

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

Наименование	Описание
PartnerOfferInfo {
clientId (string, optional)	Идентификатор сервиса,
inn (string, optional)	ИНН организации,
orgName (string, optional)	Название организации,
users (Array[UserOffers], optional)	Список пользователей с офертами
}UserOffers {
accountList (Array[string], optional)	Список счетов,
sinceDate (string, optional)	Дата начала действия оферты,
status (string, optional)	Статус оферты,
sub (string, optional)	Хэш идентификатора пользователя,
untilDate (string, optional)	Дата завершения действия оферты,
userName (string, optional)	Наименование пользователя
}

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

{
   "clientId":"1005",
   "inn":"7707083893",
   "orgName":"OrgName",
   "users":[
      {
         "accountList":[
            "string"
         ],
         "sinceDate":"2018-12-31",
         "status":"PUBLIC",
         "sub":"026f8e459c8f89ef75fa7a78265a0025",
         "untilDate":"2018-12-31",
         "userName":"Name"
      }
   ]
}

Таблица допустимых значений параметра status

Значение параметра	Описание
public	Возвращает данные по клиентам, с активными офертами
private	Возвращает данные по клиентам, с неактивными офертами, которые отозвал клиент
revoke	Возвращает данные по клиентам, с неактивными офертами, которые отозвал Банк

Если параметр status не указан в запросе, то предполагается что запрос выполняется по всем допустимым значениям параметра status.