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

Обновлено 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-сертификат).

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

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

Важно

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

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

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

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

Шаг	Что делаем	Подробности
1	Получить access_token клиента	Первые 2 шага - авторизация с помощью сервиса СберБизнес ID. Подробно о сервисе и его подключении рассказали в СберБизнес ID.
2	Получить информацию о пользователе клиента user-info
3	Сформировать черновик платежного поручения	Вариант, который следует выбрать, зависит от ваших задач. 1. Если собираетесь получать денежные средства на счет своей компании в Сбербанке, используйте метод `/v1/payments/from-invoice` 2. Если собираетесь организовать переводы, где Отправитель - любая компания со счетом в Сбербанке, а Получатель - любая компания в любом банке, используйте метод `/v1/payments/from-invoice-any` 3. Если собираетесь в своем Сервисе для клиентов разработать функциональность по оплате налоговых платежей, используйте метод `/v1/payments/from-invoice-budget`
4	Перенаправить клиента на форму оплаты	Ссылка состоит из 3-ех компонентов: 1. {адрес стенда Банка}/icdk/dcb/index.html# - адреса указаны выше для тестового и промышленного стендов; 2. /payment-creator/{externalid} - уникальный идентификатор платежного документа, который присваивает ваш Сервис на предыдущем шаге; 3. ?{backUrl} - На эту страницу Банк вернет Клиента после успешного подписания черновика платежного поручения. При передаче backUrl необходимо делать URLEncode. Параметр backUrl является необязательным и в случае его отсутствия в ссылке клиент не сможет вернуться в Cервис. Параметр backUrl должен соответствовать адресу Сервиса , указанному при регистрации в Банке.
5	Получить информацию о статусе оплаты	С помощью метод `/v1/payments/{externalId}/state` вы сможете разработать механизм проверки статуса оплаты и реакцию Сервиса на каждый из них.
6	Проверить корректность платежа	С помощью метод `/v1/payments/{externalId}` вы сможете получить все атрибуты ранее созданного платежного поручения. Эту информацию можно использовать, например, в механизме проверки корректности платежа.

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

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

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

Наименование	Тип	Обязательность	Описание
Параметры заголовка
Authorization	string	обязательное	Access token организации-клиента, полученный через SSO. Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1
Параметры тела запроса
Invoice {
amount	number	обязательное	Сумма платежа,
date	string	обязательное	Дата составления документа,
deliveryKind	string	необязательное	Вид платежа: электронно, срочно Если не заполнено или 0, то будет присвоено значение "электронно",
expirationDate	string	необязательное	Дата истечения заказа (платеж должен быть подтвержден клиентом),
externalId	string	обязательное	Идентификатор документа, присвоенный партнером (UUID),
linkedDocs	Array[LinkedDoc]	необязательное	Связанные документы,
operationCode	string	необязательное	Код операции,
orderNumber	string	необязательное	Номер заказа,
payeeAccount	string	обязательное	Счет получателя платежа,
payeeOrgIdHash	string	необязательное	Идентификатор получателя платежа,
paymentNumber	string	необязательное	Номер платежного поручения. Обратите внимание: номер документа должен быть не более 6 цифр Если клиент не ведет в своей учетной системе нумерацию платежных поручений, созданных на основании выставленных счетов, то атрибут можно не передавать, он будет присвоен автоматически,
priority	string	необязательное	Очередность платежа,
purpose	string	обязательное	Назначение платежа Размерность: [1 .. 210],
urgencyCode	string	необязательное	Код срочности = [INTERNAL - срочный, INTERNAL_NOTIF - срочный платеж с уведомлением, OFFHOURS - неотложный, BESP - банковские электронные срочные платежи, NORMAL - срочность не указана] stringEnum : 0, 1, 2, 3, 4,
vat	vat	необязательное	Данные НДС
}
LinkedDoc {
docExtId	string	необязательное	Идентификатор документа (заявления на страхование экспортного контракта) во внешней системе (UUID), к которому необходимо привязать платежное поручение,
type	string	необязательное	Тип связанного документа (доступное значение для заполнения - exportContractInsure), с которым необходимо связать платежное поручение
}
Vat {
amount	number	необязательное	Сумма НДС,
rate	string	необязательное	Ставка НДС,
type	string	обязательное	Способ расчета НДС = [INCLUDED - НДС включен в сумму платежа, NO_VAT - не облагается НДС, MANUAL - ручной ввод НДС] stringEnum: 0, 2,3
}

{
  "amount": 1.01,
  "date": "2018-12-31",
  "deliveryKind": "электронно",
  "expirationDate": "2018-12-31",
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "linkedDocs": [
    {
      "docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
      "type": "ExportContractInsure"
    }
  ],
  "operationCode": "01",
  "orderNumber": "123",
  "payeeAccount": "40802810600000200000",
  "payeeOrgIdHash": "ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5",
  "paymentNumber": "1",
  "priority": "5",
  "purpose": "Оплата заказа №123. НДС нет.",
  "urgencyCode": "INTERNAL",
  "vat": {
    "amount": 1.01,
    "rate": "10",
    "type": "NO_VAT"
  }
}

Responses

201 (Создан)

Модель
Ответ

