Зарплатный проект

Обновлено 30 августа 2024

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

Зарплатный проект - это услуга, которая позволяет компаниям выплачивать заработную плату своим сотрудникам через банковские карты. СберБанк предоставляет полный спектр услуг по выпуску и обслуживанию зарплатных карт, а также осуществляет переводы денежных средств на карты сотрудников.

Подробнее о продукте на сайте.

С помощью API вы сможете легко интегрировать Зарплатный проект СберБанка в свою систему управления персоналом и автоматизировать процесс выплаты заработной платы. Это значительно упрощает работу HR-отдела компании и повышает эффективность процесса выплаты зарплаты.

Схема работы продукта

• Графическое описание
• Текстовое описание

№	Что делаем	Подробности
1	Авторизуйте Пользователя с помощью СберБизнес ID	Подробно о подключении и работе сервиса СберБизнес ID рассказали в соответствующем разделе документации.
2	Получите информацию по зарплатному договору	С помощью ресурса /fintech/api/v1/salary-agreements и access_token пользователя получите информацию по зарплатному договору с Банком. Эта информация потребуется вам на следующем шаге при создании зарплатной ведомости для осуществления выплат.
3	Проведите выплату в рамках зарплатного проекта	С помощью ресурса /fintech/api/v1/payrolls и access_token пользователя создайте зарплатную ведомость. Чтобы Банк мог начать обрабатывать платежный документ сразу, он должен быть подписан электронной подписью уполномоченного сотрудника, имеющего право подписи от лица компании. Подробно о работе с электронной подписью рассказали в соответствующем разделе документации. Важно: Владелец access_token пользователя вашей компании должен совпадать с владельцем ЭП, которую будете использовать для подписания ведомости.
4	Проверьте статус и корректность оплаты	С помощью ресурса /fintech/api/v1/payrolls/{externalId}/state, access_token пользователя и идентификатора зарплатной ведомости (externalId) запросите статус зарплатной ведомости. При необходимости вы можете получить полные данные ранее отправленной зарплатной ведомости - вам потребуется ресурс /fintech/api/v1/payrolls/{externalId}

Авторизация

Все запросы в Sber API выполняются от имени конкретного пользователя СберБизнес, в том числе при интеграции для работы с информацией только по собственной компании. Запросы в Sber API в заголовке (Header) содержат параметр - Authorization. В нем требуется передавать токен доступа (access_token) пользователя. Получение токена доступа осуществляется с помощью сервиса СберБизнес ID. Подробно о подключении и работе сервиса авторизации рассказали в соответствующем разделе документации.

При интеграции по собственной компании потребуется выбрать одного пользователя СберБизнес и пройти им авторизацию через СберБизнес ID единоразово. В дальнейшем вам потребуется своевременно обновлять токен доступа при помощи токена обновления - обновить токен доступа.

Варианты реализации

Ниже будут приведены примеры реализации. Сценарии могут быть для вас отправной точкой и идеей для финального способа реализации функциональности.

Сценарии описали общие, для более легкого восприятия информации описания работы с продуктом Зарплатный проект в Sber API.

Можно использовать разные триггеры запуска того или иного сценария - действия пользователя, регламентный запуск по времени, наступление определенных событий и другие варианты.

Выплата со счета в Сбере

В схеме можно использовать автоматизированное подписание документа. Данная возможность доступна только при использовании ЭЦП сотрудника вашей компании.

Подробнее об использовании ЭЦП в Sber API можно почитать в одноименном разделе.

Шаги

1. Получить информацию по зарплатному договору
2. Провести выплату в рамках зарплатного проекта

Участники usecase

• Пользователь - сотрудник вашей компании либо представитель ЮЛ/ИП, от лица которого он работает в рамках вашего сервиса (Платформа)
• Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
• Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа

Предусловия

• Пользователь имеет пользовательский профиль в СберБизнес своей компании
• Пользователь находится в пространстве Платформы
• Пользователь прошел авторизацию с помощью СберБизнес ID

Постусловия

• Создан и подписан платежный документ

Используемые запросы

№	Метод	Точка вызова	Описание	Операция в scope	Шаг в схеме
1		/fintech/api/v1/client-info	Получение расширенной информации	GET_CLIENT_ACCOUNTS	1. Получить информацию по зарплатному договору
2		/fintech/api/v1/salary-agreements	Получение информации по договору	SALARY_AGREEMENT	1. Получить информацию по зарплатному договору
3		/ic/sso/api/v2/oauth/token	Обновление токена доступа	openid	1. Получить информацию по зарплатному договору
4		/fintech/api/v1/payrolls	Создание зарплатной ведомости	PAYROLL	2. Провести выплату в рамках зарплатного проекта

Выплата со счета в другом банке

В схеме можно использовать автоматизированное подписание документа. Данная возможность доступна только при использовании ЭЦП сотрудника вашей компании.

Подробнее об использовании ЭЦП в Sber API можно почитать в одноименном разделе.

Шаги

1. Получить информацию по зарплатному договору
2. Провести выплату в рамках зарплатного проекта

Участники usecase

• Пользователь - сотрудник вашей компании либо представитель ЮЛ/ИП, от лица которого он работает в рамках вашего сервиса (Платформа)
• Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
• Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
• Сторонний банк - любой другой банк, где у компании Пользователя есть расчетный счет

Предусловия

• Пользователь имеет пользовательский профиль в СберБизнес своей компании;
• Пользователь находится в пространстве Платформы;
• Пользователь прошел авторизацию с помощью СберБизнес ID.

Постусловия

• Создан и подписан платежный документ

Используемые запросы

№	Метод	Точка вызова	Описание	Операция в scope	Шаг в схеме
1		/fintech/api/v1/client-info	Получение расширенной информации	GET_CLIENT_ACCOUNTS	1. Получить информацию по зарплатному договору
2		/fintech/api/v1/salary-agreements	Получение информации по договору	SALARY_AGREEMENT	1. Получить информацию по зарплатному договору
3		/ic/sso/api/v2/oauth/token	Обновление токена доступа	openid	1. Получить информацию по зарплатному договору
4		/fintech/api/v1/payrolls	Создание зарплатной ведомости	PAYROLL	2. Провести выплату в рамках зарплатного проекта

Проверка статуса и корректности выплаты

Шаги

1. Проверить статус выплаты
2. Проверить корректность

Участники usecase

• Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
• Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа

Предусловия

• Успешно выполнен сценарий "Выплата со счета в СберБанке" или "Выплата со счета в другом банке"

Постусловия

• Осуществлена выплата в рамках зарплатного проекта
• Проведена проверка корректности выплаты

Используемые запросы

