ym88659208ym87991671
Создание платежных требований | Документация для разработчиков

Создание платежных требований

Обновлено 26 декабря 2023

Ресурс /v1/payment-requests/outgoing/in позволяет Партнеру создавать исходящие платежные требования, где получателем средств является организация, предоставляющая сервис.

Шаги

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

2.Отправить POST-запрос (/v1/payment-requests/outgoing/in), в котором необходимо передать авторизационный токен к данным клиента (Access Token) и реквизиты платежного требования. Авторизационный токен передается в параметреAuthorization заголовка запроса.

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

НаименованиеОписание
Параметры заголовка
Authorization (String)Access token организации-клиента, полученный через SSOПример: Bearer c5e7110b-394a-45eb-9a4b-d8759cf6f9eb-1
Параметры тела запроса
PaymentRequestOutIn {
acceptanceTerm (string, optional)Срок для акцепта (поле 36). Указывается количество дней для получения акцепта плательщика,
amount (number)Сумма платежа,
bankComment (string, optional, read only)Банковский комментарий к статусу документа,
bankStatus (string, optional, read only)Статус документа,
crucialFieldsHash (string, optional)Hash от ключевых полей документа,
date (string)Дата составления документа,
deliveryKind (string, optional)Вид платежа: электронно, срочноЕсли не заполнено или 0, то будет присвоено значение "электронно",
digestSignatures (Array[Signature], optional)Электронные подписи по дайджесту документа,
externalId (string)Идентификатор документа, присвоенный партнером (UUID),
number (string, optional)Номер документа,
operationCode (string)Код операции,
payeeAccount (string)Счет получателя платежа,
payeeBankBic (string)БИК получателя платежа,
payeeBankCorrAccount (string, optional)Корсчет банка получателя платежа,
payeeInn (string, optional)ИНН получателя платежа,
payeeName (string)Полное наименование получателя платежа,
payerAccount (string)Счет плательщика,
payerBankBic (string)БИК банка плательщика,
payerBankCorrAccount (string)Корсчет банка плательщика,
payerInn (string)ИНН плательщика,
payerName (string)Полное наименование плательщика,
paymentCondition (string)Условие оплаты (поле 35).Указывается цифра "1" - заранее данный акцепт плательщика илицифра "2" - требуется получение акцепта плательщика,
priority (string)Очередность платежа,
purpose (string)Назначение платежаЗаполнять значением purpose, полученным в ответе на запрос GET /v1/partner-info/advance-acceptancesЕсли необходимо дополнить назначение, поставьте точку и укажите свою информацию,
vat (Vat, optional)Данные НДС,
voCode (string, optional)Код вида валютной операции
}Signature {
base64Encoded (string)Значение электронной подписи, закодированное в Base64,
certificateUuid (string)Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)
}Vat {
amount (number, optional)Сумма НДС,
rate (string, optional)Ставка НДС,
type (string)Способ расчета НДС = ['INCLUDED','NO_VAT', 'MANUAL']stringEnum "INCLUDED", "NO_VAT", "MANUAL"
}

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