Наименование	Тип	Обязательность	Описание
Payment {
amount	number	обязательное	Сумма платежа,
bankComment	string	необязательное	Банковский комментарий к статусу документа,
bankStatus	string	необязательное	Статус документа,
crucialFieldsHash	string	необязательное	Hash от ключевых полей документа,
date	string	обязательное	Дата составления документа,
deliveryKind	string	необязательное	Вид платежа,
departmentalInfo	DepartmentalInfo	необязательное	Реквизиты налогового, таможенного или иного бюджетного платежа,
digestSignatures	Array[Signature]	необязательное	Электронные подписи по дайджесту документа,
externalId	string	обязательное	Идентификатор документа, присвоенный партнером (UUID),
incomeTypeCode	string	необязательное	Код вида дохода получателей выплаты по 229-ФЗ,
number	string	необязательное	Номер документа,
operationCode	string	обязательное	Код операции,
payeeAccount	string	необязательное	Счет получателя платежа,
payeeBankBic	string	обязательное	БИК получателя платежа,
payeeBankCorrAccount	string	необязательное	Корсчет банка получателя платежа,
payeeInn	string	необязательное	ИНН получателя платежа,
payeeKpp	string	необязательное	КПП получателя платежа,
payeeName	string	обязательное	Полное наименование получателя платежа,
payerAccount	string	обязательное	Счет плательщика,
payerBankBic	string	обязательное	БИК банка плательщика,
payerBankCorrAccount	string	обязательное	Корсчет банка плательщика,
payerInn	string	обязательное	ИНН плательщика,
payerKpp	string	необязательное	КПП плательщика,
payerName	string	обязательное	Полное наименование плательщика,
priority	string	обязательное	Очередность платежа,
purpose	string	обязательное	Назначение платежа,
urgencyCode	string	необязательное	Код срочности = ['INTERNAL', 'INTERNAL_NOTIF', 'OFFHOURS', 'BESP', 'NORMAL'],
vat	vat	необязательное	Данные НДС,
voCode	string	необязательное	Код вида валютной операции
}
DepartmentalInfo {
uip	string	обязательное	Уникальный идентификатор платежа,
drawerStatus101	string	обязательное	Показатель статуса налогоплательщика (реквизит - 101),
kbk	string	обязательное	Код бюджетной классификации (реквизит - 104),
oktmo	string	обязательное	Код OKTMO (реквизит - 105),
reasonCode106	string	обязательное	Показатель основания платежа (реквизит - 106),
taxPeriod107	string	обязательное	Налоговый период / код таможенного органа (реквизит - 107),
docNumber108	string	обязательное	Номер налогового документа (реквизит - 108),
docDate109	string	обязательное	Дата налогового документа (реквизит - 109),
paymentKind110	string	необязательное	Тип налогового платежа (реквизит - 110)
}
Signature {
base64Encoded	string	обязательное	Значение электронной подписи, закодированное в Base64,
certificateUuid	string	обязательное	Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID),
}
Vat {
amount	number	необязательное	Сумма НДС,
rate	string	необязательное	Ставка НДС,
type	string	обязательное	Способ расчета НДС = ['INCLUDED', 'ONTOP', 'NO_VAT', 'MANUAL']
}

{
  "amount": 1.01,
  "bankComment": "string",
  "bankStatus": "string",
  "crucialFieldsHash": "string",
  "date": "2018-12-31",
  "deliveryKind": "электронно",
  "departmentalInfo": {
    "uip": "0",
    "drawerStatus101": "01",
    "kbk": "18210102010011000110",
    "oktmo": "01701000",
    "reasonCode106": "ТП",
    "taxPeriod107": "ГД.00.2018",
    "docNumber108": "123",
    "docDate109": "0",
    "paymentKind110": "1"
  },
  "digestSignatures": [
    {
      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
      "certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
    }
  ],
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "incomeTypeCode": "2",
  "number": "1",
  "operationCode": "01",
  "payeeAccount": "40802810600000200000",
  "payeeBankBic": "044525225",
  "payeeBankCorrAccount": "30101810400000000225",
  "payeeInn": "7707083893",
  "payeeKpp": "222201001",
  "payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
  "payerAccount": "40802810600000200000",
  "payerBankBic": "044525225",
  "payerBankCorrAccount": "30101810400000000225",
  "payerInn": "7707083893",
  "payerKpp": "222201001",
  "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
  "priority": "5",
  "purpose": "Оплата заказа №123. НДС нет.",
  "urgencyCode": "INTERNAL",
  "vat": {
    "amount": 1.01,
    "rate": "10",
    "type": "NO_VAT"
  },
  "voCode": "61150"
}

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

Наименование ошибки	Описание ошибки
DESERIALIZATION_FAULT	Неверный формат запроса
WORKFLOW_FAULT	Не найдена организация получателя по payeeOrgIdHash: <значение payeeOrgIdHash>
	Невозможно идентифицировать организацию плательщика
	Невозможно идентифицировать банк плательщика по указанным номеру БИК и корреспондентскому счету
	Невозможно идентифицировать банк получателя по указанным номеру БИК и корреспондентскому счету
	Документ с таким externalId уже существует в системе
VALIDATION_FAULT	Ошибка валидации

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

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

