Выставление счета клиенту

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

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

Выставление счета клиенту для Сбербанка

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

Шаги

1. Получить AccessToken.

2. Отправить запрос.

3. Переадресовать клиента на форму оплаты.

4. Получить статус.

5. Получить документ (опционально).

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

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

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

Header Parameters
Authorization String
Access token организации-клиента, полученный через SSO.
Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1
Body
Invoice {
amount (number) Сумма платежа ,
bankComment (string, optional, read only) Банковский комментарий к статусу документа ,
bankStatus (string, optional, read only) Статус документа ,
crucialFieldsHash (string, optional, read only) Hash от ключевых полей документа ,
date (string) Дата составления документа ,
deliveryKind (string, optional) Вид платежа ,
expirationDate (string, optional) Дата истечения заказа (платёж должен быть подтверждён клиентом) ,
externalId (string) Идентификатор документа, присвоенный партнёром (UUID) ,
operationCode (string, optional) Код операции ,
orderNumber (string, optional) Номер заказа ,
payeeAccount (string) Счёт получателя платежа ,
payeeOrgIdHash (string, optional) Идентификатор получателя платежа ,
paymentNumber (string, optional) Номер платёжного поручения.
Если клиент не ведет в своей учетной системе нумерацию платежных поручений, созданных на основании выставленных счетов, то атрибут можно не передавать, он будет присвоен автоматически ,
priority (string, optional) Очерёдность платежа ,
purpose (string) Назначение платежа ,
urgencyCode (string, optional) Код срочности = [INTERNAL - срочный, INTERNAL_NOTIF - срочный платеж с уведомлением,
OFFHOURS - неотложный, BESP - банковские электронные срочные платежи, NORMAL - срочность не указана]
stringEnum : 1, 2, 3, 4, 5,
vat (Vat, optional) Данные НДС ,
}Vat {
amount (number, optional) Сумма НДС ,
rate (string, optional) Ставка НДС ,
type (string) Способ расчета НДС = [INCLUDED - НДС включен в сумму платежа, NO_VAT - не облагается НДС, MANUAL - ручной ввод НДС]
stringEnum 0, 2, 3
}

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

{
   "amount":1.01,
   "bankComment":"string",
   "bankStatus":"CREATE",
   "date":"2018-12-31",
   "deliveryKind":"электронно",
   "expirationDate":"2019-01-01",
   "externalId":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
   "operationCode":"01",
   "orderNumber":"123",
   "payeeAccount":"40802810600000200000",
   "payeeOrgIdHash":"ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5",
   "paymentNumber":"1",
   "priority":"5",
   "purpose":"Оплата заказа №123. НДС нет.",
   "urgencyCode":"INTERNAL",
   "vat":{
      "amount":0.00,
      "rate":"0",
      "type":"NO_VAT"
   }
}
  • Если требуется проверить неизменность реквизитов получателя платежа, до получения выписки с информацией о проведенном документе, необходимо сравнить хэш реквизитов получателя (crucialFieldsHash), полученные при создании черновика документа, с crucialFieldsHash полученным при запросе статуса документа. Для вычисления значения хэша ключевых полей формируется строка из реквизитов, соединённых между собой: БИК банка получателя, счёт получателя платежа, сумма платежа, (разделитель-точка).

Выставление счета клиенту для любого банка

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

Шаги

1. Получить AccessToken.

2. Отправить запрос.

3. Получить статус.

4. Получить документ.

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

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

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

Header Parameters
Authorization String
Access token организации-клиента, полученный через SSO.
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Body
Invoice {
amount (number) Сумма платежа ,
bankComment (string, optional, read only) Банковский комментарий к статусу документа ,
bankStatus (string, optional, read only) Статус документа ,
crucialFieldsHash (string, optional, read only) Hash от ключевых полей документа ,
date (string) Дата составления документа ,
deliveryKind (string, optional) Вид платежа: электронно, срочно, 0 (если не электронно и не срочно) ,
expirationDate (string, optional) Дата истечения заказа (платёж должен быть подтверждён клиентом) ,
externalId (string) Идентификатор документа, присвоенный партнёром (UUID) ,
operationCode (string, optional) Код операции ,
orderNumber (string, optional) Номер заказа ,
payeeAccount (string) Счёт получателя платежа ,
payeeOrgIdHash (string, optional) Идентификатор получателя платежа ,
paymentNumber (string, optional) Номер платёжного поручения.
Если клиент не ведет в своей учетной системе нумерацию платежных поручений, созданных на основании выставленных счетов, то атрибут можно не передавать, он будет присвоен автоматически ,
priority (string, optional) Очерёдность платежа: 1, 2, 3, 4, 5 ,
purpose (string) Назначение платежа ,
urgencyCode (string, optional) Код срочности = [INTERNAL - срочный, INTERNAL_NOTIF - срочный платеж с уведомлением,
OFFHOURS - неотложный, BESP - банковские электронные срочные платежи, NORMAL - срочность не указана]
stringEnum : 1, 2, 3, 4, 5,
vat (Vat, optional) Данные НДС ,
}Vat {
amount (number, optional) Сумма НДС ,
rate (string, optional) Ставка НДС: 0, 10, 20 ,
type (string) Способ расчета НДС = [INCLUDED - НДС включен в сумму платежа, NO_VAT - не облагается НДС, MANUAL - ручной ввод НДС]
stringEnum: 0, 2, 3
}

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