№	Метод	Точка вызова	Описание	Операция в scope	Шаг в схеме
1		/fintech/api/v1/payrolls/{externalId}/state	Получение статуса зарплатной ведомости	PAYROLL	1. Получить статус выплаты
2		/fintech/api/v1/payrolls/{externalId}	Получение полных данных по зарплатной ведомости	PAYROLL	2. Проверить корректность
3		/ic/sso/api/v2/oauth/token	Обновление токена доступа	openid	1. Получить статус выплаты

Получение информации по договору

/fintech/api/v1/salary-agreements

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

Для получения информации по зарплатным договорам необходимо отправить GET-запрос /fintech/api/v1/salary-agreements с токеном доступа (access_token) пользователя в параметре Authorization заголовка.

В параметре scope ссылки авторизации пользователя должен быть указан сервис SALARY_AGREEMENT для получения доступа к этому ресурсу.

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

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

Request

/fintech/api/v1/salary-agreements

• Модель
• Пример

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^[a-zA-Z0-9]{38}$	required	Access token пользователя, полученный через SSO.
Accept	string	string	^(application/json|application/jose)	optional	Указывает на формат данных, который вы готовы принять от Банка. Если ответ не требуется в зашифрованном виде, то может быть не указан или передан со значением application/json. Если необходимо получить ответ на запрос токена в зашифрованном виде, то необходимо передать параметр со значением application/jose.

