ym88659208ym87991671
Сервис «Моментальные платежи» | Документация для разработчиков

Сервис «Моментальные платежи»

Обновлено 13 октября 2023

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

Моментальные платежи – сервис для создания, отправки и отслеживания платежных поручений для расчетов между юридическими лицами (ЮЛ) и индивидуальными предпринимателями (ИП).

Включает в себя следующие методы:

НаименованиеОписание
/v1/payments/from-invoiceВыставить счет клиенту (отправка на счет в Сбербанке)
v1/payments/from-invoice-anyВыставить счет клиенту (отправка на счет в любой банк)
/v1/payments/from-invoice-budgetВыставить счет клиенту (отправка в бюджет)
/v1/payments/{externalId}/stateПолучить статус платежного поручения
/v1/payments/{externalId}Получить атрибуты платежного поручения

Swagger-песочница - тестовый. При переходе на ресурс запрашивается TLS сертификат. Если сертификат не установлен или установлен некорректно, то возникнет ошибка (подробнее TLS-сертификат).

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

Важно

До начала разработки интеграции с сервисом потребуется завершить интеграцию со СберБизнес ID.

Без сервиса СберБизнес ID настроить работу "Моментальные платежи" невозможно.

Общий сценарий выставления счета клиенту

Сценарий выставление счета клиенту

Выставить счет клиенту (отправка на счет в Сбербанке)

Alt text https://fintech.sberbank.ru:9443/fintech/api/v1/payments/from-invoice

Метод /v1/payments/from-invoice позволяет выставлять клиенту счета - платежные документы с фиксированным сроком действия, в которых клиент не имеет возможности изменить сумму оплаты и реквизиты получателя. На основании выставленных счетов формируются платежные поручения. Отправление денежных средств с помощью ресурса возможно только на счет Сбербанка и только на счет, который принадлежит .

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

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

Request

/v1/payments/from-invoice

НаименованиеТипОбязательностьОписание
Параметры заголовка
AuthorizationstringобязательноеAccess token организации-клиента, полученный через SSO.
Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1
Параметры тела запроса
Invoice {
   amountnumberобязательноеСумма платежа,
   datestringобязательноеДата составления документа,
   deliveryKindstringнеобязательноеВид платежа: электронно, срочно
Если не заполнено или 0, то будет присвоено значение "электронно",
   expirationDatestringнеобязательноеДата истечения заказа (платеж должен быть подтвержден клиентом),
   externalIdstringобязательноеИдентификатор документа, присвоенный партнером (UUID),
   linkedDocsArray[LinkedDoc]необязательноеСвязанные документы,
   operationCodestringнеобязательноеКод операции,
   orderNumberstringнеобязательноеНомер заказа,
   payeeAccountstringобязательноеСчет получателя платежа,
   payeeOrgIdHashstringнеобязательноеИдентификатор получателя платежа,
   paymentNumberstringнеобязательноеНомер платежного поручения.
Обратите внимание: номер документа должен быть не более 6 цифр
Если клиент не ведет в своей учетной системе нумерацию платежных поручений, созданных на основании выставленных счетов, то атрибут можно не передавать, он будет присвоен автоматически,
   prioritystringнеобязательноеОчередность платежа,
   purposestringобязательноеНазначение платежа
Размерность: [1 .. 210],
   urgencyCodestringнеобязательноеКод срочности = [INTERNAL - срочный, INTERNAL_NOTIF - срочный платеж с уведомлением,
OFFHOURS - неотложный, BESP - банковские электронные срочные платежи, NORMAL - срочность не указана]
stringEnum : 0, 1, 2, 3, 4,
   vatvatнеобязательноеДанные НДС
}
LinkedDoc {
   docExtIdstringнеобязательноеИдентификатор документа (заявления на страхование экспортного контракта) во внешней системе (UUID), к которому необходимо привязать платежное поручение,
   typestringнеобязательноеТип связанного документа (доступное значение для заполнения - exportContractInsure), с которым необходимо связать платежное поручение
}
Vat {
   amountnumberнеобязательноеСумма НДС,
   ratestringнеобязательноеСтавка НДС,
   typestringобязательноеСпособ расчета НДС = [INCLUDED - НДС включен в сумму платежа, NO_VAT - не облагается НДС, MANUAL - ручной ввод НДС]
stringEnum: 0, 2,3
}

Responses

201 (Создан)