{
"acceptanceTerm":"string",
"amount":1.01,
"bankComment":"string",
"bankStatus":"string",
"crucialFieldsHash":"string",
"date":"2018-12-31",
"deliveryKind":"электронно",
"digestSignatures":[
{
"base64Encoded":"HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number":"1",
"operationCode":"02",
"payeeAccount":"40802810600000200000",
"payeeBankBic":"044525225",
"payeeBankCorrAccount":"30101810400000000225",
"payeeInn":"7707083893",
"payeeName":"Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount":"40802810600000200000",
"payerBankBic":"044525225",
"payerBankCorrAccount":"30101810400000000225",
"payerInn":"7707083893",
"payerName":"Общество с ограниченной ответственностью \"Клиент\"",
"paymentCondition":"string",
"priority":"5",
"purpose":"Оплата заказа №123. НДС нет.",
"vat":{
"amount":1.01,
"rate":"10",
"type":"NO_VAT"
},
"voCode":"61150"
}

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

НаименованиеОписание
PaymentRequestOutIn {
acceptanceTerm (string, optional)Срок для акцепта (поле 36). Указывается количество дней для получения акцепта плательщика,
amount (number)Сумма платежа,
bankComment (string, optional, read only)Банковский комментарий к статусу документа,
bankStatus (string, optional, read only)Статус документа,
crucialFieldsHash (string, optional)Hash от ключевых полей документа,
date (string)Дата составления документа,
deliveryKind (string, optional)Вид платежа,
digestSignatures (Array[Signature], optional)Электронные подписи по дайджесту документа,
externalId (string)Идентификатор документа, присвоенный партнером (UUID),
number (string, optional)Номер документа,
operationCode (string)Код операции,
payeeAccount (string)Счет получателя платежа,
payeeBankBic (string)БИК получателя платежа,
payeeBankCorrAccount (string, optional)Корсчет банка получателя платежа,
payeeInn (string, optional)ИНН получателя платежа,
payeeName (string)Полное наименование получателя платежа,
payerAccount (string)Счет плательщика,
payerBankBic (string)БИК банка плательщика,
payerBankCorrAccount (string)Корсчет банка плательщика,
payerInn (string)ИНН плательщика,
payerName (string)Полное наименование плательщика,
paymentCondition (string)Условие оплаты (поле 35).Указывается цифра "1" - заранее данный акцепт плательщика илицифра "2" - требуется получение акцепта плательщика,
priority (string)Очередность платежа,
purpose (string)Назначение платежа,
vat (Vat, optional)Данные НДС,
voCode (string, optional)Код вида валютной операции
}Signature {
base64Encoded (string)Значение электронной подписи, закодированное в Base64,
certificateUuid (string)Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)
}Vat {
amount (number, optional)Сумма НДС,
rate (string, optional)Ставка НДС,
type (string)Способ расчета НДС = ['INCLUDED','NO_VAT', 'MANUAL']stringEnum "INCLUDED", "NO_VAT", "MANUAL"
}

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

{
"acceptanceTerm":"string",
"amount":1.01,
"bankComment":"string",
"bankStatus":"string",
"crucialFieldsHash":"string",
"date":"2018-12-31",
"deliveryKind":"электронно",
"digestSignatures":[
{
"base64Encoded":"HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number":"1",
"operationCode":"02",
"payeeAccount":"40802810600000200000",
"payeeBankBic":"044525225",
"payeeBankCorrAccount":"30101810400000000225",
"payeeInn":"7707083893",
"payeeName":"Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount":"40802810600000200000",
"payerBankBic":"044525225",
"payerBankCorrAccount":"30101810400000000225",
"payerInn":"7707083893",
"payerName":"Общество с ограниченной ответственностью \"Клиент\"",
"paymentCondition":"string",
"priority":"5",
"purpose":"Оплата заказа №123. НДС нет.",
"vat":{
"amount":1.01,
"rate":"10",
"type":"NO_VAT"
},
"voCode":"61150"
}

Передача электронной подписи

Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature (все поля обязательны):

Наименования поляОписания поляПример
base64Encoded (string)Значение ЭП документаHlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==
certificateUuid (string)Идентификатор сертификата, использованного при создании ЭП ( можно узнать, обратившись к ресурсу /v1/crypto)22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6

В документе можно передать одну или две ЭП вместе с реквизитами создаваемого документа. Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе СББОЛ.

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

  • одна (единственная) подпись;

  • первая и вторая подписи.

При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.

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

Формат дайджеста платежного требования

Обновлено 26 декабря 2023
Наименование поляОписание поляПример
acceptanceTermСрок акцепта5
amountСумма платежа100.01
dateДата составления документа31.12.2018
externalIdИдентификатор документа, присвоенный сервисом22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6
operationCodeКод операции02
payeeAccountНомер счета получателя40802810600000200000
payeeBankBicБИК получателя044525225
payeeBankCorrAccountКорсчет банка получателя30101810400000000225
payeeInnИнн получателя0
payeeNameПолное наименование получателя платежаОбщество с ограниченной ответственностью "Получатель"
payerAccountСчет плательщика40802810600000200000
payerBankBicБИК плательщика044525225
payerBankCorrAccountКорсчет банка плательщика30101810400000000225
payerInnИНН плательщика0
payerNameПолное наименование плательщикаОбщество с ограниченной ответственностью "Клиент"
paymentConditionУсловие оплаты (1/2)1
priorityОчередность платежа5
purposeНазначение платежаОплата товара по договору №123 от 01.08.2018. НДС не облагается

Пример дайджеста

acceptanceTerm=5
amount=100.01
date=2018-12-31
externalId=22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6
operationCode=02
payeeAccount=40802810600000200000
payeeBankBic=044525225
payeeBankCorrAccount=30101810400000000225
payeeInn=0
payeeName=Общество с ограниченной ответственностью "Получатель"
payerAccount=40802810600000200000
payerBankBic=044525225
payerBankCorrAccount=30101810400000000225
payerInn=0
payerName=Общество с ограниченной ответственностью "Клиент"
paymentCondition=1
priority=5
purpose=Назначение платежа

Коды возврата

Коды возвратаОтвет
201 OKСоздано
202Операция не завершена полностью
400Ошибка в запросе или его жизненном цикле
401Не авторизован
503Сервис временно недоступен
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.