GET /fintech/api/v1/salary-agreements HTTP/1.1
Authorization: Bearer 4d4b8484Dc385y41a91978180ed433ec9dfcka
Accept: */*

Responses

200 (OK)

• Модель
• Пример

Параметр	Тип	Обязательность	Описание
Inline Model [
SalaryAgreements	array[SalaryAgreements]	optional	Зарплатный договор
]
SalaryAgreements {
admissionValueTypes	array[SalaryAgreementAdmissionValueType]	optional	Виды зачислений,
branchBic	string	optional	БИК подразделения,
branchName	string	optional	Наименование подразделения,
cardTypes	array[SalaryAgreementCardType]	optional	Типы пластиковых карт,
commissionInfo	SalaryAgreementCommissionInfo	optional	Информация о комиссии за зачисление,
contractEndDate	string	optional	Дата окончания действия договора,
contractNumber	string	optional	Номер договора,
contractStartDate	string	optional	Дата начала действия договора,
isReserve	boolean	optional	Признак резервирования,
orgTaxNumber	string	optional	ИНН организации пользователя,
osb	string	optional	Номер отделения сберегательного банка,
placesOfService	array[SalaryAgreementPlaceOfService]	optional	Места обслуживания,
tb	string	optional	Номер территориального банка
}
SalaryAgreementAdmissionValueType {
admissionCode	string	optional	Код зачисления,
admissionName	string	optional	Наименование зачисления,
admissionType	string	optional	Тип зачисления
}
SalaryAgreementCardType {
bonusProgramCode	string	optional	Код бонусной программы
depositSubtypeCode	string	optional	Код подвида вклада
depositTypeCode	string	optional	Код вида вклада
endDate	string	optional	Дата закрытия возможности выпуска карт
peopleGroupCode	string	optional	Код категории населения
peopleGroupName	string	optional	Название категории населения
typeCode	string	optional	Код вида карты
typeName	string	optional	Вид карты
}
SalaryAgreementCommissionInfo {
actualDateTime	string	optional	Дата и время последнего обновления информации банком о неоплаченной комиссии,
currentRate	number	optional	Текущая ставка тарифа за реестровые зачисления (%),
diffTariffs	array[SalaryAgreementDiffTariff]	optional	Дифференцированные тарифы для зарплатных реестров,
invoiceDate	string	optional	Дата выставления счета и направления детализации,
otherRate	number	optional	Фиксированная ставка по прочим зачислениям (%),
periodInfo	SalaryAgreementPeriodInfo	optional	Информация за расчетный период,
salaryRate	number	optional	Фиксированная ставка комиссии по зарплатным зачислениям (%)
}
SalaryAgreementPlaceOfService {
osb	string	optional	Номер отделения сберегательного банка,
placeAddress	string	optional	Адрес подразделения,
placeCode	string	optional	Код подразделения,
placeName	string	optional	Наименование подразделения,
tb	string	optional	Номер территориального банка,
vsp	string	optional	Номер внутреннего структурного подразделения
}
SalaryAgreementDiffTariff {
admissionTypeCode	string	required	Тип зачисления = ['Other', 'Salary'] stringEnum:"Other", "Salary",
endAmount	number	required	Конечная сумма диапазона выплат,
fromAmount	number	required	Начальная сумма диапазона выплат,
tariffRate	number	required	Тарифная ставка (%)
}
SalaryAgreementPeriodInfo {
commissionAmount	number	required	Сумма начисленной комиссии за расчетный период,
endDate	string	required	Дата окончания расчетного периода,
payAmount	number	required	Сумма выплат за расчетный период,
startDate	string	required	Дата начала расчетного периода
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

[
   {
      "admissionValueTypes":[
         {
            "admissionCode":"01",
            "admissionName":"Заработная плата",
            "admissionType":"Зарплатный"
         }
      ],
      "branchBic":"044525225",
      "branchName":"ПАО СБЕРБАНК",
      "cardTypes":[
         {
            "bonusProgramCode":"11",
            "depositSubtypeCode":"11",
            "depositTypeCode":"11",
            "endDate":"2018-12-31",
            "peopleGroupCode":"111",
            "peopleGroupName":"Зарплатная",
            "typeCode":"11",
            "typeName":"Visa Classic"
         }
      ],
      "commissionInfo":{
         "actualDateTime":"2018-12-31T23:59:59",
         "currentRate":1.01,
         "diffTariffs":[
            {
               "admissionTypeCode":"Other",
               "endAmount":1.01,
               "fromAmount":1.01,
               "tariffRate":1.01
            }
         ],
         "invoiceDate":"2018-12-31",
         "otherRate":1.01,
         "periodInfo":{
            "commissionAmount":1.01,
            "endDate":"2018-12-31",
            "payAmount":1.01,
            "startDate":"2018-12-31"
         },
         "salaryRate":1.01,
         "totalDebitAmount":1.01
      },
      "contractEndDate":"2018-12-31",
      "contractNumber":"10000001",
      "contractStartDate":"2018-12-31",
      "isReserve":false,
      "orgTaxNumber":"7707083893",
      "osb":"1111",
      "placesOfService":[
         {
            "osb":"1111",
            "placeAddress":"г.Москва, Кутузовский проспект, 34",
            "placeCode":"1111111111",
            "placeName":"Доп офис 1111",
            "tb":"11",
            "vsp":"1111"
         }
      ],
      "tb":"11"
   }
] 

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
	Некорректное значение Access Token	Указан некорректный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "UNAUTHORIZED",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "accessToken not found by value = 3513f959dbbd57490aa9f9ff67fb7380fae5m3"
}

403 (Forbidden)

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция SALARY_AGREEMENT. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "ACTION_ACCESS_EXCEPTION",
    "referenceId": "7535c2bb-7706-4b16-9882-d68aedbf2fef",
    "message": "Операция не может быть выполнена: доступ к ресурсу запрещен"
}

429 (Too Many Requests)

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 429 Too Many Requests
Content-Type: application/json;charset=UTF-8

{
  "cause": " TOO_MANY_REQUESTS ",
  "referenceId": "5650c1e4-5039-4038-8cad-afab64003f61",
  "message": " Превышен лимит запросов. Повторите операцию позже"
}

500 (Internal Server Error)

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNKNOWN_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
  "message": "Внутренняя ошибка сервера"
}

503 (Service Temporarily Unavailable)

Cause	Message	Description
UNAVAILABLE_RESOURCE_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNAVAILABLE_RESOURCE_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a67d",
  "message": "Внутренняя ошибка сервера"
}

Создание зарплатной ведомости

/fintech/api/v1/payrolls

Запрос позволяет создать зарплатную ведомость для осуществления выплаты в рамках зарплатного проекта.

Для создания зарплатной ведомости необходимо отправить POST-запрос /fintech/api/v1/payrolls с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами зарплатной ведомости в теле запроса.

В параметре scope ссылки авторизации пользователя должен быть указан сервис PAYROLL для получения доступа к этому ресурсу.

Если в запросе на создание платежного документа передать ЭП к документу (объект digestSignatures), то Банк сразу начнет его обработку.

Если в запросе не передавать ЭП к документу, то документ будет создан в статусе черновик. Для начала его обработки Банком потребуется зайти в интерфейс СберБизнес и подписать его.

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

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

Request

/fintech/api/v1/payrolls

• Модель
• Пример

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^[a-zA-Z0-9]{38}$	required	Access token пользователя, полученный через SSO.
Accept	string	string	^(application/json|application/jose)	optional	Указывает на формат данных, который вы готовы принять от Банка. Если ответ не требуется в зашифрованном виде, то может быть не указан или передан со значением application/json. Если необходимо получить ответ на запрос токена в зашифрованном виде, то необходимо передать параметр со значением application/jose.
BODY
Payroll {
account	string	string	^[0-9]{20}$	required/optional	Номер счета для выплаты денежных средств в рамках зарплатной ведомости. - Если выплата осуществляется по договору с резервированием (атрибут isReserve имеет значение true в запросе /fintech/api/v1/salary-agreements), то это поле обязательно необходимо заполнить. - Если выплата осуществляется по договору без резервирования (атрибут isReserve имеет значение false в запросе /fintech/api/v1/salary-agreements) и со счета в СберБанке, то это поле обязательно необходимо заполнить. - Если выплата осуществляется по договору без резервирования (атрибут isReserve имеет значение false в запросе /fintech/api/v1/salary-agreements) и со счета в другом банке, то заполнять это поле не требуется. Потребуется заполнить массив объектов payDocs.
admissionValue	string	string	^[0-9]{1,2}$	required	Вид зачисления. Указывается один вид зачисления на всю зарплатную ведомость. Если, к примеру, требуется осуществить выплату заработной платы для сотрудников компании и выплату в пользу самозанятых, вам потребуется создать 2 разных платежных документа. Доступный перечень видов зачисления по вашему договору содержится в ответе запроса /fintech/api/v1/salary-agreements в атрибуте admissionCode,
amount	AmountCurrency	object		required	Итоговая сумма зачисления,
authPersonName	string	string	^[a-zA-Z0-9. _ -]{1,60}$	optional	ФИО уполномоченного сотрудника организации пользователя,
authPersonTelfax	string	string	^[a-zA-Z0-9. _ -]{1,40}$	optional	Номер телефона, факса уполномоченного сотрудника организации пользователя,
bic	string	string	^[0-9]{9}$	required	БИК банка пользователя,
contractDate	string	ISO 8601 YYYY-MM-DD	^[0-9]{4}-[0-9]{2}-[0-9]{2}$	required	Дата договора. Необходимо использовать значение атрибута contractStartDate, полученное из запроса /fintech/api/v1/salary-agreements,
contractNumber	string	string	^[a-zA-Z0-9. _ -]{1,255}$	required	Номер договора. Необходимо использовать значение атрибута contractNumber, полученное из запроса /fintech/api/v1/salary-agreements,
date	string	ISO 8601 YYYY-MM-DD	^[0-9]{4}-[0-9]{2}-[0-9]{2}$	required	Дата составления документа,
digestSignatures	array[Signature]	array		optional	Электронные подписи по дайджесту документа. - Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. - Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе СберБизнес. О подписании дайджеста платежного документа подробно рассказали в соответствующем разделе документации.
employeeSalaries	array[PayrollEmpSalary]	array		optional	Данные сотрудников для зачисления выплаты
employeesNumber	integer	integer	^[0-9]$	required	Количество сотрудников,
externalId	string	UUID	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$	required	Идентификатор документа, который вы присваиваете самостоятельно,
incomeTypeCode	string	string	^(1|2|3|4|5)$	optional	Код вида дохода получателей выплаты по 229-ФЗ. Коды: 1 - Заработная плата и иные доходы, в отношении которых ст. 99 229-ФЗ установлены ограничения размеров удержания. 2 - Периодические доходы, на которые в соответствии с ч. 1 ст. 101 229-ФЗ не может быть обращено взыскание, за исключением доходов, указанных в ч. 2 ст. 101 229-ФЗ. 3 - Периодические доходы, к которым согласно ч. 2 ст. 101 229-ФЗ ограничения по взысканию не применяются. 4 - Единовременный доход, на который в соответствии с ч. 1 ст. 101 229-ФЗ не может быть обращено взыскание, за исключением доходов, указанных в ч. 2 ст. 101 229-ФЗ. 5 - Единовременный доход, к которому согласно ч. 2 ст. 101 229-ФЗ ограничения по взысканию не применяются. null - Код дохода указывать не нужно, если денежные средства не относятся к доходам с установленными ограничениями согласно ст. 99 и запретом согласно ст. 101 229-ФЗ,
loanAmount	AmountCurrency	object		optional	Сумма оплаты за счет кредитных средств. При заполнении данного атрибута обязательно требуется заполнить атрибуты loanDate и loanNumber,
loanDate	string	ISO 8601 YYYY-MM-DD	^[0-9]{4}-[0-9]{2}-[0-9]{2}$	optional	Дата кредитного договора. При заполнении данного атрибута обязательно требуется заполнить атрибуты loanAmount и loanNumber,
loanNumber	string	string	^[a-zA-Z0-9. _ -]{1,50}$	optional	Номер кредитного договора. При заполнении данного атрибута обязательно требуется заполнить атрибуты loanDate и loanAmount,
month	string	string	^[0-9]{1,2}$	required	Месяц отчетного периода,
number	string	string	^[a-zA-Z0-9. _ -]{1,50}$	optional	Номер документа,
orgName	string	string	^[a-zA-Z0-9. _ -]{1,160}$	required	Наименование организации пользователя,
orgTaxNumber	string	string	^([0-9]{10}|[0-9]{12})$	required	ИНН организации пользователя
payDocs	array[PayrollPayDoc]	array		required/optional	Данные платежных поручений по вашим счетам из других банков. - Если выплата осуществляется по договору с резервированием (атрибут isReserve имеет значение true в запросе /fintech/api/v1/salary-agreements), то заполнять объект не требуется. - Если выплата осуществляется по договору без резервирования (атрибут isReserve имеет значение false в запросе /fintech/api/v1/salary-agreements) и со счета в СберБанке, то заполнять объект не требуется. - Если выплата осуществляется по договору без резервирования (атрибут isReserve имеет значение false в запросе /fintech/api/v1/salary-agreements) и со счета в другом банке, то объект обязательно необходимо заполнить,
year	string	YYYY	^[0-9]{4}$	required	Год отчетного периода
}
AmountCurrency {
amount	number	number	^[0-9]{1,16}\.[0-9]{2}$	required	Сумма,
currencyCode	string	ОКВ	^[0-9]{1,3}$	required	Цифровой код валюты,
currencyName	string	ISO 4217	^[A-Z]{3}$	required	Буквенный ISO-код валюты
}
Signature {
base64Encoded	string	base64	^[a-zA-Z0-9]+$	required	Значение электронной подписи (ЭП), закодированное в Base64.
certificateuuid	string	UUID	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$	required	Уникальный идентификатор сертификата ключа проверки электронной подписи
}
PayrollEmpSalary {
account	string	string	^[0-9]{20}$	required	Номер счета сотрудника,
amount	AmountCurrency	object		required	Сумма начисления,
bic	string	string	^[0-9]{9}$	optional	БИК банка сотрудника. Заполняется в случае, если счет сотрудника открыт не в СберБанке,
firstName	string	string	^[a-zA-Zа-яА-ЯеЁ]{1,1024}$	required	Имя
withheldAmount	number	number	^[0-9]{1,16}\.[0-9]{2}$	optional	Сумма удержанных средств по исполнительному документу,
lastName	string	string	^[a-zA-Zа-яА-ЯеЁ]{1,1024}$	required	Фамилия,
middleName	string	string	^[a-zA-Zа-яА-ЯеЁ]{1,1024}$	optional	Отчество,
}
PayrollPayDoc {
amount	AmountCurrency	object		required	Сумма начисления. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке,
docDate	string	ISO 8601 YYYY-MM-DD	^[0-9]{4}-[0-9]{2}-[0-9]{2}$	required	Дата расчетного документа. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке,
number	string	string	^[0-9]{1,6}$	required	Номер расчетного документа. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке,
payeeAccount	string	string	^[0-9]{20}$	required	Номер счета получателя. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке,
payeeBic	string	string	^[0-9]{9}$	required	БИК банка получателя. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке,
payerAccount	string	string	^[0-9]{20}$	required	Номер счета плательщика. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке,
payerBic	string	string	^[0-9]{9}$	required	БИК банка плательщика. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке,
purpose	string	string	^[a-zA-Z0-9. _ -]{1,212}$	required	Назначение платежного документа. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке
}

POST /fintech/api/v1/payrolls HTTP/1.1
Accept: application/json
Authorization: Bearer xbgDF3brf456ghi789jkl012mNKFtEpqr678

{
  "account": "40802810600000200000",
  "admissionValue": "01",
  "amount": {
    "amount": 1.01,
    "currencyCode": "840",
    "currencyName": "USD"
  },
  "authPersonName": "Иванов Алексей Сергеевич",
  "authPersonTelfax": "8(495)1234567",
  "contractDate": "2018-12-31",
  "contractNumber": "1",
  "date": "2018-12-31",
  "digestSignatures": [
    {
      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
      "certificateuuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
    }
  ],
  "employeeSalaries": [
    {
      "account": "40802810600000200000",
      "amount": {
        "amount": 1.01,
        "currencyCode": "840",
        "currencyName": "USD"
      },
      "bic": "044525225",
      "firstName": "Дмитрий",
      "lastName": "Петров",
      "middleName": "Сергеевич",
      "withheldAmount": 1.01
    }
  ],
  "employeesNumber": 254,
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "incomeTypeCode": "1",
  "loanAmount": {
    "amount": 1.01,
    "currencyCode": "840",
    "currencyName": "USD"
  },
  "loanDate": "2018-12-31",
  "loanNumber": "1234567890",
  "month": "Январь",
  "number": "1",
  "orgName": "Общество с ограниченной ответственностью \"Клиент\"",
  "orgTaxNumber": "7707083893",
  "payDocs": [
    {
      "amount": {
        "amount": 1.01,
        "currencyCode": "840",
        "currencyName": "USD"
      },
      "docDate": "2018-12-31",
      "number": "1",
      "payeeAccount": "40802810600000200000",
      "payeeBic": "044525225",
      "payerAccount": "40802810600000200000",
      "payerBic": "044525225",
      "purpose": "Выплата заработной платы за январь. НДС не облагается."
    }
  ],
  "year": "2019"
}

digestSignatures

Формат дайджеста

• Формат
• Пример

Наименование поля	Описание поля	Пример
account	Номер счета клиента	40702810600000001523
admissionValue	Вид зачисления (цифровое значение вида зачисления) из справочника видов зачисления SalType	01
amount.amount	Сумма по договору	1240687.00
amount.currencyName	Трехбуквенный код валюты	RUB
authPersonName	Имя уполномоченного сотрудника организации пользователя	Иванов Алексей Сергеевич
authPersonTelfax	Номер телефона, факса уполномоченного сотрудника организации пользователя	8(495)3612541
bic	БИК банка пользователя	044525225
contractDate	Дата договора	2018-02-20
contractNumber	Номер договора	456
date	Дата составления документа	2018-02-20
employeesNumber	Количество сотрудников	300
externalId	Идентификатор документа, присвоенный сервисом (UUID)	550e8400-e29b-41d4-a716-446655440000
incomeTypeCode	Код вида дохода получателей выплаты по 229-ФЗ	1
loanAmount	Сумма оплаты за счет кредитных средств	1000.00
loanDate	Дата кредитного договора	04.03.2019
loanNumber	Номер кредитного договора	155
month	Месяц отчетного периода	Январь
orgName	Наименование организации пользователя	ООО Ромашка
orgTaxNumber	ИНН пользователя	222201236445
year	Год отчетного периода	2018
TABLES
TABLES=employeeSalaries
account	Номер счета физического лица Счет физического лица (получателя зарплаты) не может быть открыт в стороннем банке. Подразделение Сбербанка определяется в СББОЛ по счету, а именно по цифрам из отмеченных разрядов хххххххххХХХХххххххх	40702810600000001673
amount.amount	Сумма	675988.00
amount.currencyName	Трехбуквенный код валюты	RUB
firstName	Имя физического лица	Дмитрий
lastName	Фамилия физического лица	Петров
middleName	Отчество физического лица	Дмитриевич
withheldAmount	Сумма удержанных средств по исполнительному документу	1010.01
Не заполняется если в зарплатном договоре стоит признак «с резервированием»!
TABLES=payDocs
amount.amount	Сумма	675988.00
amount.currencyName	Трехбуквенный код валюты	RUB
docDate	Дата расчетного документа (по местному времени обслуживающего подразделения банка)	2018-02-20
number	Номер расчетного документа	388
payeeAccount	Номер счета получателя	40702810500006103990
payeeBic	БИК банка зачисления	044525225
payerAccount	Номер счета плательщика	40702810500006103990
payerBic	БИК банка плательщика	044525225
purpose	Назначение платежа	Зачисление зарплаты

account=40702810078452334405
admissionValue=01
amount.amount=10000.55
amount.currencyName=RUB
authPersonName=Иванов Александр Сергеевич
authPersonTelfax=+7(812)1234567
bic=044525225
contractDate=2019-02-04
contractNumber=46096
date=2019-02-04
employeesNumber=2
externalId=b37fbdbc-d7a3-49c4-a191-be8e8b49ffba
incomeTypeCode=1
loanamount=1000.00
loandate=04.03.2019
loanNumber=155
month=Январь
orgName=Организация MuSAAIQKoXSVAFU
orgTaxNumber=4781796357
year=2019
TABLES
Table=EmployeeSalaries
account=42301810600000200001
amount.amount=5000.50
amount.currencyName=RUB
firstName=Иван
lastName=Иванов
middleName=Иванович
withheldAmount=1010.01
#
account=42301810600000200002
amount.amount=5000.05
amount.currencyName=RUB
firstName=Петр
lastName=Петров
middleName=Петрович
withheldAmount=1020.01
#

Responses

201 (Created)

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Payroll {
account	string	optional	Номер счета клиента,
admissionValue	string	required	Вид зачисления,
amount	AmountCurrency	required	Итоговая сумма зачисления,
authPersonName	string	optional	ФИО уполномоченного сотрудника организации пользователя,
authPersonTelfax	string	optional	Номер телефона, факса уполномоченного сотрудника организации пользователя,
bankComment	string	optional	Банковский комментарий к статусу документа,
bankStatus	string	optional	Статус документа,
bic	string	required	БИК банка пользователя,
commissionInfo	PayrollCommissionInfo	optional	Тарифы и комиссия зарплатной ведомости,
contractDate	string	required	Дата договора,
contractNumber	string	required	Номер договора,
date	string	required	Дата составления документа,
digestSignatures	Array[Signature]	optional	Электронные подписи по дайджесту документа,
employeeSalaries	Array[PayrollEmpSalary]	optional	Данные сотрудников для зачисления выплаты
employeesNumber	integer	required	Количество сотрудников,
externalId	string	required	Идентификатор документа, который вы присваиваете самостоятельно,
incomeTypeCode	string	optional	Код вида дохода получателей выплаты по 229-ФЗ,
loanAmount	AmountCurrency	optional	Сумма оплаты за счет кредитных средств,
loanDate	string	optional	Дата кредитного договора,
loanNumber	string	optional	Номер кредитного договора,
month	string	required	Месяц отчетного периода,
number	string	optional	Номер документа,
orgName	string	required	Наименование организации пользователя,
orgTaxNumber	string	required	ИНН организации пользователя
payDocs	Array[PayrollPayDoc]	optional	Платежные документы перечисления зарплаты,
year	string	required	Год отчетного периода
}
AmountCurrency {
amount	number	required	Сумма,
currencyCode	string	required	Цифровой код валюты,
currencyName	string	required	Буквенный ISO-код валюты
}
PayrollCommissionInfo {
actualRate	number	optional	Фактическая тарифная ставка комиссии (%),
actualSum	number	optional	Фактическая сумма комиссии,
estimatedRate	number	optional	Предварительная тарифная ставка комиссии (%),
estimatedSum	number	optional	Предварительная сумма комиссии,
invoiceDate	string	optional	Дата выставления счета и направления детализации
}
Signature {
base64Encoded	string	required	Значение электронной подписи (ЭП), закодированное в Base64,
certificateuuid	string	required	Уникальный идентификатор сертификата ключа проверки электронной подписи
}
PayrollEmpSalary {
account	string	required	Номер счета сотрудника,
amount	AmountCurrency	required	Сумма начисления,
bankMessage	string	optional	Сообщение из банка по сотруднику,
bic	string	optional	БИК банка сотрудника,
firstName	string	required	Имя
withheldAmount	number	optional	Сумма удержанных средств по исполнительному документу,
lastName	string	required	Фамилия,
middleName	string	optional	Отчество,
receiptResult	string	optional	Результат регистрации самозанятого в ФНС,
receiptStatus	string	optional	Статус регистрации самозанятого в ФНС,
result	string	optional	Результат начисления
}
PayrollPayDoc {
amount	AmountCurrency	required	Сумма начисления,
docDate	string	required	Дата расчетного документа
number	string	required	Номер расчетного документа
payeeAccount	string	required	Номер счета получателя,
payeeBic	string	required	БИК банка получателя,
payerAccount	string	required	Номер счета плательщика,
payerBic	string	required	БИК банка плательщика,
purpose	string	required	Назначение платежного документа
}

HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8


{
  "account": "40802810600000200000",
  "admissionValue": "01",
  "amount": {
    "amount": 1.01,
    "currencyCode": "840",
    "currencyName": "USD"
  },
  "authPersonName": "Иванов Алексей Сергеевич",
  "authPersonTelfax": "8(495)1234567",
  "bankComment": "string",
  "bankStatus": "string",
  "bic": "044525225",
  "commissionInfo": {
    "actualRate": 1.01,
    "actualSum": 1.01,
    "estimatedRate": 1.01,
    "estimatedSum": 1.01,
    "invoiceDate": "2018-12-31"
  },
  "contractDate": "2018-12-31",
  "contractNumber": "1",
  "date": "2018-12-31",
  "digestSignatures": [
    {
      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
      "certificateuuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
    }
  ],
  "employeeSalaries": [
    {
      "account": "40802810600000200000",
      "amount": {
        "amount": 1.01,
        "currencyCode": "840",
        "currencyName": "USD"
      },
      "bankMessage": "string",
      "bic": "044525225",
      "firstName": "Дмитрий",
      "lastName": "Петров",
      "middleName": "Сергеевич",
      "receiptResult": "https://lknpd.nalog.ru/api/v1/receipt/366522706980/2d7yuc/print",
      "receiptStatus": "Получен",
      "result": "string",
      "withheldAmount": 1.01
    }
  ],
  "employeesNumber": 254,
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "incomeTypeCode": "1",
  "loanAmount": {
    "amount": 1.01,
    "currencyCode": "840",
    "currencyName": "USD"
  },
  "loanDate": "2018-12-31",
  "loanNumber": "1234567890",
  "month": "Январь",
  "number": "1",
  "orgName": "Общество с ограниченной ответственностью \"Клиент\"",
  "orgTaxNumber": "7707083893",
  "payDocs": [
    {
      "amount": {
        "amount": 1.01,
        "currencyCode": "840",
        "currencyName": "USD"
      },
      "docDate": "2018-12-31",
      "number": "1",
      "payeeAccount": "40802810600000200000",
      "payeeBic": "044525225",
      "payerAccount": "40802810600000200000",
      "payerBic": "044525225",
      "purpose": "Выплата заработной платы за январь. НДС не облагается."
    }
  ],
  "year": "2019"
} 

400 (Bad request)

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
WORKFLOW_FAULT	Не найден зарплатный договор с номером {contractNumber} от {contractDate}	Проверьте корректность заполненных атрибутов contractNumber и contractDate. При необходимости запросите повторно информацию по зарплатному договору /fintech/api/v1/salary-agreements и используйте данные из ответа.
	Для внешнего сервиса недоступны операции по счету: {номер счета}	Возможные причины ошибки: счет не добавлен в список разрешенных в оферте; внешний сервис заблокирован в СББОЛ; счет указан неверно. Отсутствует доступный открытый рублевый расчетный счет у организации плательщика
	Документ с такими реквизитами уже существует	Проверка по идентификатору документа (externalId) в течение года.
VALIDATION_FAULT	Объект {название объекта} не соответствует модели	Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
ResourceFault {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
checks	array[Check]	optional	Список проверок, приведших к ошибке,
fieldNames	array[string]	optional	Названия полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
level	string	optional	Уровень результата = ['ERROR', 'WARNING'],
message	string	optional	Сообщение,
fields	array[string]	optional	Названия полей (при наличии связи с моделью)
}

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8

{
    "cause": "WORKFLOW_FAULT",
    "referenceId": "feffd4e7-f3a5-4057-9682-179ea045448e",
    "message": "Не найден зарплатный договор с номером 1 от 31.12.2018",
    "checks": [],
    "fieldNames": null
} 

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
	Некорректное значение Access Token	Указан некорректный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "UNAUTHORIZED",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "accessToken not found by value = 3513f959dbbd57490aa9f9ff67fb7380fae5m3"
}

403 (Forbidden)

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция PAYROLL. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8

{
    "cause": "ACTION_ACCESS_EXCEPTION",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "Операция не может быть выполнена: доступ к ресурсу запрещен"
}

429 (Too Many Requests)

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 429 Too Many Requests
Content-Type: application/json;charset=UTF-8

{
  "cause": " TOO_MANY_REQUESTS ",
  "referenceId": "5650c1e4-5039-4038-8cad-afab64003f61",
  "message": " Превышен лимит запросов. Повторите операцию позже"
}

500 (Internal Server Error)

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNKNOWN_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
  "message": "Внутренняя ошибка сервера"
}

503 (Service Temporarily Unavailable)

Cause	Message	Description
UNAVAILABLE_RESOURCE_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNAVAILABLE_RESOURCE_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a67d",
  "message": "Внутренняя ошибка сервера"
}

Получение статуса зарплатной ведомости

/fintech/api/v1/payrolls/{externalId}/state

Запрос позволяет позволяет получить статус ранее отправленной зарплатной ведомости.

Для получения статуса зарплатной ведомости необходимо отправить GET-запрос /fintech/api/v1/payrolls/{externalId}/state с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором документа (externalId) в path-параметре.

В параметре scope ссылки авторизации пользователя должен быть указан сервис PAYROLL для получения доступа к этому ресурсу.

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

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

Request

/fintech/api/v1/payrolls/{externalId}/state

• Модель
• Пример

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^[a-zA-Z0-9]{38}$	required	Access token пользователя, полученный через SSO.
Accept	string	string	^(application/json|application/jose)	optional	Указывает на формат данных, который вы готовы принять от Банка. - Если ответ не требуется в зашифрованном виде, то может быть не указан или передан со значением application/json. - Если необходимо получить ответ на запрос токена в зашифрованном виде, то необходимо передать параметр со значением application/jose.
PATH PARAMETERS
externalId	string	UUID	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$	required	Идентификатор документа, присвоенный вами при создании документа

GET /fintech/api/v1/payrolls/7c62a50c-1b9a-4c77-96b3-7b7d3722ea20/state HTTP/1.1
Authorization: Bearer bDe6ccc14346dd34aa39C326bd85c42138942c
Accept: */*