НаименованиеТипОбязательностьОписание
Payment {
   amountnumberобязательноеСумма платежа,
   bankCommentstringнеобязательноеБанковский комментарий к статусу документа,
   bankStatusstringнеобязательноеСтатус документа,
   crucialFieldsHashstringнеобязательноеHash от ключевых полей документа,
   datestringобязательноеДата составления документа,
   deliveryKindstringнеобязательноеВид платежа,
   departmentalInfoDepartmentalInfoнеобязательноеРеквизиты налогового, таможенного или иного бюджетного платежа,
   digestSignaturesArray[Signature]необязательноеЭлектронные подписи по дайджесту документа,
   externalIdstringобязательноеИдентификатор документа, присвоенный партнером (UUID),
   incomeTypeCodestringнеобязательноеКод вида дохода получателей выплаты по 229-ФЗ,
   numberstringнеобязательноеНомер документа,
   operationCodestringобязательноеКод операции,
   payeeAccountstringнеобязательноеСчет получателя платежа,
   payeeBankBicstringобязательноеБИК получателя платежа,
   payeeBankCorrAccountstringнеобязательноеКорсчет банка получателя платежа,
   payeeInnstringнеобязательноеИНН получателя платежа,
   payeeKppstringнеобязательноеКПП получателя платежа,
   payeeNamestringобязательноеПолное наименование получателя платежа,
   payerAccountstringобязательноеСчет плательщика,
   payerBankBicstringобязательноеБИК банка плательщика,
   payerBankCorrAccountstringобязательноеКорсчет банка плательщика,
   payerInnstringобязательноеИНН плательщика,
   payerKppstringнеобязательноеКПП плательщика,
   payerNamestringобязательноеПолное наименование плательщика,
   prioritystringобязательноеОчередность платежа,
   purposestringобязательноеНазначение платежа,
   urgencyCodestringнеобязательноеКод срочности = ['INTERNAL', 'INTERNAL_NOTIF', 'OFFHOURS', 'BESP', 'NORMAL'],
   vatvatнеобязательноеДанные НДС,
   voCodestringнеобязательноеКод вида валютной операции
}
DepartmentalInfo {
   uipstringобязательноеУникальный идентификатор платежа,
   drawerStatus101stringобязательноеПоказатель статуса налогоплательщика (реквизит - 101),
   kbkstringобязательноеКод бюджетной классификации (реквизит - 104),
   oktmostringобязательноеКод OKTMO (реквизит - 105),
   reasonCode106stringобязательноеПоказатель основания платежа (реквизит - 106),
   taxPeriod107stringобязательноеНалоговый период / код таможенного органа (реквизит - 107),
   docNumber108stringобязательноеНомер налогового документа (реквизит - 108),
   docDate109stringобязательноеДата налогового документа (реквизит - 109),
   paymentKind110stringнеобязательноеТип налогового платежа (реквизит - 110)
}
Signature {
   base64EncodedstringобязательноеЗначение электронной подписи, закодированное в Base64,
   certificateUuidstringобязательноеУникальный идентификатор сертификата ключа проверки электронной подписи (UUID),
}
Vat {
   amountnumberнеобязательноеСумма НДС,
   ratestringнеобязательноеСтавка НДС,
   typestringобязательноеСпособ расчета НДС = ['INCLUDED', 'ONTOP', 'NO_VAT', 'MANUAL']
}

400 (Ошибка в запросе или его жизненном цикле)

Наименование ошибкиОписание ошибки
DESERIALIZATION_FAULTНеверный формат запроса
WORKFLOW_FAULTНе найдена организация получателя по payeeOrgIdHash: <значение payeeOrgIdHash>
Невозможно идентифицировать организацию плательщика
Невозможно идентифицировать банк плательщика по указанным номеру БИК и корреспондентскому счету
Невозможно идентифицировать банк получателя по указанным номеру БИК и корреспондентскому счету
Документ с таким externalId уже существует в системе
VALIDATION_FAULTОшибка валидации
НаименованиеТипОбязательностьОписание
Параметры тела
ResourceFault {
   referenceIdstringнеобязательноеУникальный идентификатор ошибки (UUID),
   messagestringнеобязательноеСообщение,
   checksArray[Check]необязательноеСписок проверок, приведших к ошибке,
   fieldNamesArray[string]необязательноеНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
   levelstringнеобязательноеУровень результата \= ['ERROR', 'WARNING'],
   messagestringнеобязательноеСообщение,
   fieldsArray[string]необязательноеНазвания полей (при наличии связи с моделью)
}

401 (Не авторизован)

Наименование ошибкиОписание ошибки
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

403 (Запрещено)

Наименование ошибкиОписание ошибки
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещен
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

500 (Внутренняя ошибка сервера)

Наименование ошибкиОписание ошибки
UNKNOWN_EXCEPTIONВнутренняя ошибка сервера
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

503 (Сервис временно недоступен)

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

Usecase

Сценарий "Выставить счет клиенту (отправка на счет в Сбербанке)

Участники usecase

  • Клиент - представитель ЮЛ/ИП, который от лица своей компании приобретает услуги или товары ;

  • Сервис - любой web-ресурс (интернет-магазин, мобильное приложение и т.д.), который использует в рамках клиентского пути Клиентов;

  • СберБизнес ID - единая учетная запись пользователя юридического лица, используемая для регистрации и входа пользователей в продукты и сервисы Банка и партнеров SberBusinessAPI;

  • Банк - в контексте данного usecase представляет из себя ресурсы SberBusinessAPI, к которым обращается , и СберБизнес, на который переадресовывают Клиента для проведения оплаты.

Предусловия

  • Клиент имеет пользовательский профиль в СберБизнес своей компании с правом подписи;

  • Клиент находится в Сервисе.

Постусловия

  • Подписано платежное поручение на оплату услуг или товаров
Кейс 1

Выставить счет клиенту (отправка на счет в любой банк)

Alt text https://fintech.sberbank.ru:9443/fintech/api/v1/payments/from-invoice-any

Метод /v1/payments/from-invoice-any позволяет выставлять счет на оплату в адрес клиентов Сбербанка. Получение денежных средств возможно на счета сторонних банков. В качестве получателя денежных средств может выступать организация, отличная от . На основании выставленных счетов формируются платежные поручения.

Для создания счета на оплату необходимо отправить POST-запрос (/v1/payments/from-invoice-any), в котором передать токен доступа для получения доступа к данным клиента (Access Token) и реквизитный состав счета. Авторизационный токен передается в параметре Authorization заголовка запроса.

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

Request

/v1/payments/from-invoice