{
   "amount":1.01,
   "bankComment":"string",
   "bankStatus":"CREATE",
   "date":"2018-12-31",
   "deliveryKind":"электронно",
   "expirationDate":"2019-01-01",
   "externalId":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
   "operationCode":"01",
   "orderNumber":"123",
   "payeeAccount":"40802810600000200000",
   "payeeOrgIdHash":"ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5",
   "paymentNumber":"1",
   "priority":"5",
   "purpose":"Оплата заказа №123. НДС нет.",
   "urgencyCode":"INTERNAL",
   "vat":{
      "amount":0.00,
      "rate":"0",
      "type":"NO_VAT"
   }
}
  • Если требуется проверить неизменность реквизитов получателя платежа, до получения выписки с информацией о проведенном документе, необходимо сравнить хэш реквизитов получателя (crucialFieldsHash), полученные при создании черновика документа, с crucialFieldsHash полученным при запросе статуса документа. Для вычисления значения хэша ключевых полей формируется строка из реквизитов, соединённых между собой: БИК банка получателя, счёт получателя платежа, сумма платежа, (разделитель-точка).

Выставление счета в бюджет

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

Шаги

1. Получить AccessToken.

2. Отправить запрос.

3. Получить статус.

4. Получить документ.

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

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

Ресурс позволяет Партнеру выставлять счет на оплату в адрес клиентов как Сбербанка, так и любого другого банка. На основании выставленных счетов формируются платёжные поручения.

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

Header Parameters
Authorization String
Access token организации-клиента, полученный через SSO.
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Body
Invoice {
amount (number) Сумма платежа ,
bankComment (string, optional, read only) Банковский комментарий к статусу документа ,
bankStatus (string, optional, read only) Статус документа ,
crucialFieldsHash (string, optional, read only) Hash от ключевых полей документа ,
date (string) Дата составления документа ,
deliveryKind (string, optional) Вид платежа
expirationDate (string, optional) Дата истечения заказа (платёж должен быть подтверждён клиентом) ,
externalId (string) Идентификатор документа, присвоенный партнёром (UUID) ,
operationCode (string, optional) Код операции
orderNumber (string, optional) Номер заказа ,
payeeAccount (string) Счёт получателя платежа ,
payeeOrgIdHash (string, optional) Идентификатор получателя платежа ,
paymentNumber (string, optional) Номер платёжного поручения.
Если клиент не ведет в своей учетной системе нумерацию платежных поручений, созданных на основании выставленных счетов, то атрибут можно не передавать, он будет присвоен автоматически ,
priority (string, optional) Очерёдность платежа
purpose (string) Назначение платежа ,
urgencyCode (string, optional) Код срочности = [INTERNAL - срочный, INTERNAL_NOTIF - срочный платеж с уведомлением,
OFFHOURS - неотложный, BESP - банковские электронные срочные платежи, NORMAL - срочность не указана]stringEnum
vat (Vat, optional) Данные НДС
}Vat {
amount (number, optional) Сумма НДС ,
rate (string, optional) Ставка НДС
type (string) Способ расчета НДС = [INCLUDED - НДС включен в сумму платежа, NO_VAT - не облагается НДС, MANUAL - ручной ввод НДС]
stringEnum: 0,2,3 ,
}

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

{
   "amount":1.01,
   "bankComment":"string",
   "bankStatus":"CREATE",
   "date":"2018-12-31",
   "deliveryKind":"электронно",
   "departmentalInfo":{
      "uip":"0",
      "drawerStatus101":"01",
      "kbk":"18210102010011000110",
      "oktmo":"01701000",
      "reasonCode106":"ТП",
      "taxPeriod107":"ГД.00.2018",
      "docNumber108":"123",
      "docDate109":"0",
      "paymentKind110":"1"
   },
   "externalId":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
   "operationCode":"01",
   "payeeAccount":"40802810600000200000",
   "payeeBankBic":"044525225",
   "payeeBankCorrAccount":"30101810400000000225",
   "payeeInn":"7707083893",
   "payeeKpp":"222201001",
   "payeeName":"Общество с ограниченной ответственностью \"Клиент\"",
   "payerKpp":"222201002",
   "paymentNumber":"1",
   "priority":"5",
   "purpose":"Оплата заказа №123. НДС нет.",
   "urgencyCode":"INTERNAL",
   "vat":{
      "amount":0.00,
      "rate":"0",
      "type":"NO_VAT"
   }
}
  • Если требуется проверить неизменность реквизитов получателя платежа, до получения выписки с информацией о проведенном документе, необходимо сравнить хэш реквизитов получателя (crucialFieldsHash), полученные при создании черновика документа, с crucialFieldsHash полученным при запросе статуса документа. Для вычисления значения хэша ключевых полей формируется строка из реквизитов, соединённых между собой: БИК банка получателя, счёт получателя платежа, сумма платежа, (разделитель-точка).

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

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