{
  "referenceId": "string",
  "message": "string",
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "fieldNames": "[\"externalId\", \"paymentNumber\"]"
}

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

Наименование ошибки	Описание ошибки
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
UNAVAILABLE_RESOURCE_EXCEPTION

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Usecase

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

Участники usecase

Клиент - представитель ЮЛ/ИП, который от лица своей компании приобретает услуги или товары ;
Сервис - любой web-ресурс (интернет-магазин, мобильное приложение и т.д.), который использует в рамках клиентского пути Клиентов;
СберБизнес ID - единая учетная запись пользователя юридического лица, используемая для регистрации и входа пользователей в продукты и сервисы Банка и партнеров SberBusinessAPI;
Банк - в контексте данного usecase представляет из себя ресурсы SberBusinessAPI, к которым обращается , и СберБизнес, на который переадресовывают Клиента для проведения оплаты.

Предусловия

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

Постусловия

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

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

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 {
amount	number	обязательное	Сумма платежа,
creditContractNumber	string	необязательное	Номер кредитного договора,
date	string	обязательное	Дата составления документа,
deliveryKind	string	необязательное	Вид платежа: электронно, срочно Если не заполнено или 0, то будет присвоено значение "электронно",
expirationDate	string	необязательное	Дата истечения заказа (платеж должен быть подтвержден клиентом),
externalId	string	обязательное	Идентификатор документа, присвоенный партнером (UUID),
isPaidByCredit	boolean	необязательное	Признак того, что платежное поручение будет оплачено за счет кредитных средств,
linkedDocs	Array[LinkedDoc]	необязательное	Связанные документы,
operationCode	string	необязательное	Код операции,
orderNumber	string	необязательное	Номер заказа,
payeeAccount	string	обязательное	Счет получателя платежа,
payeeBankBic	string	обязательное	БИК банка получателя платежа,
payeeBankCorrAccount	string	необязательное	Кор. счет банка получателя платежа,
payeeInn	string	обязательное	ИНН получателя платежа,
payeeKpp	string	необязательное	КПП получателя платежа,
payeeName	string	обязательное	Наименование получателя платежа,
paymentNumber	string	необязательное	Номер платежного поручения Обратите внимание: номер документа должен быть не более 6 цифр,
priority	string	необязательное	Очередность платежа,
purpose	string	обязательное	Назначение платежа Размерность: [1 .. 210],
urgencyCode	string	необязательное	Код срочности = [`INTERNAL`, `INTERNAL_NOTIF`, `OFFHOURS`, `BESP`, `NORMAL`] stringEnum : 0, 1, 2, 3, 4,
vat	vat	необязательное	Данные НДС
}
LinkedDoc {
docExtId	string	необязательное	Идентификатор документа (заявления на страхование экспортного контракта) во внешней системе (UUID), к которому необходимо привязать платежное поручение,
type	string	необязательное	Тип связанного документа (доступное значение для заполнения - exportContractInsure), с которым необходимо связать платежное поручение
}
Vat {
amount	number	необязательное	Сумма НДС,
rate	string	необязательное	Ставка НДС,
type	string	обязательное	Способ расчета НДС = [`INCLUDED`, `ONTOP`, `NO_VAT`, `MANUAL`]
}

{
  "amount": 1.01,
  "creditContractNumber": "2020/66556",
  "date": "2018-12-31",
  "deliveryKind": "электронно",
  "expirationDate": "2018-12-31",
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "isPaidByCredit": true,
  "linkedDocs": [
    {
      "docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
      "type": "ExportContractInsure"
    }
  ],
  "operationCode": "01",
  "orderNumber": "123",
  "payeeAccount": "40802810600000200000",
  "payeeBankBic": "044525225",
  "payeeBankCorrAccount": "30101810400000000225",
  "payeeInn": "7707083893",
  "payeeKpp": "222201001",
  "payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
 "paymentNumber": "1",
  "priority": "5",
  "purpose": "Оплата заказа №123. НДС нет.",
  "urgencyCode": "INTERNAL",
  "vat": {
    "amount": 1.01,
    "rate": "10",
    "type": "NO_VAT"
  }
}

Responses

201 (Создан)

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