Responses

200 (ОК)

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
PayrollState {
bankComment	string	optional	Банковский комментарий к статусу документа,
bankStatus	string	optional	Статус документа,
receiptStatus	string	optional	Статус регистрации дохода самозанятого в ФНС (чек)
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "bankComment": "Документ в обработке",
  "bankStatus": "PROCESSING",
  "receiptStatus": "FINISHED"
}

400 (Bad request)

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULT	Объект {название объекта} не соответствует модели	Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
ResourceFault {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
checks	array[Check]	optional	Список проверок, приведших к ошибке,
fieldNames	array[string]	optional	Названия полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
level	string	optional	Уровень результата = ['ERROR', 'WARNING'],
message	string	optional	Сообщение,
fields	array[string]	optional	Названия полей (при наличии связи с моделью)
}

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8

{
    "cause": "WORKFLOW_FAULT",
    "referenceId": "7b0534d6-1d67-4a7d-9254-2f28d1c33091",
    "message": "Параметр \"externalId\" не соответствует регулярному выражению: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
    "checks": [],
    "fieldNames": null
}

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "UNAUTHORIZED",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "accessToken not found by value = 3513f959dbbd57490aa9f9ff67fb7380fae5m3"
}

403 (Forbidden)

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция PAYROLL. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8

