Сервис «Корпоративные подписки»
Терминология
ЗДА (заранее данный акцепт) - документ, который содержит согласие юридического лица на списание средств с лицевого счета плательщика.
Подписка - согласие на безакцептное списание денежных средств за использование сервиса или услуг.
Пакет услуг - два и более сервиса внутри одной оферты.
СББОЛ - Сбербанк Бизнес Онлайн.
ЭП/ЭЦП/ЦП - электронная цифровая подпись, которая формируется закрытым ключом сертификата.
Пользователь партнера - логин в организации, которая является владельцем сервиса.
Пользователь клиента - логин в организации, которая не является владельцем сервиса.
Дайджест - набор значимых полей документа, который подписывается ЭП.
Тип подписи - полномочия пользователя СББОЛ. Например: первая, вторая, единственная подпись.
Base64/Base64Url - формат кодирования данных при помощи только 64 символов ASCII
Назначение
Ресурсы позволяют партнеру ежемесячно списывать денежные средства со счета клиента. Сервис позволяет автоматизировать оплату за предоставленные услуги.
Сценарий использования
- Получить AccessToken.
- Получить сведения о клиентах подключенных к подпискам и пакетам услуг.
- Отправить информацию по тарифу за используемый клиентом сервис (опционально).
- Реализовать один из вариантов списаний с клиента:
- Платежное требование с электронной подписью.
- Начисления.
Для обращения к ресурсу необходимо отправлять запрос на:
Текущий тестовый контур
https://edupirfintech.sberbank.ru:9443
Новый тестовый контур
https://iftfintech.testsbi.sberbank.ru:9443
Промышленный контур
https://fintech.sberbank.ru:9443
Клиенты с подключенными подписками
Ресурс /v1/partner-info/advance-acceptances
позволяет Партнеру получить сведения о клиентах, подключенных к подпискам и пакетам услуг. Полученную информацию можно анализировать и использовать для выставления платежных требований в адрес клиентов сервиса. В ответе возвращается информация за один запрашиваемый день. Для поддержания актуальной информации и изменений на своей стороне необходимо осуществлять ежедневный запрос информации.
Для получения информации о клиентах, подключенных к подпискам и пакетам услуг, необходимо выполнить следующие шаги.
Шаги
1. При авторизации пользователя партнера передать в scope сервис GET_ADVANCE_ACCEPTANCES
.
2. Отправить GET-запрос (/v1/partner-info/advance-acceptances), в котором необходимо передать авторизационный токен к данным собственной организации (Access Token) и дату, за которую запрашивается информация (date).
Модель запроса
Наименование | Описание |
---|---|
Параметры заголовка | |
Authorization (String) | Access token собственной организации, полученный через SSO Пример: Bearer 5c2f4c8d-4c8a-4301-8df7-195354932b19-1 |
Параметры запроса | |
date (date-time) | Дата (подключения или отключения) Формат: yyyy-MM-dd |
clientId (String) | Идентификатор сервиса |
Пример запроса
curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer 5c2f4c8d-4c8a-4301-8df7-195354932b19-1'
'http://edupirfintech.sberbank.ru:9443/fintech/api/v1/partner-info/advance-acceptances?date=2022-03-29'
Модель ответа
Наименование | Описание |
---|---|
AdvanceAcceptance [ | |
AdvanceAcceptance 1 | |
] AdvanceAcceptance 1{ | |
active (boolean, optional) | Признак активности ЗДА , |
bundles (Array[AdvanceAcceptanceBundle], optional) | Информация о пакете услуг, |
payerAccount (string, optional) | Счет плательщика , |
payerBankBic (string, optional) | БИК банка плательщика , |
payerBankCorrAccount (string, optional) | Корсчет банка плательщика , |
payerInn (string, optional) | ИНН плательщика , |
payerName (string, optional) | Наименование плательщика , |
payerOrgIdHash (string, optional) | Идентификатор организации плательщика , |
purpose (string, optional) | Назначение платежа , |
sinceDate (string, optional) | Дата начала действия заранее данного акцепта , |
untilDate (string, optional) | Дата окончания действия заранее данного акцепта |
}AdvanceAcceptanceBundle { | |
code (string, optional) | Код пакета услуг , |
name (string, optional) | Наименование пакета услуг, |
sinceDate (string, optional) | Дата подключения пакета услуг , |
untilDate (string, optional) | Дата отключения пакета услуг, |
currentState (String, optional) | Статус пакета услуг в настоящее время. Возможные варианты: ACTIVE , NOT_PAID , DEACTIVATED |
} |
Пример ответа
[
{
"payerInn": "5414009744",
"payerAccount": "40702810938000000849",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"purpose": "202020 По договору №202020 от 29.03.2022",
"payerOrgIdHash": "286f8685274592b5a1e5f7e3d2f2aa583f65ad1f41165425fb4c0fafa790a9e7",
"payerName": "ООО_Автотест_Клиент_ЕКС_20200619123849",
"sinceDate": "2022-03-29",
"untilDate": "2022-06-07",
"active": true,
"bundles": null
},
{
"payerInn": "5331355363",
"payerAccount": "40702810338000000614",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"purpose": "202020 По договору №202020 от 29.03.2022",
"payerOrgIdHash": "e646c19e82e80f6b0895e711a1e8da511d34d1ac4eb0f9103867dfc8413007d0",
"payerName": "ООО_Автотест_Клиент_ЕКС_20200608203238",
"sinceDate": "2022-03-29",
"untilDate": null,
"active": true,
"bundles": null
},
{
"payerInn": "8755334940",
"payerAccount": "40702810338000000656",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"purpose": "202020 По договору №202020 от 29.03.2022",
"payerOrgIdHash": "a9137f1c0e7ece7576679e99f9ff67574f34fd6ad3fb5d7c629137dacc4b9ffb",
"payerName": "ООО_Автотест_Клиент_ЕКС_20200609164415",
"sinceDate": "2022-03-29",
"untilDate": null,
"active": true,
"bundles": null
}
]
Даже в том случае, если в ответе на запрос для атрибута Признак активности ЗДА получено значение "true", выставление в адрес клиента, оформившего ЗДА, платежных требований возможно только со следующего дня за датой, полученной в атрибуте ответа sinceDate.
Сохраните значение атрибута purpose (Назначение платежа), чтобы корректно заполнить purpose (Назначение платежа) в запросе на создание ИПТ - POST /v1/payment-request/outgoing
.
Создание платежных требований
Ресурс /v1/payment-requests/outgoing
позволяет Партнеру создавать исходящие платежные требования, где получателем средств является организация, предоставляющая сервис.
Шаги
1. При авторизации пользователя партнера передать в scope сервис PAYMENT_REQUEST_OUT
.
2. Отправить POST-запрос (/v1/payment-requests/outgoing), в котором необходимо передать авторизационный токен к данным клиента (Access Token) и реквизиты платежного требования. Авторизационный токен передается в параметре Authorization заголовка запроса.
Модель запроса
Наименование | Описание |
---|---|
Параметры заголовка | |
Authorization (String) | Access token организации-клиента, полученный через SSO Пример: Bearer c5e7110b-394a-45eb-9a4b-d8759cf6f9eb-1 |
Параметры тела запроса | |
PaymentRequestOut { | |
acceptanceTerm (string, optional) | Срок для акцепта (поле 36). Указывается количество дней для получения акцепта плательщика, |
amount (number) | Сумма платежа, |
bankComment (string, optional, read only) | Банковский комментарий к статусу документа, |
bankStatus (string, optional, read only) | Статус документа, |
crucialFieldsHash (string, optional) | Hash от ключевых полей документа, |
date (string) | Дата составления документа, |
deliveryKind (string, optional) | Вид платежа: электронно, срочно Если не заполнено или 0, то будет присвоено значение "электронно", |
digestSignatures (Array[Signature], optional) | Электронные подписи по дайджесту документа, |
externalId (string) | Идентификатор документа, присвоенный партнером (UUID), |
number (string, optional) | Номер документа, |
operationCode (string) | Код операции, |
payeeAccount (string) | Счет получателя платежа, |
payeeBankBic (string) | БИК получателя платежа, |
payeeBankCorrAccount (string, optional) | Корсчет банка получателя платежа, |
payeeInn (string, optional) | ИНН получателя платежа, |
payeeName (string) | Полное наименование получателя платежа, |
payerAccount (string) | Счет плательщика, |
payerBankBic (string) | БИК банка плательщика, |
payerBankCorrAccount (string) | Корсчет банка плательщика, |
payerInn (string) | ИНН плательщика, |
payerName (string) | Полное наименование плательщика, |
paymentCondition (string) | Условие оплаты (поле 35). Указывается цифра "1" - заранее данный акцепт плательщика или цифра "2" - требуется получение акцепта плательщика, |
priority (string) | Очередность платежа, |
purpose (string) | Назначение платежа Заполнять значением purpose, полученным в ответе на запрос GET /v1/partner-info/advance-acceptances Если необходимо дополнить назначение, поставьте точку и укажите свою информацию, |
vat (Vat, optional) | Данные НДС, |
voCode (string, optional) | Код вида валютной операции |
}Signature { | |
base64Encoded (string) | Значение электронной подписи, закодированное в Base64, |
certificateUuid (string) | Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID) |
}Vat { | |
amount (number, optional) | Сумма НДС, |
rate (string, optional) | Ставка НДС, |
type (string) | Способ расчета НДС = ['INCLUDED','NO_VAT', 'MANUAL'] stringEnum "INCLUDED", "NO_VAT", "MANUAL" |
} |
Пример запроса
{
"acceptanceTerm":"string",
"amount":1.01,
"bankComment":"string",
"bankStatus":"string",
"crucialFieldsHash":"string",
"date":"2018-12-31",
"deliveryKind":"электронно",
"digestSignatures":[
{
"base64Encoded":"HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number":"1",
"operationCode":"02",
"payeeAccount":"40802810600000200000",
"payeeBankBic":"044525225",
"payeeBankCorrAccount":"30101810400000000225",
"payeeInn":"7707083893",
"payeeName":"Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount":"40802810600000200000",
"payerBankBic":"044525225",
"payerBankCorrAccount":"30101810400000000225",
"payerInn":"7707083893",
"payerName":"Общество с ограниченной ответственностью \"Клиент\"",
"paymentCondition":"string",
"priority":"5",
"purpose":"Оплата заказа №123. НДС нет.",
"vat":{
"amount":1.01,
"rate":"10",
"type":"NO_VAT"
},
"voCode":"61150"
}
Модель ответа
Наименование | Описание |
---|---|
PaymentRequestOut { | |
acceptanceTerm (string, optional) | Срок для акцепта (поле 36). Указывается количество дней для получения акцепта плательщика, |
amount (number) | Сумма платежа, |
bankComment (string, optional, read only) | Банковский комментарий к статусу документа, |
bankStatus (string, optional, read only) | Статус документа, |
crucialFieldsHash (string, optional) | Hash от ключевых полей документа, |
date (string) | Дата составления документа, |
deliveryKind (string, optional) | Вид платежа, |
digestSignatures (Array[Signature], optional) | Электронные подписи по дайджесту документа, |
externalId (string) | Идентификатор документа, присвоенный партнером (UUID), |
number (string, optional) | Номер документа, |
operationCode (string) | Код операции, |
payeeAccount (string) | Счет получателя платежа, |
payeeBankBic (string) | БИК получателя платежа, |
payeeBankCorrAccount (string, optional) | Корсчет банка получателя платежа, |
payeeInn (string, optional) | ИНН получателя платежа, |
payeeName (string) | Полное наименование получателя платежа, |
payerAccount (string) | Счет плательщика, |
payerBankBic (string) | БИК банка плательщика, |
payerBankCorrAccount (string) | Корсчет банка плательщика, |
payerInn (string) | ИНН плательщика, |
payerName (string) | Полное наименование плательщика, |
paymentCondition (string) | Условие оплаты (поле 35). Указывается цифра "1" - заранее данный акцепт плательщика или цифра "2" - требуется получение акцепта плательщика, |
priority (string) | Очередность платежа, |
purpose (string) | Назначение платежа, |
vat (Vat, optional) | Данные НДС, |
voCode (string, optional) | Код вида валютной операции |
}Signature { | |
base64Encoded (string) | Значение электронной подписи, закодированное в Base64, |
certificateUuid (string) | Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID) |
}Vat { | |
amount (number, optional) | Сумма НДС, |
rate (string, optional) | Ставка НДС, |
type (string) | Способ расчета НДС = ['INCLUDED','NO_VAT', 'MANUAL'] stringEnum "INCLUDED", "NO_VAT", "MANUAL" |
} |
Пример ответа
{
"acceptanceTerm":"string",
"amount":1.01,
"bankComment":"string",
"bankStatus":"string",
"crucialFieldsHash":"string",
"date":"2018-12-31",
"deliveryKind":"электронно",
"digestSignatures":[
{
"base64Encoded":"HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number":"1",
"operationCode":"02",
"payeeAccount":"40802810600000200000",
"payeeBankBic":"044525225",
"payeeBankCorrAccount":"30101810400000000225",
"payeeInn":"7707083893",
"payeeName":"Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount":"40802810600000200000",
"payerBankBic":"044525225",
"payerBankCorrAccount":"30101810400000000225",
"payerInn":"7707083893",
"payerName":"Общество с ограниченной ответственностью \"Клиент\"",
"paymentCondition":"string",
"priority":"5",
"purpose":"Оплата заказа №123. НДС нет.",
"vat":{
"amount":1.01,
"rate":"10",
"type":"NO_VAT"
},
"voCode":"61150"
}
Передача электронной подписи
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature (все поля обязательны):
Наименования поля | Описания поля | Пример |
---|---|---|
base64Encoded (string) | Значение ЭП документа | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid (string) | Идентификатор сертификата, использованного при создании ЭП ( можно узнать, обратившись к ресурсу /v1/crypto) | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
В документе можно передать одну или две ЭП вместе с реквизитами создаваемого документа. Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе СББОЛ.
Документ может быть подписан следующими наборами подписей:
одна (единственная) подпись;
первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очередность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля, когда пользователь Партнера создается в Банке.
Формат дайджеста платежного требования
Наименование поля | Описание поля | Пример |
---|---|---|
acceptanceTerm | Срок акцепта | 5 |
amount | Сумма платежа | 100.01 |
date | Дата составления документа | 31.12.2018 |
externalId | Идентификатор документа, присвоенный сервисом | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
operationCode | Код операции | 02 |
payeeAccount | Номер счета получателя | 40802810600000200000 |
payeeBankBic | БИК получателя | 044525225 |
payeeBankCorrAccount | Корсчет банка получателя | 30101810400000000225 |
payeeInn | Инн получателя | 0 |
payeeName | Полное наименование получателя платежа | Общество с ограниченной ответственностью "Получатель" |
payerAccount | Счет плательщика | 40802810600000200000 |
payerBankBic | БИК плательщика | 044525225 |
payerBankCorrAccount | Корсчет банка плательщика | 30101810400000000225 |
payerInn | ИНН плательщика | 0 |
payerName | Полное наименование плательщика | Общество с ограниченной ответственностью "Клиент" |
paymentCondition | Условие оплаты (1/2) | 1 |
priority | Очередность платежа | 5 |
purpose | Назначение платежа | Оплата товара по договору №123 от 01.08.2018. НДС не облагается |
Пример дайджеста
acceptanceTerm=5
amount=100.01
date=2018-12-31
externalId=22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6
operationCode=02
payeeAccount=40802810600000200000
payeeBankBic=044525225
payeeBankCorrAccount=30101810400000000225
payeeInn=0
payeeName=Общество с ограниченной ответственностью "Получатель"
payerAccount=40802810600000200000
payerBankBic=044525225
payerBankCorrAccount=30101810400000000225
payerInn=0
payerName=Общество с ограниченной ответственностью "Клиент"
paymentCondition=1
priority=5
purpose=Назначение платежа
Процесс обработки платежного требования
Обработка платежного требования (ПТ)
Выгрузка ПТ из СББОЛ осуществляется каждые 5 минут в период с 9:00 – 16:30.
Если плательщик в Сбербанке
При поступлении платежного требования на стороне Банка выполняются следующие проверки:
Логические проверки плательщика/получателя ПТ. ПТ не исполняется и возвращается ошибка, если не прошли проверки.
Проверка на наличие заранее данного акцепта (ЗДА), выданного клиентом Партнеру.
Если ЗДА есть:
Проверка реквизитов ЗДА
Если проверка пройдена, выполняется проверка на ограничение по счету:
Если есть полные ограничения на списание денежных средств по счету, платежный документ помещается бессрочно в Картотеку 1
Если есть частичные ограничения, проверяется достаточность средств для списания (остаток от блокировки)
Проверка наличия денежных средств на счете:
Если денежных средств достаточно на полную оплату требования (с учетом всех действующих частичных блокировок средств), сразу выполняется списание и перечисление
Если денежных средств недостаточно (доступна не полная сумма), документ помещается в Картотеку 1 без срока и оплачивается из нее на сумму свободных средств
Если денежных средств на счете нет, вся сумма помещается в Картотеку 1/Картотеку 2
Если выявлено неполное соответствие ЗДА (например, не сходится одна цифра в дате или регистр в номере договора (русские/английские буквы)), документ передается на ручную обработку в операционный центр
Если ЗДА нет или реквизиты ЗДА полностью не соответствуют реквизитам из ПТ, то платежное требование помещается на 5 рабочих дней (не считая дня поступления) в Картотеку 1 для ручного акцепта клиента.
Если получатель Внешний плательщик
ПТ сформированное в СББОЛ уходит в Банк России, далее Банк России отправляет в банк получателя.
Частичная оплата со стороны клиента, периодичность обработки вновь появившихся денежных средств на счете клиента
Ручной акцепт:
Акцепт ПТ клиент может выполнить в СберБизнес. Есть возможность акцептовать как полную сумму, так и частично. После акцепта формируется документ на оплату.
При частичном акцепте суммы, оставшаяся сумма остается в картотеке до конца срока нахождения проводки в Картотеке либо на оставшуюся сумму можно сформировать отказ.
Списание денежных средств по проводке в бессрочной Картотеке 2 (при наличии ЗДА):
Списание выполняются с 9 до 22 часов каждые 2-2,5 часа. Перебираются все счета с Картотекой 2 и Картотекой 1 без срока, определяется платежеспособность счета (рассчитывается остаток свободных средств >0) и запускается процесс списания. Если до полного списания средств недостаточно, то выполняется частичное списание.
Отзыв платежного документа из Картотеки:
ИПТ в Картотека 1 (на ручном акцепте клиента) может быть отозвано плательщиком (отказ от акцепта).
Если ИПТ находится бессрочно в Картотека 1 или 2, отозвать ИПТ в СберБизнес нельзя.
Действие ЗДА:
ЗДА начинает действовать со дня следующего за днем поступления в Банк.
Если ПТ отправить в день создания ЗДА, платежный документ попадет в Картотеку 1 (на ручной акцепт клиенту).
Закрытие счета:
При закрытии счета все документы в картотеке аннулируются (возвращаются составителям без исполнения) без списания.
Статус SENDED_TO_PAYER
Если платежный документ помещается в Картотеку 1 или Картотеку 2, то документ переходит в статус SENDED_TO_PAYER
.
Получение статуса платежного требования
Ресурс /v1/payment-requests/outgoing/{externalId}/state
позволяет Партнеру получить статус ранее отправленного платежного требования.
Шаги
1. При авторизации пользователя партнера передать в scope сервис PAYMENT_REQUEST_OUT
.
2. Отправить GET-запрос (/v1/payment-requests/outgoing/{externalId}/state), в котором необходимо передать авторизационный токен к данным клиента (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Модель запроса
Наименование | Описание |
---|---|
Параметры заголовка | |
Authorization (String) | Access token организации-клиента, полученный через SSO Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1 |
Параметры запроса | |
externalId (String) | Идентификатор документа, присвоенный клиентом |
Пример запроса
curl -X GET --header 'Accept: /' --header
'Authorization: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1'
'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/payment-requests/outgoing/ffffffff-fffa-458e-ad92-fff9497303ba/state'
Модель ответа
Наименование | Описание |
---|---|
PaymentDocState { | |
bankComment (string, optional, read only) | Банковский комментарий к статусу документа, |
bankStatus (string, optional) | Статус документа, |
channelInfo (string, optional, read only) | Комментарий, специфичный для документа, полученного по данному каналу, |
} |
Пример ответа
{
"bankStatus": "CREATED",
"bankComment": null,
"channelInfo": null
}
Статусы обработки платежных документов
Код состояние документа | Наименование статуса | Назначение кода состояния |
---|---|---|
Промежуточные статусы/Продолжать опрашивать | ||
ACCEPTED | Принят | Электронный документ принят на стороне Банка |
ACCEPTED_BY_ABS | Принят АБС | Электронный документ был принят к обработке в АБС Банка |
CARD2 | Картотека 2 | Электронный документ передан в картотеку в ожидание средств на счету клиента |
CHECKERROR | Ошибка контроля | ЭД сформирован, но при сохранении не прошел проверку корректности заполнения полей и сохранен с имеющимися в нем ошибками |
CREATED | Создан | Документ записан в БД, проверки не выполнялись |
DELAYED | Приостановлен | Обработка электронного документа была приостановлена |
DELIVERED | Доставлен | Запрос доставлен в ДБО и взят в обработку |
EXPORTED | Выгружен | Электронный документ выгружен Банком в АБС |
FRAUDALLOW | Одобрен ФРОД | Проверка во ФРОДЕ прошла успешно, переход на «Принят» |
FRAUDDENY | Отвергнут ФРОД | Документ отказан на основе проверки в АС Fraud-мониторинг, переходим в «Отвергнут банком» |
FRAUDREVIEW | На проверке у специалиста Банка | Со стороны ФРОД-анализа получен статус документа «На проверке у специалиста Банка» |
FRAUDSENT | Отправлен во ФРОД | Документ отправлен на проверку в АС Fraud-мониторинг |
FRAUDSMS | Требуется подтверждение sms-паролем | Со стороны ФРОД-анализа получен статус документа «Требуется подтверждение sms-паролем» |
PARTSIGNED | Частично подписан | ЭД подписан частью подписей, входящих в предусмотренный для данного документа комплект подписей |
PROCESSING | В обработке | Клиент сформировал «Заявление об акцепте/частичном акцепте/отказе от акцепта» |
REQUESTED_RECALL | Запрошен отзыв | Документ отозван |
SENDED_TO_PAYER | Отправлен плательщику | Документ отправлен плательщику, который является клиентом Сбербанка |
SIGNED | Подписан | ЭД подписан предусмотренным для него комплектом подписей |
SUBMITTED | Представлен | Электронный документ принят ВК |
Окончательные статусы/Прекратить опрос | ||
CHECKERROR_BANK | Ошибка контроля, Банк | ЭД сформирован, но при сохранении не прошел проверку корректности заполнения полей и сохранен с имеющимися в нем ошибками |
DECLINED_BY_PAYER | Отвергнут плательщиком | Документ отвергнут плательщиком |
INVALIDEDS | ЭПАСП не верна | Проверка ЭП под ЭД на стороне Банка дала отрицательный результат |
RECALL | Отозван | Электронный документ был отозван Клиентом по запросу |
REFUSED_BY_RZK | Отказан контролирующей организацией | ЭД не прошел проверки контролирующей организацией |
REQUISITEERROR | Ошибка реквизитов | В ЭД указаны ошибочные реквизиты |
REFUSEDBYABS | Отказан АБС | ЭД не прошел проверки в АБС |
Окончательные(Успешные) статусы/Прекратить опрос | ||
IMPLEMENTED | Исполнен | Электронный документ исполнен Банком |
SENDED_TO_PAYER | Отправлен плательщику | Документ отправлен плательщику, который не является клиентом Сбербанка |
Дополнительная информация
Параметры НДС
Для корректной работы необходимо передавать параметры в следующем сочетании :
- Если блок vat не указан, то по умолчанию будут присвоены и придут в ответе на запрос следующие значения :
"vat": {
"type": "NO_VAT",
"rate": "0",
"amount": "0.00"
}
В поле "Назначение платежа" необходимо обязательно отправлять "НДС не облагается".
При выбранном "type":"INCLUDED" (НДС включен в сумму платежа) в атрибуте "amount" необходимо указать сумму НДС. Атрибут "rate" должен принимать только значения 10, 20. В поле "Назначение платежа" необходимо обязательно указать посчитанное значение НДС. Пример ПРАВИЛЬНОГО заполнения:
НДС_10_%_-_100.63 рублей
(нижнее подчеркивание является признаком пробела, символ проставлять не нужно). Если процентное значение не указано, то дефис перед суммой указывать не нужно:НДС_100.63 рублей
.При выбранном "type":"MANUAL" (Ручной ввод НДС) атрибут "amount" указывать не обязательно, но в этом случае по умолчанию сумма НДС примет значение 0 рублей. Если же атрибут "amount" указывается в запросе, то в нем нужно указать желаемое значение НДС, соответствующее формату. Если процентное значение не указано, то дефис перед суммой указывать не нужно:
НДС_100.63 рублей
.
Коды возврата
Код возврата | Описание кода возврата | Причина возникновения | |
---|---|---|---|
200 (GET-запрос) | ОК | ||
201 (POST-запрос) | CREATED | ||
Создан Операция не завершена полностью | Документ создан, сохранен но не подписан Банком | ||
202 (POST-запрос) | SC_ACEPTED | ||
Операция не завершена полностью | Документ создан, сохранен но не подписан Банком | ||
400 | DESERIALIZATION_FAULT | ||
Неверный формат запроса | Неверный формат запроса | ||
WORKFLOW_FAULT | |||
Для внешнего сервиса недоступны операции по счету: 40702810ХХХХХХХХХХХХ | Для внешнего сервиса недоступны операции по счету: счет не добавлен в список разрешенных в оферте; внешний сервис заблокирован в СББОЛ; счет указан неверно. Отсутствует доступный открытый рублевый расчетный счет у организации плательщика | ||
Документ с такими реквизитами уже существует | Документ с такими реквизитами уже существует. Проверка по номер документа в течении года. | ||
Не указан идентификатор сертификата подписи | Не указан идентификатор сертификата подписи(параметр kid заголовка JWS) | ||
Некорректный формат параметра kid заголовка JWS | Некорректный формат параметра kid заголовка JWS(ожидается UUID) | ||
VALIDATION_FAULT | |||
Ошибка валидации | Ошибка валидации данных запроса с указанием некорректных значений. Значения полей модели или параметров запроса не соответствуют допустимым и определенным в модели. | ||
SIGN_CHECK_EXCEPTION | |||
Подлинность подписи не установлена/Сертификат не обнаружен или не является активным | Ошибка возникает, если не удалось установить подлинность подписи | ||
401 | UNAUTHORIZED | ||
accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х | Указан некорректный или просроченный access_token. | ||
403 | ACTION_ACCESS_EXCEPTION | ||
Операция не может быть выполнена: доступ к ресурсу запрещен | У пользователя нет прав на использование соответствующего сервиса SberBusinessAPI, доступ к которому не предусмотрен настройками scope; У пользователя отсутствует оферта с внешним сервисом. | ||
404 | DATA_NOT_FOUND_EXCEPTION | ||
Платежный документ не найден | Неверное значение externalId | ||
415 | JWS_EXCEPTED | ||
В соответствии с текущими настройками сервиса с clientId=%s необходимо использовать запрос в формате JWS Compact Serialization | Ошибка возникает, если в настройках внешних сервисов выставлен флаг "Требуется подпись для внешнего сервиса" | ||
500 | UNKNOWN_EXCEPTION | ||
Внутренняя ошибка сервера | |||
503 | UNAVAILABLE_RESOURCE_EXCEPTION | ||
Сервис временно недоступен | Проводятся технические работы |