Шаги

1. Получить AccessToken.

2. Отправить запрос.

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

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

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

Header Parameters
Authorization String
Access token организации-клиента полученный через SSO.
Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1
Query Parameters
externalId String Идентификатор документа, присвоенный клиентом

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

curl -X GET --header "Accept: /" --header "Authorization: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1"

"https://edupirfintech.sberbank.ru:9443/fintech/api/v1/payments/ffffffff-fffa-458e-ad92-fff9497303ba/state"

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

PaymentDocState {
bankComment (string, optional, read only) Банковский комментарий к статусу документа,
bankStatus (string, optional) Статус документа,
channelInfo (string, optional, read only) Комментарий, специфичный для документа, полученного по данному каналу,
crucialFieldsHash (string, optional) Hash от ключевых полей документа
}

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

{

"bankStatus": "CREATED",

"bankComment": null,

"channelInfo": null,

"crucialFieldsHash": "4888bdfe92812ebf1f70aa9be4b8a733"

}

Статусы обработки платежных документов

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

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

Ресурс /v1/payments/{externalId} позволяет Партнеру получить атрибуты ранее отправленного рублевого платежного поручения.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

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

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

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

Header Parameters
Authorization String
Access token полученный через SSO.
Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1
Query Parameters
externalId String
Идентификатор документа, присвоенный партнером

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

curl -X GET --header "Accept: /" --header "Authorization: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1"

"https://edupirfintech.sberbank.ru:9443/fintech/api/v1/payments/ffffffff-fffa-458e-ad92-fff9497303ba/state"

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

Соответствует модели запроса и ответа /v1/payments.

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

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

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

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

Подписание запроса транспортной подписью

Content-Type может содержать одно из двух значений:

  • application/json – запрос без подписи
  • application/jose – запрос, подписанный транспортной подписью

Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).

JWS состоит из:

1. Заголовка (Header)
2. JSON-документа с реквизитным составом платежного поручения (Payload)
3. Подписи запроса (Signature)

Формирование компактной сериализации JWS

JWS формируется из трех составляющих:

Base64Url(Header) || ’.’ ||  Base64Url(Payload) || ’.’ || Base64Url(Signature)

Signature - это подпись данных приватной частью ключевой пары клиента (используется приватный ключ парный сертификату клиента с UUID, указанному в Заголовке (Header) в параметре kid).
Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных:

Base64Url(Header) || ‘.’ || Base64Url(Payload).

Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).

Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования.
Условно это преобразование можно представить следующим образом:

Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)

здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.

Преобразование BASE64URL, отличается от BASE64 преобразования:

BASE64URL BASE64
- (minus) +
_ (underline) /
  • В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data.

В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.

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

Код возврата Описание кода возврата Причина возникновения
201 (POST-запрос) CREATED
Создан
202 (POST-запрос) SC_ACEPTED
Операция не завершена полностью Документ создан, сохранён но не подписан Банком
400 DESERIALIZATION_FAULT
Неверный формат запроса Неверный формат запроса
WORKFLOW_FAULT
Для внешнего сервиса недоступны операции по счету: 40702810ХХХХХХХХХХХХ Для внешнего сервиса недоступны операции по счету:

счет не добавлен в список разрешенных в оферте;
внешний сервис заблокирован в СББОЛ;
счет указан неверно.

Отсутствует доступный открытый рублевый расчетный счет у организации плательщика
Документ с такими реквизитами уже существует Документ с такими реквизитами уже существует. Проверка по номер документа в течении года.
Не указан идентификатор сертификата подписи Не указан идентификатор сертификата подписи(параметр kid заголовка JWS)
Некорректный формат параметра kid заголовка JWS Некорректный формат параметра kid заголовка JWS(ожидается UUID)
VALIDATION_FAULT
Ошибка валидации Ошибка валидации данных запроса с указанием некорректных значений. Значения полей модели или параметров запроса не соответствуют допустимым и определенным в модели.
SIGN_CHECK_EXCEPTION
Подлинность подписи не установлена/Сертификат не обнаружен или не является активным Ошибка возникает, если не удалось установить подлинность подписи
401 UNAUTHORIZED
accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х Указан некорректный или просроченный access_token.
403 ACTION_ACCESS_EXCEPTION
Операция не может быть выполнена: доступ к ресурсу запрещен У пользователя нет прав на использование соответствующего сервиса SberBusinessAPI, доступ к которому не предусмотрен настройками scope; У пользователя отсутствует оферта с внешним сервисом.
404 DATA_NOT_FOUND_EXCEPTION
Платежный документ не найден Неверное значение externalId
415 JWS_EXCEPTED
В соответствии с текущими настройками сервиса с clientId=%s необходимо использовать запрос в формате JWS Compact Serialization Ошибка возникает, если в настройках внешних сервисов выставлен флаг "Требуется подпись для внешнего сервиса"
500 UNKNOWN_EXCEPTION
Внутренняя ошибка сервера

Заметили ошибку?

Выделите текст и нажмите Ctrl + Enter, чтобы сообщить нам о ней