НаименованиеТипОбязательностьОписание
Параметры заголовка
Authorization (String)stringобязательноеAccess token организации-клиента, полученный через SSO
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры тела запроса
InvoiceAny {
   amountnumberобязательноеСумма платежа,
   creditContractNumberstringнеобязательноеНомер кредитного договора,
   datestringобязательноеДата составления документа,
   deliveryKindstringнеобязательноеВид платежа: электронно, срочно
Если не заполнено или 0, то будет присвоено значение "электронно",
   expirationDatestringнеобязательноеДата истечения заказа (платеж должен быть подтвержден клиентом),
   externalIdstringобязательноеИдентификатор документа, присвоенный партнером (UUID),
   isPaidByCreditbooleanнеобязательноеПризнак того, что платежное поручение будет оплачено за счет кредитных средств,
   linkedDocsArray[LinkedDoc]необязательноеСвязанные документы,
   operationCodestringнеобязательноеКод операции,
   orderNumberstringнеобязательноеНомер заказа,
   payeeAccountstringобязательноеСчет получателя платежа,
   payeeBankBicstringобязательноеБИК банка получателя платежа,
   payeeBankCorrAccountstringнеобязательноеКор. счет банка получателя платежа,
   payeeInnstringобязательноеИНН получателя платежа,
   payeeKppstringнеобязательноеКПП получателя платежа,
   payeeNamestringобязательноеНаименование получателя платежа,
   paymentNumberstringнеобязательноеНомер платежного поручения
Обратите внимание: номер документа должен быть не более 6 цифр,
   prioritystringнеобязательноеОчередность платежа,
   purposestringобязательноеНазначение платежа
Размерность: [1 .. 210],
   urgencyCodestringнеобязательноеКод срочности = [INTERNALINTERNAL_NOTIFOFFHOURSBESPNORMAL]
stringEnum : 0, 1, 2, 3, 4,
   vatvatнеобязательноеДанные НДС
}
LinkedDoc {
   docExtIdstringнеобязательноеИдентификатор документа (заявления на страхование экспортного контракта) во внешней системе (UUID), к которому необходимо привязать платежное поручение,
   typestringнеобязательноеТип связанного документа (доступное значение для заполнения - exportContractInsure), с которым необходимо связать платежное поручение
}
Vat {
   amountnumberнеобязательноеСумма НДС,
   ratestringнеобязательноеСтавка НДС,
   typestringобязательноеСпособ расчета НДС = [INCLUDEDONTOPNO_VATMANUAL]
}

Responses

201 (Создан)

НаименованиеТипОбязательностьОписание
Payment {
   amountnumberобязательноеСумма платежа,
   bankCommentstringнеобязательноеБанковский комментарий к статусу документа,
   bankStatusstringнеобязательноеСтатус документа,
   crucialFieldsHashstringнеобязательноеHash от ключевых полей документа,
   datestringобязательноеДата составления документа,
   deliveryKindstringнеобязательноеВид платежа,
   departmentalInfoDepartmentalInfoнеобязательноеРеквизиты налогового, таможенного или иного бюджетного платежа,
   digestSignaturesArray[Signature]необязательноеЭлектронные подписи по дайджесту документа,
   externalIdstringобязательноеИдентификатор документа, присвоенный партнером (UUID),
   incomeTypeCodestringнеобязательноеКод вида дохода получателей выплаты по 229-ФЗ,
   numberstringнеобязательноеНомер документа,
   operationCodestringобязательноеКод операции,
   payeeAccountstringнеобязательноеСчет получателя платежа,
   payeeBankBicstringобязательноеБИК получателя платежа,
   payeeBankCorrAccountstringнеобязательноеКорсчет банка получателя платежа,
   payeeInnstringнеобязательноеИНН получателя платежа,
   payeeKppstringнеобязательноеКПП получателя платежа,
   payeeNamestringобязательноеПолное наименование получателя платежа,
   payerAccountstringобязательноеСчет плательщика,
   payerBankBicstringобязательноеБИК банка плательщика,
   payerBankCorrAccountstringобязательноеКорсчет банка плательщика,
   payerInnstringобязательноеИНН плательщика,
   payerKppstringнеобязательноеКПП плательщика,
   payerNamestringобязательноеПолное наименование плательщика,
   prioritystringобязательноеОчередность платежа,
   purposestringобязательноеНазначение платежа,
   urgencyCodestringнеобязательноеКод срочности \= ['INTERNAL', 'INTERNAL_NOTIF', 'OFFHOURS', 'BESP', 'NORMAL'],
   vatvatнеобязательноеДанные НДС,
   voCodestringнеобязательноеКод вида валютной операции
}
DepartmentalInfo {
   uipstringобязательноеУникальный идентификатор платежа,
   drawerStatus101stringобязательноеПоказатель статуса налогоплательщика (реквизит - 101),
   kbkstringобязательноеКод бюджетной классификации (реквизит - 104),
   oktmostringобязательноеКод OKTMO (реквизит - 105),
   reasonCode106stringобязательноеПоказатель основания платежа (реквизит - 106),
   taxPeriod107stringобязательноеНалоговый период / код таможенного органа (реквизит - 107),
   docNumber108stringобязательноеНомер налогового документа (реквизит - 108),
   docDate109stringобязательноеДата налогового документа (реквизит - 109),
   paymentKind110stringнеобязательноеТип налогового платежа (реквизит - 110)
}
Signature {
   base64EncodedstringобязательноеЗначение электронной подписи, закодированное в Base64,
   certificateUuidstringобязательноеУникальный идентификатор сертификата ключа проверки электронной подписи (UUID),
}
Vat {
   amountnumberнеобязательноеСумма НДС,
   ratestringнеобязательноеСтавка НДС,
   typestringобязательноеСпособ расчета НДС \= ['INCLUDED', 'ONTOP', 'NO_VAT', 'MANUAL']
}

400 (Ошибка в запросе или его жизненном цикле)