Наименование	Тип	Обязательность	Описание
Payment {
amount	number	обязательное	Сумма платежа,
bankComment	string	необязательное	Банковский комментарий к статусу документа,
bankStatus	string	необязательное	Статус документа,
crucialFieldsHash	string	необязательное	Hash от ключевых полей документа,
date	string	обязательное	Дата составления документа,
deliveryKind	string	необязательное	Вид платежа,
departmentalInfo	DepartmentalInfo	необязательное	Реквизиты налогового, таможенного или иного бюджетного платежа,
digestSignatures	Array[Signature]	необязательное	Электронные подписи по дайджесту документа,
externalId	string	обязательное	Идентификатор документа, присвоенный партнером (UUID),
incomeTypeCode	string	необязательное	Код вида дохода получателей выплаты по 229-ФЗ,
number	string	необязательное	Номер документа,
operationCode	string	обязательное	Код операции,
payeeAccount	string	необязательное	Счет получателя платежа,
payeeBankBic	string	обязательное	БИК получателя платежа,
payeeBankCorrAccount	string	необязательное	Корсчет банка получателя платежа,
payeeInn	string	необязательное	ИНН получателя платежа,
payeeKpp	string	необязательное	КПП получателя платежа,
payeeName	string	обязательное	Полное наименование получателя платежа,
payerAccount	string	обязательное	Счет плательщика,
payerBankBic	string	обязательное	БИК банка плательщика,
payerBankCorrAccount	string	обязательное	Корсчет банка плательщика,
payerInn	string	обязательное	ИНН плательщика,
payerKpp	string	необязательное	КПП плательщика,
payerName	string	обязательное	Полное наименование плательщика,
priority	string	обязательное	Очередность платежа,
purpose	string	обязательное	Назначение платежа,
urgencyCode	string	необязательное	Код срочности \= ['INTERNAL', 'INTERNAL_NOTIF', 'OFFHOURS', 'BESP', 'NORMAL'],
vat	vat	необязательное	Данные НДС,
voCode	string	необязательное	Код вида валютной операции
}
DepartmentalInfo {
uip	string	обязательное	Уникальный идентификатор платежа,
drawerStatus101	string	обязательное	Показатель статуса налогоплательщика (реквизит - 101),
kbk	string	обязательное	Код бюджетной классификации (реквизит - 104),
oktmo	string	обязательное	Код OKTMO (реквизит - 105),
reasonCode106	string	обязательное	Показатель основания платежа (реквизит - 106),
taxPeriod107	string	обязательное	Налоговый период / код таможенного органа (реквизит - 107),
docNumber108	string	обязательное	Номер налогового документа (реквизит - 108),
docDate109	string	обязательное	Дата налогового документа (реквизит - 109),
paymentKind110	string	необязательное	Тип налогового платежа (реквизит - 110)
}
Signature {
base64Encoded	string	обязательное	Значение электронной подписи, закодированное в Base64,
certificateUuid	string	обязательное	Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID),
}
Vat {
amount	number	необязательное	Сумма НДС,
rate	string	необязательное	Ставка НДС,
type	string	обязательное	Способ расчета НДС \= ['INCLUDED', 'ONTOP', 'NO_VAT', 'MANUAL']
}

{
  "amount": 1.01,
  "bankComment": "string",
  "bankStatus": "string",
  "crucialFieldsHash": "string",
  "date": "2018-12-31",
  "deliveryKind": "электронно",
  "departmentalInfo": {
    "uip": "0",
    "drawerStatus101": "01",
    "kbk": "18210102010011000110",
    "oktmo": "01701000",
    "reasonCode106": "ТП",
    "taxPeriod107": "ГД.00.2018",
    "docNumber108": "123",
    "docDate109": "0",
    "paymentKind110": "1"
  },
  "digestSignatures": [
    {
      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
      "certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
    }
  ],
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "incomeTypeCode": "2",
  "number": "1",
  "operationCode": "01",
  "payeeAccount": "40802810600000200000",
  "payeeBankBic": "044525225",
  "payeeBankCorrAccount": "30101810400000000225",
  "payeeInn": "7707083893",
  "payeeKpp": "222201001",
  "payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
  "payerAccount": "40802810600000200000",
  "payerBankBic": "044525225",
  "payerBankCorrAccount": "30101810400000000225",
  "payerInn": "7707083893",
  "payerKpp": "222201001",
  "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
  "priority": "5",
  "purpose": "Оплата заказа №123. НДС нет.",
  "urgencyCode": "INTERNAL",
  "vat": {
    "amount": 1.01,
    "rate": "10",
    "type": "NO_VAT"
  },
  "voCode": "61150"
}

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

Наименование ошибки	Описание ошибки
DESERIALIZATION_FAULT	Неверный формат запроса
WORKFLOW_FAULT	Не найдена организация получателя по payeeOrgIdHash: <значение payeeOrgIdHash>
Невозможно идентифицировать организацию плательщика
Невозможно идентифицировать банк плательщика по указанным номеру БИК и корреспондентскому счету
Невозможно идентифицировать банк получателя по указанным номеру БИК и корреспондентскому счету
Документ с таким externalId уже существует в системе
VALIDATION_FAULT	Ошибка валидации
Для договора № <номер договора> отсутствует действующая возобновляемая кредитная линия

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

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

{
  "referenceId": "string",
  "message": "string",
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "fieldNames": "[\"externalId\", \"paymentNumber\"]"
}

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

Наименование ошибки	Описание ошибки
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
UNAVAILABLE_RESOURCE_EXCEPTION

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Usecase

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

Участники usecase

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

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

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

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

Предусловия

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

Постусловия

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

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

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

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

