Информация по тарифам сервисов

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

Ресурс /v1/client-tariffs позволяет Партнеру передать в банк информацию по тарифу за использование сервиса/услуги клиентом.

Шаги

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

2. Отправить PUT-запрос (/v1/client-tariffs), в заголовке передать авторизационный токен к данным клиента (Access Token) и информацию по тарифу в теле запроса. авторизационный токен передается в параметре Authorization заголовка запроса.

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

Наименование	Описание
Параметры заголовка
Authorization (String)	Access token организации-клиента, полученный через SSO Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1

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

curl -X GET --header 'Accept: application/json' --header
'Authorization:  Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1'
'https://iftfintech.testsbi.sberbank.ru:9443/fintech/api/v1/client-tariffs'

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

Наименование	Описание
ClientTariff {
activationDate (string, optional)	Дата активации тарифа ,
code (string)	Код тарифа ,
description (string, optional)	Описание тарифа ,
expireDate (string, optional)	Дата окончания тарифа ,
expireTrialModeDate (string, optional)	Дата завершения триального периода ,
name (string)	Наименование тарифа ,
plannedPaymentDate (string, optional)	Плановая дата списания денежных средств за сервис ,
rateAmount (number)	Стоимость ,
ratePeriodMonths (integer)	Периодичность оплаты в месяцах ,
tokenUrl (string, optional)	Ссылка на страницу управления тарифом для токен клиентов ,
trialMode (boolean, optional),
url (string, optional)	Ссылка на страницу управления тарифом,
useAdditionalTariff (boolean, optional)	Использовать несколько тарифов
}

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

{
   "activationDate":"2018-12-31",
   "code":"N",
   "description":"Описание тарифа N",
   "expireDate":"2018-12-31",
   "expireTrialModeDate":"2018-12-31",
   "name":"Тариф N",
   "plannedPaymentDate":"2018-12-31",
   "rateAmount":1.01,
   "ratePeriodMonths":12,
   "tokenUrl":"https://www.partner.ru/tariffs",
   "trialMode":true,
   "url":"https://www.partner.ru/tariffs",
   "useAdditionalTariff":true
}

Если billing выполняется по каждому пользователю, то в поле rateAmount необходимо указывать общую сумму списания в рамках организации.