{
    "cause": "ACTION_ACCESS_EXCEPTION",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "Операция не может быть выполнена: доступ к ресурсу запрещен"
}

404 (Not Found)

Cause	Message	Description
NOT_FOUND	Документ с указанным ID не найден

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "NOT_FOUND",
    "referenceId": "1bd1b8b9-1bd3-4159-9909-d30536211114",
    "message": "Документ с указанным ID не найден"
}

429 (Too Many Requests)

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 429 Too Many Requests
Content-Type: application/json;charset=UTF-8

{
  "cause": " TOO_MANY_REQUESTS ",
  "referenceId": "5650c1e4-5039-4038-8cad-afab64003f61",
  "message": " Превышен лимит запросов. Повторите операцию позже"
}

500 (Internal Server Error)

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNKNOWN_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
  "message": "Внутренняя ошибка сервера"
}

503 (Service Temporarily Unavailable)

Cause	Message	Description
UNAVAILABLE_RESOURCE_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNAVAILABLE_RESOURCE_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a67d",
  "message": "Внутренняя ошибка сервера"
}

Статусы зарплатной ведомости

bankStatus (string)

Код состояние документа	Наименование статуса	Назначение кода состояния
Промежуточный/Продолжать опрашивать
ACCEPTED	Принят	Электронный документ принят на стороне Банка
ACCEPTED_BY_ABS	Принят АБС или Принят	Электронный документ был принят к обработке в АБС Банка
CARD2	Картотека 2 или Ожидает оплаты	АБС обнаружено, что на счете плательщика недостаточно средств для иcполнения документа
CREATED	Создан	Документ записан в БД, проверки не выполнялись
DELAYED	Приостановлен	Обработка электронного документа была приостановлена
DELIVERED	Доставлен	Запрос доставлен в ДБО и взят в обработку
FRAUDALLOW	Одобрен ФРОД	Проверка во ФРОДЕ прошла успешно, переход на «Принят»
FRAUDREVIEW	На проверке у специалиста Банка	Со стороны ФРОД-анализа получен статус документа «На проверке у специалиста Банка»
FRAUDSENT	Отправлен во ФРОД	Документ отправлен на проверку в АС Fraud-мониторинг
FRAUDSMS	Требуется подтверждение sms-паролем	Со стороны ФРОД-анализа получен статус документа «Требуется подтверждение sms-паролем»
PARTSIGNED	Частично подписан	ЭД подписан частью подписей, входящих в предусмотренный для данного документа комплект подписей
SENDING_TO_RZK	Отправляется в СБК	Электронный документ отправлен в СБК, но не получен квиток о доставке
SENT_TO_RZK	Отправлено в СБК
WAITING_FOR_RZK	Ожидание от СБК
SIGNED	Подписан	ЭД подписан предусмотренным для него комплектом подписей.
VALIDEDS	ЭП/АСП верна
TRIED	Проверен
PROCESSING	Согласование контролирующей организацией
CORRESPONDENT_APPROVE_WAITING	Ожидает подтверждения контрагента
EXPORTED	Выгружен
SIGNED_BANK	Подписан Банком
IMPORTED	Импортирован
TRANSIT	Транзитный
WAITING_FOR_ORDER	Ожидает распоряжения
WAITING_FOR_MIGRATION	Ожидает миграции
EXPORTING	Выгружается
Окончательный (Не успешный)/Прекратить опрос
TEMPLATE	Шаблон
INCONSISTENT_DATA	Нарушена целостность документа
UNABLE_TO_RECEIVE	Ошибка при приеме
FRAUDDENY	Отвергнут ФРОД	Документ отказан на основе проверки в АС Fraud-мониторинг, переходим в «Отвергнут банком»
CHECKERROR	Ошибка контроля	ЭД сформирован, но при сохранении не прошел проверку корректности заполнения полей и сохранен с имеющимися в нем ошибками
INVALIDEDS	ЭП/АСП не верна Подпись неверна	Проверка ЭП под ЭД на стороне Банка дала отрицательный результат
REFUSEDBYBANK	Отвергнут банком или Отклонен банком	Электронный документ отвергнут банком
REFUSEDBYABS	Отказан АБС	Электронный документ не прошел проверки в АБС
REQUISITEERROR	Ошибка реквизитов	В ЭД указаны ошибочные реквизиты
REFUSED_BY_RZK	Отказан контролирующей организацией	Электронный документ не прошел проверки контролирующей организацией
Окончательный (Успешный)/Прекратить опрос
IMPLEMENTED	Исполнен	Электронный документ исполнен Банком
PARTIMPLEMENTED	Частично исполнен