Наименование	Тип	Обязательность	Описание
Параметры заголовка
Authorization	string	обязательное	Access token организации-клиента, полученный через SSO Пример: `Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1`
Параметры тела запроса
InvoiceBudget {
amount	number	обязательное	Сумма платежа,
date	string	обязательное	Дата составления документа,
deliveryKind	string	необязательное	Вид платежа: электронно, срочно Если не заполнено или 0, то будет присвоено значение "электронно",
departmentalInfo	DepartmentalInfo	обязательное	Реквизиты налогового, таможенного или иного бюджетного платежа,
externalId	string	обязательное	Идентификатор документа, присвоенный партнером (UUID),
operationCode	string	необязательное	Код операции,
payeeAccount	string	обязательное	Счет получателя платежа,
payeeBankBic	string	обязательное	БИК банка получателя платежа,
payeeBankCorrAccount	string	необязательное	Кор. счет банка получателя платежа,
payeeInn	string	обязательное	ИНН получателя платежа,
payeeKpp	string	необязательное	КПП получателя платежа,
payeeName	string	обязательное	Наименование получателя платежа,
payerKpp	string	необязательное	КПП плательщика.<br //>Если плательщик - ИП, то заполнять значением "0",
paymentNumber	string	необязательное	Номер платежного поручения. Обратите внимание: номер документа должен быть не более 6 цифр Если клиент не ведет в своей учетной системе нумерацию платежных поручений, созданных на основании выставленных счетов, то атрибут можно не передавать, он будет присвоен автоматически,
priority	string	необязательное	Очередность платежа,
purpose	string	обязательное	Назначение платежа Размерность: [1 .. 210],
urgencyCode	string	необязательное	Код срочности = [`INTERNAL` - срочный, `INTERNAL_NOTIF` - срочный платеж с уведомлением `OFFHOURS` - неотложный, `BESP` - банковские электронные срочные платежи, `NORMAL` - срочность не указана] stringEnum: 0, 1, 2, 3, 4,
vat	vat	необязательное	Данные НДС
}
DepartmentalInfo {			Реквизиты налогового, таможенного или иного бюджетного платежа,
uip	string	обязательное	Уникальный идентификатор платежа,
drawerStatus101	string	обязательное	Показатель статуса налогоплательщика (реквизит - 101),
kbk	string	обязательное	Код бюджетной классификации (реквизит - 104),
oktmo	string	обязательное	Код OKTMO (реквизит - 105),
reasonCode106	string	обязательное	Показатель основания платежа (реквизит - 106),
taxPeriod107	string	обязательное	Налоговый период / код таможенного органа (реквизит - 107),
docNumber108	string	обязательное	Номер налогового документа (реквизит - 108),
docDate109	string	обязательное	Дата налогового документа (реквизит - 109),
paymentKind110	string	обязательное	Тип налогового платежа (реквизит - 110)
}
LinkedDoc {
docExtId	string	необязательное	Идентификатор документа (заявления на страхование экспортного контракта) во внешней системе (UUID), к которому необходимо привязать платежное поручение,
type	string	необязательное	Тип связанного документа (доступное значение для заполнения - exportContractInsure), с которым необходимо связать платежное поручение
}
Vat {
amount	number	обязательное	Сумма НДС,
rate	string	обязательное	Ставка НДС,
type	string	обязательное	Способ расчета НДС = [`INCLUDED`, `ONTOP`, `NO_VAT`, `MANUAL`] stringEnum: 0,2,3

{
  "amount": 1.01,
  "bankComment": "string",
  "bankStatus": "string",
  "crucialFieldsHash": "string",
  "date": "2018-12-31",
  "deliveryKind": "электронно",
  "departmentalInfo": {
    "uip": "0",
    "drawerStatus101": "01",
    "kbk": "18210102010011000110",
    "oktmo": "01701000",
    "reasonCode106": "ТП",
    "taxPeriod107": "ГД.00.2018",
    "docNumber108": "123",
    "docDate109": "0",
    "paymentKind110": "1"
  },
  "digestSignatures": [
    {
      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
      "certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
    }
  ],
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "incomeTypeCode": "2",
  "number": "1",
  "operationCode": "01",
  "payeeAccount": "40802810600000200000",
  "payeeBankBic": "044525225",
  "payeeBankCorrAccount": "30101810400000000225",
  "payeeInn": "7707083893",
  "payeeKpp": "222201001",
  "payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
  "payerAccount": "40802810600000200000",
  "payerBankBic": "044525225",
  "payerBankCorrAccount": "30101810400000000225",
  "payerInn": "7707083893",
  "payerKpp": "222201001",
  "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
  "priority": "5",
  "purpose": "Оплата заказа №123. НДС нет.",
  "urgencyCode": "INTERNAL",
  "vat": {
    "amount": 1.01,
    "rate": "10",
    "type": "NO_VAT"
  },
  "voCode": "61150"
}

Responses

201 (Создан)

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

Наименование	Тип	Обязательность	Описание
Payment {
amount	number	обязательное	Сумма платежа,
bankComment	string	необязательное	Банковский комментарий к статусу документа,
bankStatus	string	необязательное	Статус документа,
crucialFieldsHash	string	необязательное	Hash от ключевых полей документа,
date	string	обязательное	Дата составления документа,
deliveryKind	string	необязательное	Вид платежа,
departmentalInfo	DepartmentalInfo	необязательное	Реквизиты налогового, таможенного или иного бюджетного платежа,
digestSignatures	Array[Signature]	необязательное	Электронные подписи по дайджесту документа,
externalId	string	обязательное	Идентификатор документа, присвоенный партнером (UUID),
incomeTypeCode	string	необязательное	Код вида дохода получателей выплаты по 229-ФЗ,
number	string	необязательное	Номер документа,
operationCode	string	обязательное	Код операции,
payeeAccount	string	необязательное	Счет получателя платежа,
payeeBankBic	string	обязательное	БИК получателя платежа,
payeeBankCorrAccount	string	необязательное	Корсчет банка получателя платежа,
payeeInn	string	необязательное	ИНН получателя платежа,
payeeKpp	string	необязательное	КПП получателя платежа,
payeeName	string	обязательное	Полное наименование получателя платежа,
payerAccount	string	обязательное	Счет плательщика,
payerBankBic	string	обязательное	БИК банка плательщика,
payerBankCorrAccount	string	обязательное	Корсчет банка плательщика,
payerInn	string	обязательное	ИНН плательщика,
payerKpp	string	необязательное	КПП плательщика,
payerName	string	обязательное	Полное наименование плательщика,
priority	string	обязательное	Очередность платежа,
purpose	string	обязательное	Назначение платежа,
urgencyCode	string	необязательное	Код срочности = [`INTERNAL`, `INTERNAL_NOTIF`, `OFFHOURS`, `BESP`, `NORMAL`],
vat	vat	необязательное	Данные НДС,
voCode	string	необязательное	Код вида валютной операции
}
DepartmentalInfo {
uip	string	обязательное	Уникальный идентификатор платежа,
drawerStatus101	string	обязательное	Показатель статуса налогоплательщика (реквизит - 101),
kbk	string	обязательное	Код бюджетной классификации (реквизит - 104),
oktmo	string	обязательное	Код OKTMO (реквизит - 105),
reasonCode106	string	обязательное	Показатель основания платежа (реквизит - 106),
taxPeriod107	string	обязательное	Налоговый период / код таможенного органа (реквизит - 107),
docNumber108	string	обязательное	Номер налогового документа (реквизит - 108),
docDate109	string	обязательное	Дата налогового документа (реквизит - 109),
paymentKind110	string	необязательное	Тип налогового платежа (реквизит - 110)
}
Signature {
base64Encoded	string	обязательное	Значение электронной подписи, закодированное в Base64,
certificateUuid	string	обязательное	Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID),
}
Vat {
amount	number	необязательное	Сумма НДС,
rate	string	необязательное	Ставка НДС,
type	string	обязательное	Способ расчета НДС = [`INCLUDED`, `ONTOP`, `NO_VAT`, `MANUAL`]
}