Наименование ошибкиОписание ошибки
DESERIALIZATION_FAULTНеверный формат запроса
WORKFLOW_FAULTНе найдена организация получателя по payeeOrgIdHash: <значение payeeOrgIdHash>
Невозможно идентифицировать организацию плательщика
Невозможно идентифицировать банк плательщика по указанным номеру БИК и корреспондентскому счету
Невозможно идентифицировать банк получателя по указанным номеру БИК и корреспондентскому счету
Документ с таким externalId уже существует в системе
VALIDATION_FAULTОшибка валидации
Для договора № <номер договора> отсутствует действующая возобновляемая кредитная линия
НаименованиеТипОбязательностьОписание
Параметры тела
ResourceFault {
   referenceIdstringнеобязательноеУникальный идентификатор ошибки (UUID),
   messagestringнеобязательноеСообщение,
   checksArray[Check]необязательноеСписок проверок, приведших к ошибке,
   fieldNamesArray[string]необязательноеНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
   levelstringнеобязательноеУровень результата \= ['ERROR', 'WARNING'],
   messagestringнеобязательноеСообщение,
   fieldsArray[string]необязательноеНазвания полей (при наличии связи с моделью)
}

401 (Не авторизован)

Наименование ошибкиОписание ошибки
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

403 (Запрещено)

Наименование ошибкиОписание ошибки
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещен
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

500 (Внутренняя ошибка сервера)

Наименование ошибкиОписание ошибки
UNKNOWN_EXCEPTIONВнутренняя ошибка сервера
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

503 (Сервис временно недоступен)

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

Usecase

Сценарий "Выставить счет клиенту (отправка на счет в любой банк)"

Участники usecase

Клиент - представитель ЮЛ/ИП, который от лица своей компании приобретает услуги или товары ;

Сервис - любой web-ресурс (интернет-магазин, мобильное приложение и т.д.), который использует в рамках клиентского пути Клиентов;

СберБизнес ID - единая учетная запись пользователя юридического лица, используемая для регистрации и входа пользователей в продукты и сервисы Банка и партнеров SberBusinessAPI;

Банк - в контексте данного usecase представляет из себя ресурсы SberBusinessAPI, к которым обращается , и СберБизнес, на который переадресовывают Клиента для проведения оплаты.

Предусловия

  • Клиент имеет пользовательский профиль в СберБизнес своей компании с правом подписи;

  • Клиент находится в Сервисе.

Постусловия

  • Подписано платежное поручение на оплату услуг или товаров
Кейс 2

Выставить счет клиенту (отправка в бюджет)

Alt text https://fintech.sberbank.ru:9443/fintech/api/v1/payments/from-invoice-budget

Метод v1/payments/from-invoice-budget позволяет выставлять счет в бюджет, с целью предоставить клиентам сервис по оплате налоговых платежей. На основании выставленных счетов формируются платежные поручения. Метод позволяет выставлять счет на оплату в адрес клиентов как Сбербанка, так и любого другого банка.

Для создания счета в бюджет необходимо отправить POST-запрос (/v1/payments/from-invoice-budget), в котором передать токен доступа для получения доступа к данным клиента (Access Token) и реквизитный состав счета. Авторизационный токен передается в параметре Authorization заголовка запроса.

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

Request

/v1/payments/from-invoice-budget