Получение полных данных по зарплатной ведомости

/fintech/api/v1/payrolls/{externalId}

Запрос позволяет позволяет получить все данные по ранее отправленной зарплатной ведомости.

Для получения данных по зарплатной ведомости необходимо отправить GET-запрос /fintech/api/v1/payrolls/{externalId} с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором документа (externalId) в path-параметре.

В параметре scope ссылки авторизации пользователя должен быть указан сервис PAYROLL для получения доступа к этому ресурсу.

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

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

Request

/fintech/api/v1/payrolls/{externalId}

• Модель
• Пример

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^[a-zA-Z0-9]{38}$	required	Access token пользователя, полученный через SSO.
Accept	string	string	^(application/json|application/jose)	optional	Указывает на формат данных, который вы готовы принять от Банка. - Если ответ не требуется в зашифрованном виде, то может быть не указан или передан со значением application/json. - Если необходимо получить ответ на запрос токена в зашифрованном виде, то необходимо передать параметр со значением application/jose.
PATH PARAMETERS
externalId	string	UUID	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$	required	Идентификатор документа, присвоенный вами при создании документа

GET /fintech/api/v1/payrolls/7c62a50c-1b9a-4c77-96b3-7b7d3722ea20 HTTP/1.1
Authorization: Bearer bDe6ccc14346dd34aa39C326bd85c42138942c
Accept: */*

Responses

200 (ОК)

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Payroll {
account	string	optional	Номер счета клиента,
admissionValue	string	required	Вид зачисления,
amount	AmountCurrency	required	Итоговая сумма зачисления,
authPersonName	string	optional	ФИО уполномоченного сотрудника организации пользователя,
authPersonTelfax	string	optional	Номер телефона, факса уполномоченного сотрудника организации пользователя,
bankComment	string	optional	Банковский комментарий к статусу документа,
bankStatus	string	optional	Статус документа,
bic	string	required	БИК банка пользователя,
commissionInfo	PayrollCommissionInfo	optional	Тарифы и комиссия зарплатной ведомости,
contractDate	string	required	Дата договора,
contractNumber	string	required	Номер договора,
date	string	required	Дата составления документа,
digestSignatures	Array[Signature]	optional	Электронные подписи по дайджесту документа,
employeeSalaries	Array[PayrollEmpSalary]	optional	Данные сотрудников для зачисления выплаты
employeesNumber	integer	required	Количество сотрудников,
externalId	string	required	Идентификатор документа, который вы присваиваете самостоятельно,
incomeTypeCode	string	optional	Код вида дохода получателей выплаты по 229-ФЗ,
loanAmount	AmountCurrency	optional	Сумма оплаты за счет кредитных средств,
loanDate	string	optional	Дата кредитного договора,
loanNumber	string	optional	Номер кредитного договора,
month	string	required	Месяц отчетного периода,
number	string	optional	Номер документа,
orgName	string	required	Наименование организации пользователя,
orgTaxNumber	string	required	ИНН организации пользователя
payDocs	Array[PayrollPayDoc]	optional	Платежные документы перечисления зарплаты,
year	string	required	Год отчетного периода
}
AmountCurrency {
amount	number	required	Сумма,
currencyCode	string	required	Цифровой код валюты,
currencyName	string	required	Буквенный ISO-код валюты
}
PayrollCommissionInfo {
actualRate	number	optional	Фактическая тарифная ставка комиссии (%),
actualSum	number	optional	Фактическая сумма комиссии,
estimatedRate	number	optional	Предварительная тарифная ставка комиссии (%),
estimatedSum	number	optional	Предварительная сумма комиссии,
invoiceDate	string	optional	Дата выставления счета и направления детализации
}
Signature {
base64Encoded	string	required	Значение электронной подписи (ЭП), закодированное в Base64,
certificateuuid	string	required	Уникальный идентификатор сертификата ключа проверки электронной подписи
}
PayrollEmpSalary {
account	string	required	Номер счета сотрудника,
amount	AmountCurrency	required	Сумма начисления,
bankMessage	string	optional	Сообщение из банка по сотруднику,
bic	string	optional	БИК банка сотрудника,
firstName	string	required	Имя
withheldAmount	number	optional	Сумма удержанных средств по исполнительному документу,
lastName	string	required	Фамилия,
middleName	string	optional	Отчество,
receiptResult	string	optional	Результат регистрации самозанятого в ФНС,
receiptStatus	string	optional	Статус регистрации самозанятого в ФНС,
result	string	optional	Результат начисления
}
PayrollPayDoc {
amount	AmountCurrency	required	Сумма начисления,
docDate	string	required	Дата расчетного документа
number	string	required	Номер расчетного документа
payeeAccount	string	required	Номер счета получателя,
payeeBic	string	required	БИК банка получателя,
payerAccount	string	required	Номер счета плательщика,
payerBic	string	required	БИК банка плательщика,
purpose	string	required	Назначение платежного документа
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8


{
  "account": "40802810600000200000",
  "admissionValue": "01",
  "amount": {
    "amount": 1.01,
    "currencyCode": "840",
    "currencyName": "USD"
  },
  "authPersonName": "Иванов Алексей Сергеевич",
  "authPersonTelfax": "8(495)1234567",
  "bankComment": "string",
  "bankStatus": "string",
  "bic": "044525225",
  "commissionInfo": {
    "actualRate": 1.01,
    "actualSum": 1.01,
    "estimatedRate": 1.01,
    "estimatedSum": 1.01,
    "invoiceDate": "2018-12-31"
  },
  "contractDate": "2018-12-31",
  "contractNumber": "1",
  "date": "2018-12-31",
  "digestSignatures": [
    {
      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
      "certificateuuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
    }
  ],
  "employeeSalaries": [
    {
      "account": "40802810600000200000",
      "amount": {
        "amount": 1.01,
        "currencyCode": "840",
        "currencyName": "USD"
      },
      "bankMessage": "string",
      "bic": "044525225",
      "firstName": "Дмитрий",
      "lastName": "Петров",
      "middleName": "Сергеевич",
      "receiptResult": "https://lknpd.nalog.ru/api/v1/receipt/366522706980/2d7yuc/print",
      "receiptStatus": "Получен",
      "result": "string",
      "withheldAmount": 1.01
    }
  ],
  "employeesNumber": 254,
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "incomeTypeCode": "1",
  "loanAmount": {
    "amount": 1.01,
    "currencyCode": "840",
    "currencyName": "USD"
  },
  "loanDate": "2018-12-31",
  "loanNumber": "1234567890",
  "month": "Январь",
  "number": "1",
  "orgName": "Общество с ограниченной ответственностью \"Клиент\"",
  "orgTaxNumber": "7707083893",
  "payDocs": [
    {
      "amount": {
        "amount": 1.01,
        "currencyCode": "840",
        "currencyName": "USD"
      },
      "docDate": "2018-12-31",
      "number": "1",
      "payeeAccount": "40802810600000200000",
      "payeeBic": "044525225",
      "payerAccount": "40802810600000200000",
      "payerBic": "044525225",
      "purpose": "Выплата заработной платы за январь. НДС не облагается."
    }
  ],
  "year": "2019"
} 

400 (Bad request)

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULT	Объект {название объекта} не соответствует модели	Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
ResourceFault {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
checks	array[Check]	optional	Список проверок, приведших к ошибке,
fieldNames	array[string]	optional	Названия полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
level	string	optional	Уровень результата = ['ERROR', 'WARNING'],
message	string	optional	Сообщение,
fields	array[string]	optional	Названия полей (при наличии связи с моделью)
}

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8

{
    "cause": "WORKFLOW_FAULT",
    "referenceId": "7b0534d6-1d67-4a7d-9254-2f28d1c33091",
    "message": "Параметр \"externalId\" не соответствует регулярному выражению: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
    "checks": [],
    "fieldNames": null
}

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "UNAUTHORIZED",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "accessToken not found by value = 3513f959dbbd57490aa9f9ff67fb7380fae5m3"
}

403 (Forbidden)

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция PAYROLL. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8

{
    "cause": "ACTION_ACCESS_EXCEPTION",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "Операция не может быть выполнена: доступ к ресурсу запрещен"
}

404 (Not Found)

Cause	Message	Description
NOT_FOUND	Документ с указанным ID не найден

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "NOT_FOUND",
    "referenceId": "1bd1b8b9-1bd3-4159-9909-d30536211114",
    "message": "Документ с указанным ID не найден"
}

429 (Too Many Requests)

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 429 Too Many Requests
Content-Type: application/json;charset=UTF-8

{
  "cause": " TOO_MANY_REQUESTS ",
  "referenceId": "5650c1e4-5039-4038-8cad-afab64003f61",
  "message": " Превышен лимит запросов. Повторите операцию позже"
}

500 (Internal Server Error)

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNKNOWN_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
  "message": "Внутренняя ошибка сервера"
}

503 (Service Temporarily Unavailable)

Cause	Message	Description
UNAVAILABLE_RESOURCE_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNAVAILABLE_RESOURCE_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a67d",
  "message": "Внутренняя ошибка сервера"
}