{
  "amount": 1.01,
  "bankComment": "string",
  "bankStatus": "string",
  "crucialFieldsHash": "string",
  "date": "2018-12-31",
  "deliveryKind": "электронно",
  "departmentalInfo": {
    "uip": "0",
    "drawerStatus101": "01",
    "kbk": "18210102010011000110",
    "oktmo": "01701000",
    "reasonCode106": "ТП",
    "taxPeriod107": "ГД.00.2018",
    "docNumber108": "123",
    "docDate109": "0",
    "paymentKind110": "1"
  },
  "digestSignatures": [
    {
      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
      "certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
    }
  ],
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "incomeTypeCode": "2",
  "number": "1",
  "operationCode": "01",
  "payeeAccount": "40802810600000200000",
  "payeeBankBic": "044525225",
  "payeeBankCorrAccount": "30101810400000000225",
  "payeeInn": "7707083893",
  "payeeKpp": "222201001",
  "payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
  "payerAccount": "40802810600000200000",
  "payerBankBic": "044525225",
  "payerBankCorrAccount": "30101810400000000225",
  "payerInn": "7707083893",
  "payerKpp": "222201001",
  "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
  "priority": "5",
  "purpose": "Оплата заказа №123. НДС нет.",
  "urgencyCode": "INTERNAL",
  "vat": {
    "amount": 1.01,
    "rate": "10",
    "type": "NO_VAT"
  },
  "voCode": "61150"
}

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

Наименование ошибки	Описание ошибки
DESERIALIZATION_FAULT	Неверный формат запроса
WORKFLOW_FAULT	Не найдена организация получателя по payeeOrgIdHash: <значение payeeOrgIdHash>
Невозможно идентифицировать организацию плательщика
Невозможно идентифицировать банк плательщика по указанным номеру БИК и корреспондентскому счету
Невозможно идентифицировать банк получателя по указанным номеру БИК и корреспондентскому счету
Документ с таким externalId уже существует в системе
VALIDATION_FAULT	Ошибка валидации
Для договора № <номер договора> отсутствует действующая возобновляемая кредитная линия

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

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

{
  "referenceId": "string",
  "message": "string",
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "fieldNames": "[\"externalId\", \"paymentNumber\"]"
}

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

Наименование ошибки	Описание ошибки
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
UNAVAILABLE_RESOURCE_EXCEPTION

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Usecase

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

Участники usecase

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

Предусловия

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

Постусловия

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

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

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

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

Наименование	Тип	Обязательность	Описание
Параметры заголовка
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://iftfintech.testsbi.sberbank.ru:9443/fintech/api/v1/payments/ffffffff-fffa-458e-ad92-fff9497303ba/state'

Responses

200 (ОК)

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