НаименованиеТипОбязательностьОписание
Параметры заголовка
AuthorizationstringобязательноеAccess token организации-клиента, полученный через SSO
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры тела запроса
InvoiceBudget {
   amountnumberобязательноеСумма платежа,
   datestringобязательноеДата составления документа,
   deliveryKindstringнеобязательноеВид платежа: электронно, срочно
Если не заполнено или 0, то будет присвоено значение "электронно",
   departmentalInfoDepartmentalInfoобязательноеРеквизиты налогового, таможенного или иного бюджетного платежа,
   externalIdstringобязательноеИдентификатор документа, присвоенный партнером (UUID),
   operationCodestringнеобязательноеКод операции,
   payeeAccountstringобязательноеСчет получателя платежа,
   payeeBankBicstringобязательноеБИК банка получателя платежа,
   payeeBankCorrAccountstringнеобязательноеКор. счет банка получателя платежа,
   payeeInnstringобязательноеИНН получателя платежа,
   payeeKppstringнеобязательноеКПП получателя платежа,
   payeeNamestringобязательноеНаименование получателя платежа,
   payerKppstringнеобязательноеКПП плательщика.<br //>Если плательщик - ИП, то заполнять значением "0",
   paymentNumberstringнеобязательноеНомер платежного поручения.
Обратите внимание: номер документа должен быть не более 6 цифр
Если клиент не ведет в своей учетной системе нумерацию платежных поручений, созданных на основании выставленных счетов, то атрибут можно не передавать, он будет присвоен автоматически,
   prioritystringнеобязательноеОчередность платежа,
   purposestringобязательноеНазначение платежа
Размерность: [1 .. 210],
   urgencyCodestringнеобязательноеКод срочности = [INTERNAL - срочный, INTERNAL_NOTIF - срочный платеж с уведомлением OFFHOURS - неотложный, BESP - банковские электронные срочные платежи, NORMAL - срочность не указана]
stringEnum: 0, 1, 2, 3, 4,
   vatvatнеобязательноеДанные НДС
}
DepartmentalInfo {Реквизиты налогового, таможенного или иного бюджетного платежа,
   uipstringобязательноеУникальный идентификатор платежа,
   drawerStatus101stringобязательноеПоказатель статуса налогоплательщика (реквизит - 101),
   kbkstringобязательноеКод бюджетной классификации (реквизит - 104),
   oktmostringобязательноеКод OKTMO (реквизит - 105),
   reasonCode106stringобязательноеПоказатель основания платежа (реквизит - 106),
   taxPeriod107stringобязательноеНалоговый период / код таможенного органа (реквизит - 107),
   docNumber108stringобязательноеНомер налогового документа (реквизит - 108),
   docDate109stringобязательноеДата налогового документа (реквизит - 109),
   paymentKind110stringобязательноеТип налогового платежа (реквизит - 110)
}
LinkedDoc {
   docExtIdstringнеобязательноеИдентификатор документа (заявления на страхование экспортного контракта) во внешней системе (UUID), к которому необходимо привязать платежное поручение,
   typestringнеобязательноеТип связанного документа (доступное значение для заполнения - exportContractInsure), с которым необходимо связать платежное поручение
}
Vat {
   amountnumberобязательноеСумма НДС,
   ratestringобязательноеСтавка НДС,
   typestringобязательноеСпособ расчета НДС = [INCLUDEDONTOPNO_VATMANUAL]
stringEnum: 0,2,3

Responses

201 (Создан)

НаименованиеТипОбязательностьОписание
Payment {
   amountnumberобязательноеСумма платежа,
   bankCommentstringнеобязательноеБанковский комментарий к статусу документа,
   bankStatusstringнеобязательноеСтатус документа,
   crucialFieldsHashstringнеобязательноеHash от ключевых полей документа,
   datestringобязательноеДата составления документа,
   deliveryKindstringнеобязательноеВид платежа,
   departmentalInfoDepartmentalInfoнеобязательноеРеквизиты налогового, таможенного или иного бюджетного платежа,
   digestSignaturesArray[Signature]необязательноеЭлектронные подписи по дайджесту документа,
   externalIdstringобязательноеИдентификатор документа, присвоенный партнером (UUID),
   incomeTypeCodestringнеобязательноеКод вида дохода получателей выплаты по 229-ФЗ,
   numberstringнеобязательноеНомер документа,
   operationCodestringобязательноеКод операции,
   payeeAccountstringнеобязательноеСчет получателя платежа,
   payeeBankBicstringобязательноеБИК получателя платежа,
   payeeBankCorrAccountstringнеобязательноеКорсчет банка получателя платежа,
   payeeInnstringнеобязательноеИНН получателя платежа,
   payeeKppstringнеобязательноеКПП получателя платежа,
   payeeNamestringобязательноеПолное наименование получателя платежа,
   payerAccountstringобязательноеСчет плательщика,
   payerBankBicstringобязательноеБИК банка плательщика,
   payerBankCorrAccountstringобязательноеКорсчет банка плательщика,
   payerInnstringобязательноеИНН плательщика,
   payerKppstringнеобязательноеКПП плательщика,
   payerNamestringобязательноеПолное наименование плательщика,
   prioritystringобязательноеОчередность платежа,
   purposestringобязательноеНазначение платежа,
   urgencyCodestringнеобязательноеКод срочности = [INTERNAL, INTERNAL_NOTIF, OFFHOURS, BESP, NORMAL],
   vatvatнеобязательноеДанные НДС,
   voCodestringнеобязательноеКод вида валютной операции
}
DepartmentalInfo {
   uipstringобязательноеУникальный идентификатор платежа,
   drawerStatus101stringобязательноеПоказатель статуса налогоплательщика (реквизит - 101),
   kbkstringобязательноеКод бюджетной классификации (реквизит - 104),
   oktmostringобязательноеКод OKTMO (реквизит - 105),
   reasonCode106stringобязательноеПоказатель основания платежа (реквизит - 106),
   taxPeriod107stringобязательноеНалоговый период / код таможенного органа (реквизит - 107),
   docNumber108stringобязательноеНомер налогового документа (реквизит - 108),
   docDate109stringобязательноеДата налогового документа (реквизит - 109),
   paymentKind110stringнеобязательноеТип налогового платежа (реквизит - 110)
}
Signature {
   base64EncodedstringобязательноеЗначение электронной подписи, закодированное в Base64,
   certificateUuidstringобязательноеУникальный идентификатор сертификата ключа проверки электронной подписи (UUID),
}
Vat {
   amountnumberнеобязательноеСумма НДС,
   ratestringнеобязательноеСтавка НДС,
   typestringобязательноеСпособ расчета НДС = [INCLUDED, ONTOP, NO_VAT, MANUAL]
}

400 (Ошибка в запросе или его жизненном цикле)

Наименование ошибкиОписание ошибки
DESERIALIZATION_FAULTНеверный формат запроса
WORKFLOW_FAULTНе найдена организация получателя по payeeOrgIdHash: <значение payeeOrgIdHash>
Невозможно идентифицировать организацию плательщика
Невозможно идентифицировать банк плательщика по указанным номеру БИК и корреспондентскому счету
Невозможно идентифицировать банк получателя по указанным номеру БИК и корреспондентскому счету
Документ с таким externalId уже существует в системе
VALIDATION_FAULTОшибка валидации
Для договора № <номер договора> отсутствует действующая возобновляемая кредитная линия
НаименованиеТипОбязательностьОписание
Параметры тела
ResourceFault {
   referenceIdstringнеобязательноеУникальный идентификатор ошибки (UUID),
   messagestringнеобязательноеСообщение,
   checksArray[Check]необязательноеСписок проверок, приведших к ошибке,
   fieldNamesArray[string]необязательноеНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
   levelstringнеобязательноеУровень результата \= ['ERROR', 'WARNING'],
   messagestringнеобязательноеСообщение,
   fieldsArray[string]необязательноеНазвания полей (при наличии связи с моделью)
}

401 (Не авторизован)

Наименование ошибкиОписание ошибки
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

403 (Запрещено)

Наименование ошибкиОписание ошибки
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещен
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

500 (Внутренняя ошибка сервера)

Наименование ошибкиОписание ошибки
UNKNOWN_EXCEPTIONВнутренняя ошибка сервера
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

503 (Сервис временно недоступен)

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

Usecase

Сценарий "Выставление счета клиенту (отправка в бюджет)"

Участники usecase

Клиент - представитель ЮЛ/ИП, который от лица своей компании хочет сделать оплату в пользу бюджетной организации через Сервис ;

Сервис - любой web-ресурс (интернет-магазин, мобильное приложение и т.д.), который использует в рамках клиентского пути Клиентов;

СберБизнес ID - единая учетная запись пользователя юридического лица, используемая для регистрации и входа пользователей в продукты и сервисы Банка и партнеров SberBusinessAPI;

Банк - в контексте данного usecase представляет из себя ресурсы SberBusinessAPI, к которым обращается , и СберБизнес, на который переадресовывают Клиента для проведения оплаты.

Предусловия

  • Клиент имеет пользовательский профиль в СберБизнес своей компании с правом подписи;

  • Клиент находится в Сервисе.

Постусловия

  • Подписано платежное поручение в пользу бюджетной организации
Кейс 3

Получить статус платежного поручения

Alt text fintech/api/v1/payments/{externalId}/state

Метод /v1/payments/{externalId}/state позволяет получить статус ранее сформированного черновика платежного поручения. В случае, если у Клиента отключена/истек срок соглашения услуги на формирование платежных поручений, организация предоставляющая сервис, может получить статус готовых документов.

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

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

Request

/v1/payments/{externalId}/state

НаименованиеТипОбязательностьОписание
Параметры заголовка
AuthorizationStringобязательноеAccess token организации-клиента полученный через SSO
Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1
Параметры запроса
externalIdStringобязательноеИдентификатор документа, присвоенный клиентом

Responses

200 (ОК)

НаименованиеТипОбязательностьОписание
Payment {
   amount (number)numberобязательноеСумма платежа,
   bankComment (read only)stringнеобязательноеБанковский комментарий к статусу документа,
   bankStatus (read only)stringнеобязательноеСтатус документа,
   crucialFieldsHashstringнеобязательноеHash от ключевых полей документа,
   datestringобязательноеДата составления документа,
   deliveryKindstringнеобязательноеВид платежа,
   departmentalInfoDepartmentalInfoнеобязательноеРеквизиты налогового, таможенного или иного бюджетного платежа,
   digestSignaturesArray[Signature]необязательноеЭлектронные подписи по дайджесту документа,
   externalIdstringобязательноеИдентификатор документа, присвоенный партнером (UUID),
   incomeTypeCodestringнеобязательноеКод вида дохода получателей выплаты по 229-ФЗ,
   numberstringнеобязательноеНомер документа,
   operationCodestringобязательноеКод операции,
   payeeAccountstringнеобязательноеСчет получателя платежа,
   payeeBankBicstringобязательноеБИК получателя платежа,
   payeeBankCorrAccountstringнеобязательноеКорсчет банка получателя платежа,
   payeeInnstringнеобязательноеИНН получателя платежа,
   payeeKppstringнеобязательноеКПП получателя платежа,
   payeeNamestringобязательноеПолное наименование получателя платежа
   payerAccountstringобязательноеСчет плательщика.
   payerBankBicstringобязательноеБИК банка плательщика,
   payerBankCorrAccountstringобязательноеКорсчет банка плательщика,
   payerInnstringобязательноеИНН плательщика
   payerKppstringнеобязательноеКПП плательщика,
   payerNamestringобязательноеПолное наименование плательщика,
   prioritystringобязательноеОчередность платежа,
   purposestringобязательноеНазначение платежа,
   urgencyCodestringнеобязательноеКод срочности = [INTERNAL, INTERNAL_NOTIF, OFFHOURS, BESP, NORMAL],
   vatvatнеобязательноеДанные НДС,
   voCodestringнеобязательноеКод вида валютной операции
}
DepartmentalInfo {
   uipstringобязательноеУникальный идентификатор платежа,
   drawerStatus101stringобязательноеПоказатель статуса налогоплательщика (реквизит - 101),
   kbkstringобязательноеКод бюджетной классификации (реквизит - 104),
   oktmostringобязательноеКод OKTMO (реквизит - 105),
   reasonCode106stringобязательноеПоказатель основания платежа (реквизит - 106),
   taxPeriod107stringобязательноеНалоговый период / код таможенного органа (реквизит - 107),
   docNumber108stringобязательноеНомер налогового документа (реквизит - 108),
   docDate109stringобязательноеДата налогового документа (реквизит - 109),
   paymentKind11Тип налогового платежа (реквизит - 110)
}
Signature {
   base64EncodedstringобязательноеЗначение электронной подписи, закодированное в Base64,
   certificateUuidstringобязательноеУникальный идентификатор сертификата ключа проверки электронной подписи (UUID)
}
Vat {
   amountnumberнеобязательноеСумма НДС,
   ratestringнеобязательноеСтавка НДС,
   typestringобязательноеСпособ расчета НДС
[INCLUDED, ONTOP, NO_VAT, MANUAL]
}

400 (Ошибка в запросе или его жизненном цикле)

| DESERIALIZATION_FAULT | Неверный формат запроса | | VALIDATION_FAULT | Ошибка валидации |

НаименованиеТипОбязательностьОписание
Параметры тела
ResourceFault {
   referenceIdstringнеобязательноеУникальный идентификатор ошибки (UUID)
   messagestringнеобязательноеСообщение
   checksArray[Check]необязательноеСписок проверок, приведших к ошибке
   fieldNamesArray[string]необязательноеНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
   levelstringнеобязательноеУровень результата = [ERROR, WARNING]
   messagestringнеобязательноеСообщение
   fieldsArray[string]необязательноеНазвания полей (при наличии связи с моделью)
}

401 (Не авторизован)

Наименование ошибкиОписание ошибки
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

403 (Запрещено)

Наименование ошибкиОписание ошибки
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещен
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

500 (Внутренняя ошибка сервера)

Наименование ошибкиОписание ошибки
UNKNOWN_EXCEPTIONВнутренняя ошибка сервера
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

503 (Сервис временно недоступен)

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

Статусы платежных поручений

bankStatus (string)

Код состояние документаНаименование статусаНазначение кода состояния
Промежуточный/Продолжать опрашивать
ACCEPTEDПринятЭлектронный документ принят на стороне Банка
ACCEPTED_BY_ABSПринят АБС или
Принят
Электронный документ был принят к обработке в АБС Банка
CARD2Картотека 2 или
Ожидает оплаты
АБС обнаружено, что на счете плательщика недостаточно средств для иcполнения документа
CREATEDСозданДокумент записан в БД, проверки не выполнялись
CHECKERRORОшибка контроляЭД сформирован, но при сохранении не прошел проверку корректности заполнения полей и сохранен с имеющимися в нем ошибками
DELAYEDПриостановленОбработка электронного документа была приостановлена
DELIVEREDДоставленЗапрос доставлен в ДБО и взят в обработку
DELIVERED_RZKДоставлен в СБКЭлектронный документ отправлен в СБК и получен квиток о доставке
FRAUDALLOWОдобрен ФРОДПроверка во ФРОДЕ прошла успешно, переход на «Принят»
FRAUDDENYОтвергнут ФРОДДокумент отказан на основе проверки в АС Fraud-мониторинг, переходим в «Отвергнут банком»
FRAUDREVIEWНа проверке у специалиста БанкаСо стороны ФРОД-анализа получен статус документа «На проверке у специалиста Банка»
FRAUDSENTОтправлен во ФРОДДокумент отправлен на проверку в АС Fraud-мониторинг
FRAUDSMSТребуется подтверждение sms-паролемСо стороны ФРОД-анализа получен статус документа «Требуется подтверждение sms-паролем»
NOT_ACCEPTED_RZKНе принят СБКЭлектронный документ не прошел логические контроли СБК
PARTSIGNEDЧастично подписанЭД подписан частью подписей, входящих в предусмотренный для данного документа комплект подписей
PROCESSING_RZKОбрабатывается СБКЭД успешно прошел проверки ЭП и логические проверки СБК
REQUESTED_RECALLЗапрошен отзывДокумент отозван
RZK_SIGN_ERRORОшибка ЭП СБКПроверка подписи под ЭД на стороне СБК дала отрицательный результат
SENDING_TO_RZKОтправляется в СБКЭлектронный документ отправлен в СБК, но не получен квиток о доставке
SIGNEDПодписанЭД подписан предусмотренным для него комплектом подписей.
TO_PROCESSING_RZKК отправке в СБКЭД подписан предусмотренным для него комплектом о доставке
Окончательный (Не успешный)/Прекратить опрос
DELETEDУдаленЭлектронный документа удален из числа действующих документов
INVALIDEDSЭП/АСП не верна
Подпись неверна
Проверка ЭП под ЭД на стороне Банка дала отрицательный результат
RECALLОтозванЭлектронный документ был отозван Клиентом по запросу
REFUSEDBYBANKОтвергнут банком или
Отклонен банком
Электронный документ отвергнут банком
REFUSEDBYABSОтказан АБСЭлектронный документ не прошел проверки в АБС
REQUISITEERRORОшибка реквизитовВ ЭД указаны ошибочные реквизиты
REFUSED_BY_RZKОтказан контролирующей организациейЭлектронный документ не прошел проверки контролирующей организацией
Окончательный (Успешный)/Прекратить опрос
IMPLEMENTEDИсполненЭлектронный документ исполнен Банком

Получить атрибуты поручения

Alt text https://fintech.sberbank.ru:9443/fintech/api/v1/payments/{externalId}

Метод /v1/payments/{externalId} позволяет получить атрибуты ранее сформированного черновика платежного поручения.

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

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

Request

/v1/payments/{externalId}

НаименованиеТипОбязательностьОписание
Параметры заголовка
AuthorizationStringобязательноеAccess token организации-клиента полученный через SSO
Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1
Параметры запроса
externalIdStringобязательноеИдентификатор документа, присвоенный клиентом

Responses

200 (ОК)

НаименованиеТипОбязательностьОписание
Payment {
   amount (number)numberобязательноеСумма платежа,
   bankComment (read only)stringнеобязательноеБанковский комментарий к статусу документа,
   bankStatus (read only)stringнеобязательноеСтатус документа,
   crucialFieldsHashstringнеобязательноеHash от ключевых полей документа,
   datestringобязательноеДата составления документа,
   deliveryKindstringнеобязательноеВид платежа,
   departmentalInfoDepartmentalInfoнеобязательноеРеквизиты налогового, таможенного или иного бюджетного платежа,
   digestSignaturesArray[Signature]необязательноеЭлектронные подписи по дайджесту документа,
   externalIdstringобязательноеИдентификатор документа, присвоенный партнером (UUID),
   incomeTypeCodestringнеобязательноеКод вида дохода получателей выплаты по 229-ФЗ,
   numberstringнеобязательноеНомер документа,
   operationCodestringобязательноеКод операции,
   payeeAccountstringнеобязательноеСчет получателя платежа,
   payeeBankBicstringобязательноеБИК получателя платежа,
   payeeBankCorrAccountstringнеобязательноеКорсчет банка получателя платежа,
   payeeInnstringнеобязательноеИНН получателя платежа,
   payeeKppstringнеобязательноеКПП получателя платежа,
   payeeNamestringобязательноеПолное наименование получателя платежа
   payerAccountstringобязательноеСчет плательщика.
   payerBankBicstringобязательноеБИК банка плательщика,
   payerBankCorrAccountstringобязательноеКорсчет банка плательщика,
   payerInnstringобязательноеИНН плательщика
   payerKppstringнеобязательноеКПП плательщика,
   payerNamestringобязательноеПолное наименование плательщика,
   prioritystringобязательноеОчередность платежа,
   purposestringобязательноеНазначение платежа,
   urgencyCodestringнеобязательноеКод срочности = [INTERNAL, INTERNAL_NOTIF, OFFHOURS, 'BESP', 'NORMAL'],
   vatvatнеобязательноеДанные НДС,
   voCodestringнеобязательноеКод вида валютной операции
}
DepartmentalInfo {
   uipstringобязательноеУникальный идентификатор платежа,
   drawerStatus101stringобязательноеПоказатель статуса налогоплательщика (реквизит - 101),
   kbkstringобязательноеКод бюджетной классификации (реквизит - 104),
   oktmostringобязательноеКод OKTMO (реквизит - 105),
   reasonCode106stringобязательноеПоказатель основания платежа (реквизит - 106),
   taxPeriod107stringобязательноеНалоговый период / код таможенного органа (реквизит - 107),
   docNumber108stringобязательноеНомер налогового документа (реквизит - 108),
   docDate109stringобязательноеДата налогового документа (реквизит - 109),
   paymentKind11Тип налогового платежа (реквизит - 110)
}
Signature {
   base64EncodedstringобязательноеЗначение электронной подписи, закодированное в Base64,
   certificateUuidstringобязательноеУникальный идентификатор сертификата ключа проверки электронной подписи (UUID)
}
Vat {
   amountnumberнеобязательноеСумма НДС,
   ratestringнеобязательноеСтавка НДС,
   typestringобязательноеСпособ расчета НДС
[INCLUDED, ONTOP, NO_VAT, MANUAL]
}

400 (Ошибка в запросе или его жизненном цикле)

| DESERIALIZATION_FAULT | Неверный формат запроса | | VALIDATION_FAULT | Ошибка валидации |

НаименованиеТипОбязательностьОписание
Параметры тела
ResourceFault {
   referenceIdstringнеобязательноеУникальный идентификатор ошибки (UUID)
   messagestringнеобязательноеСообщение
   checksArray[Check]необязательноеСписок проверок, приведших к ошибке
   fieldNamesArray[string]необязательноеНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
   levelstringнеобязательноеУровень результата = [ERROR, WARNING]
   messagestringнеобязательноеСообщение
   fieldsArray[string]необязательноеНазвания полей (при наличии связи с моделью)
}

401 (Не авторизован)

Наименование ошибкиОписание ошибки
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

403 (Запрещено)

Наименование ошибкиОписание ошибки
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещен
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

500 (Внутренняя ошибка сервера)

Наименование ошибкиОписание ошибки
UNKNOWN_EXCEPTIONВнутренняя ошибка сервера
НаименованиеТипОбязательностьОписание
Параметры тела
Notice {
   causestringнеобязательноеПричина или основание сообщения,
   referenceIdstringнеобязательноеУникальный идентификатор (UUID),
   messagestringнеобязательноеСообщение
}

503 (Сервис временно недоступен)

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

Дополнительная информация

Параметры НДС

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

  • Если блок 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 рублей.

FAQ по сервису

Какой максимальный срок жизни можно установить для платежного поручения?

Пунктами 5.5, 7.7, 9.6 Положения 383-П установлено, что платежные поручения, инкассовые поручения, платежные требования действительны для представления в банк в течение 10 календарных дней со дня их составления, то есть исчисление срока начинается на следующий день после их составления.

Дата истечения заказа устанавливается силами Партнера атрибутом expirationDate в ресурсах /v1/payments/from-invoice и /v1/payments/from-invoice-any. Крайний срок действия платежного поручения от даты его формирования не может превышать 10 календарных дней.

Как отозвать сформированный черновик платежного поручения?

Отозвать сформированный черновик платежного поручения на стороне Партнера нет технической возможности.

При использовании ресурсов "Моментальные платежи", которые создают черновики платежных поручений, черновики также появляются в СберБизнес Клиента. Через СберБизнес пользователь Клиента может самостоятельно отклонить черновик.

Как быстро Банк исполняет подписанное платежное поручение?

После подписания черновика платежного поручения Банк проводит ряд проверок. Обычно Банк исполняет подписанное платежное поручение в течение 1 минуты. В ряде случаев может потребоваться дополнительная информация от Клиента, что увеличит время исполнения документа.

Еще подробнее об исполнении и зачислении платежей в Справочном центре для бизнеса.

Откуда Банк берет реквизиты отправителя для платежного поручения?

В рамках сервиса СберБизнес ID вы реализуете механизм получения access_token. При формировании платежного поручения вы передаете с другими атрибутами access_token, по которому Банк самостоятельно в платежное поручение подставляет все реквизиты плательщика (отправителя).

Где взять access_token?

Получение access_token необходимо реализовать в рамках сервиса СберБизнес ID.

Что будет, если пользователь Клиента покинет страницу оплаты не подписав черновик платежного поручения?

При использовании ресурсов "Моментальные платежи", которые создают черновики платежных поручений, черновики также появляются в СберБизнес Клиента. Любой пользователь Клиента, который имеет право подписи черновиков платежных поручений, сможет подписать черновик.

ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.