Наименование	Тип	Обязательность	Описание
Payment {
amount (number)	number	обязательное	Сумма платежа,
bankComment (read only)	string	необязательное	Банковский комментарий к статусу документа,
bankStatus (read only)	string	необязательное	Статус документа,
crucialFieldsHash	string	необязательное	Hash от ключевых полей документа,
date	string	обязательное	Дата составления документа,
deliveryKind	string	необязательное	Вид платежа,
departmentalInfo	DepartmentalInfo	необязательное	Реквизиты налогового, таможенного или иного бюджетного платежа,
digestSignatures	Array[Signature]	необязательное	Электронные подписи по дайджесту документа,
externalId	string	обязательное	Идентификатор документа, присвоенный партнером (UUID),
incomeTypeCode	string	необязательное	Код вида дохода получателей выплаты по 229-ФЗ,
number	string	необязательное	Номер документа,
operationCode	string	обязательное	Код операции,
payeeAccount	string	необязательное	Счет получателя платежа,
payeeBankBic	string	обязательное	БИК получателя платежа,
payeeBankCorrAccount	string	необязательное	Корсчет банка получателя платежа,
payeeInn	string	необязательное	ИНН получателя платежа,
payeeKpp	string	необязательное	КПП получателя платежа,
payeeName	string	обязательное	Полное наименование получателя платежа
payerAccount	string	обязательное	Счет плательщика.
payerBankBic	string	обязательное	БИК банка плательщика,
payerBankCorrAccount	string	обязательное	Корсчет банка плательщика,
payerInn	string	обязательное	ИНН плательщика
payerKpp	string	необязательное	КПП плательщика,
payerName	string	обязательное	Полное наименование плательщика,
priority	string	обязательное	Очередность платежа,
purpose	string	обязательное	Назначение платежа,
urgencyCode	string	необязательное	Код срочности = [`INTERNAL`, `INTERNAL_NOTIF`, `OFFHOURS`, `BESP`, `NORMAL`],
vat	vat	необязательное	Данные НДС,
voCode	string	необязательное	Код вида валютной операции
}
DepartmentalInfo {
uip	string	обязательное	Уникальный идентификатор платежа,
drawerStatus101	string	обязательное	Показатель статуса налогоплательщика (реквизит - 101),
kbk	string	обязательное	Код бюджетной классификации (реквизит - 104),
oktmo	string	обязательное	Код OKTMO (реквизит - 105),
reasonCode106	string	обязательное	Показатель основания платежа (реквизит - 106),
taxPeriod107	string	обязательное	Налоговый период / код таможенного органа (реквизит - 107),
docNumber108	string	обязательное	Номер налогового документа (реквизит - 108),
docDate109	string	обязательное	Дата налогового документа (реквизит - 109),
paymentKind11			Тип налогового платежа (реквизит - 110)
}
Signature {
base64Encoded	string	обязательное	Значение электронной подписи, закодированное в Base64,
certificateUuid	string	обязательное	Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)
}
Vat {
amount	number	необязательное	Сумма НДС,
rate	string	необязательное	Ставка НДС,
type	string	обязательное	Способ расчета НДС = [`INCLUDED`, `ONTOP`, `NO_VAT`, `MANUAL`]
}

{
  "amount": 1.01,
  "bankComment": "string",
  "bankStatus": "string",
  "crucialFieldsHash": "string",
  "date": "2018-12-31",
  "deliveryKind": "электронно",
  "departmentalInfo": {
    "uip": "0",
    "drawerStatus101": "01",
    "kbk": "18210102010011000110",
    "oktmo": "01701000",
    "reasonCode106": "ТП",
    "taxPeriod107": "ГД.00.2018",
    "docNumber108": "123",
    "docDate109": "0",
    "paymentKind110": "1"
  },
  "digestSignatures": [
    {
      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
      "certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
    }
  ],
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "incomeTypeCode": "2",
  "number": "1",
  "operationCode": "01",
  "payeeAccount": "40802810600000200000",
  "payeeBankBic": "044525225",
  "payeeBankCorrAccount": "30101810400000000225",
  "payeeInn": "7707083893",
  "payeeKpp": "222201001",
  "payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
  "payerAccount": "40802810600000200000",
  "payerBankBic": "044525225",
  "payerBankCorrAccount": "30101810400000000225",
  "payerInn": "7707083893",
  "payerKpp": "222201001",
  "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
  "priority": "5",
  "purpose": "Оплата заказа №123. НДС нет.",
  "urgencyCode": "INTERNAL",
  "vat": {
    "amount": 1.01,
    "rate": "10",
    "type": "NO_VAT"
  },
  "voCode": "61150"
}

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

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

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

{
  "referenceId": "string",
  "message": "string",
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "fieldNames": "[\"externalId\", \"paymentNumber\"]"
}

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

Наименование ошибки	Описание ошибки
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
UNAVAILABLE_RESOURCE_EXCEPTION

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

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`	Исполнен	Электронный документ исполнен Банком

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

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}

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

Наименование	Тип	Обязательность	Описание
Параметры заголовка
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://iftfintech.testsbi.sberbank.ru:9443/fintech/api/v1/payments/ffffffff-fffa-458e-ad92-fff9497303ba'

Responses

200 (ОК)

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

Наименование	Тип	Обязательность	Описание
Payment {
amount (number)	number	обязательное	Сумма платежа,
bankComment (read only)	string	необязательное	Банковский комментарий к статусу документа,
bankStatus (read only)	string	необязательное	Статус документа,
crucialFieldsHash	string	необязательное	Hash от ключевых полей документа,
date	string	обязательное	Дата составления документа,
deliveryKind	string	необязательное	Вид платежа,
departmentalInfo	DepartmentalInfo	необязательное	Реквизиты налогового, таможенного или иного бюджетного платежа,
digestSignatures	Array[Signature]	необязательное	Электронные подписи по дайджесту документа,
externalId	string	обязательное	Идентификатор документа, присвоенный партнером (UUID),
incomeTypeCode	string	необязательное	Код вида дохода получателей выплаты по 229-ФЗ,
number	string	необязательное	Номер документа,
operationCode	string	обязательное	Код операции,
payeeAccount	string	необязательное	Счет получателя платежа,
payeeBankBic	string	обязательное	БИК получателя платежа,
payeeBankCorrAccount	string	необязательное	Корсчет банка получателя платежа,
payeeInn	string	необязательное	ИНН получателя платежа,
payeeKpp	string	необязательное	КПП получателя платежа,
payeeName	string	обязательное	Полное наименование получателя платежа
payerAccount	string	обязательное	Счет плательщика.
payerBankBic	string	обязательное	БИК банка плательщика,
payerBankCorrAccount	string	обязательное	Корсчет банка плательщика,
payerInn	string	обязательное	ИНН плательщика
payerKpp	string	необязательное	КПП плательщика,
payerName	string	обязательное	Полное наименование плательщика,
priority	string	обязательное	Очередность платежа,
purpose	string	обязательное	Назначение платежа,
urgencyCode	string	необязательное	Код срочности = [`INTERNAL`, `INTERNAL_NOTIF`, `OFFHOURS`, 'BESP', 'NORMAL'],
vat	vat	необязательное	Данные НДС,
voCode	string	необязательное	Код вида валютной операции
}
DepartmentalInfo {
uip	string	обязательное	Уникальный идентификатор платежа,
drawerStatus101	string	обязательное	Показатель статуса налогоплательщика (реквизит - 101),
kbk	string	обязательное	Код бюджетной классификации (реквизит - 104),
oktmo	string	обязательное	Код OKTMO (реквизит - 105),
reasonCode106	string	обязательное	Показатель основания платежа (реквизит - 106),
taxPeriod107	string	обязательное	Налоговый период / код таможенного органа (реквизит - 107),
docNumber108	string	обязательное	Номер налогового документа (реквизит - 108),
docDate109	string	обязательное	Дата налогового документа (реквизит - 109),
paymentKind11			Тип налогового платежа (реквизит - 110)
}
Signature {
base64Encoded	string	обязательное	Значение электронной подписи, закодированное в Base64,
certificateUuid	string	обязательное	Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)
}
Vat {
amount	number	необязательное	Сумма НДС,
rate	string	необязательное	Ставка НДС,
type	string	обязательное	Способ расчета НДС = [`INCLUDED`, `ONTOP`, `NO_VAT`, `MANUAL`]
}

{
  "amount": 1.01,
  "bankComment": "string",
  "bankStatus": "string",
  "crucialFieldsHash": "string",
  "date": "2018-12-31",
  "deliveryKind": "электронно",
  "departmentalInfo": {
    "uip": "0",
    "drawerStatus101": "01",
    "kbk": "18210102010011000110",
    "oktmo": "01701000",
    "reasonCode106": "ТП",
    "taxPeriod107": "ГД.00.2018",
    "docNumber108": "123",
    "docDate109": "0",
    "paymentKind110": "1"
  },
  "digestSignatures": [
    {
      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
      "certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
    }
  ],
  "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
  "incomeTypeCode": "2",
  "number": "1",
  "operationCode": "01",
  "payeeAccount": "40802810600000200000",
  "payeeBankBic": "044525225",
  "payeeBankCorrAccount": "30101810400000000225",
  "payeeInn": "7707083893",
  "payeeKpp": "222201001",
  "payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
  "payerAccount": "40802810600000200000",
  "payerBankBic": "044525225",
  "payerBankCorrAccount": "30101810400000000225",
  "payerInn": "7707083893",
  "payerKpp": "222201001",
  "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
  "priority": "5",
  "purpose": "Оплата заказа №123. НДС нет.",
  "urgencyCode": "INTERNAL",
  "vat": {
    "amount": 1.01,
    "rate": "10",
    "type": "NO_VAT"
  },
  "voCode": "61150"
}

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

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

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

{
  "referenceId": "string",
  "message": "string",
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "fieldNames": "[\"externalId\", \"paymentNumber\"]"
}

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

Наименование ошибки	Описание ошибки
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

Наименование ошибки	Описание ошибки
UNAVAILABLE_RESOURCE_EXCEPTION

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

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

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

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

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

Если блок 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.

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

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

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

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

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

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

Request﻿

Responses﻿

Usecase﻿

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

Request﻿

Responses﻿

Usecase﻿

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

Request﻿

Responses﻿

Usecase﻿

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

Request﻿

Responses﻿

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

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

Request﻿

Responses﻿

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

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

FAQ по сервису﻿

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

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

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

Request

Responses

Usecase

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

Request

Responses

Usecase

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

Request

Responses

Usecase

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

Request

Responses

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

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

Request

Responses

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

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

FAQ по сервису