Списание платы за использование сервиса
Ресурс /v1/client-accruals позволяет Партнеру отправлять в банк запрос на списание платы за использование клиентом сервиса. Изначально списание происходит на счет банка, в дальнейшем банк переводит деньги Партнеру.
Шаги
1. При авторизации пользователя партнера передать в scope сервис CLIENT_ACCRUAL.
2. Отправить POST-запрос (/v1/client-accruals), в котором передать авторизационный токен к данным клиента (Access Token). Авторизационный токен передается в параметре Authorization заголовка запроса.
Модель запроса
| Наименование | Описание |
|---|---|
| Параметры заголовка | |
| Authorization (String) | Access token организации-клиента, полученный через SSO Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1 |
| Параметры тела запроса | |
| ClientAccrual { | |
| account (string, optional) | Счет клиента для списания комиссии , |
| amount (number, optional) | Сумма начисления без НДС , |
| amountDebt (number, optional, read only) | Остаток задолженности , |
| amountVat (number, optional) | Сумма НДС , |
| bankComment (string, optional, read only) | Банковский комментарий к статусу , |
| bankStatus (string, optional, read only) | Статус списания денежных средств за начисление = [ ANNULLED, CANCELED, CHECKERROR, CHECKERRORABS, CREATED, DELIVERED, NOT_PROCESSED, NOTPAID, PAID, PARTPAID, REFUSED_BY_LIMIT, REQUISITEERROR, EXPORTED, SENDED, UPLOADERROR, WAITING] stringEnum ANNULLED, CANCELED, CHECKERROR, CHECKERRORABS, CREATED, DELIVERED, NOT_PROCESSED, NOTPAID, PAID, PARTPAID, REFUSED_BY_LIMIT, REQUISITEERROR, EXPORTED, SENDED, UPLOADERROR, WAITING |
| clientId (integer, optional) | Идентификатор сервиса , |
| client (string) | Идентификатор организации , |
| countServiceFact (integer, optional) | Количество фактов потребления услуги за период , |
| dateExpiration (string, optional) | Дата начала взимания пени при просрочке платежа , |
| dateSince (string) | Дата начала периода списания , |
| dateUntil (string) | Дата окончания периода списания , |
| datetimeStatusChange (string, optional, read only) | Дата и время исполнения документа , |
| digestSignatures (Array[Signature]) | Подписи начисления , |
| externalId (string) | Идентификатор начисления, присвоенный партнером (UUID) , |
| purpose (string, optional) | Назначение платежа |
| }Signature { | |
| base64Encoded (string) | Значение электронной подписи, закодированное в Base64 , |
| certificateUuid (string) | Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID) |
| } |
Пример запроса
{
"account":"40802810600000200000",
"amount":1.01,
"amountDebt":1.01,
"amountVat":1.01,
"bankComment":"string",
"bankStatus":"ANNULLED",
"clientId":1005,
"client":"ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5",
"countServiceFact":20,
"dateExpiration":"2018-12-31",
"dateSince":"2018-12-31",
"dateUntil":"2018-12-31",
"datetimeStatusChange":"2018-12-31T23:59:59",
"digestSignatures":[
{
"base64Encoded":"HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId":"22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"purpose":"Оплата заказа №123. НДС нет."
}
Передача электронной подписи
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature (все поля обязательны):
| Наименования поля | Описания поля | Пример |
|---|---|---|
| base64Encoded (string) | Значение ЭП документа | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
| certificateUuid (string) | Идентификатор сертификата, использованного при создании ЭП ( можно узнать, обратившись к ресурсу /v1/crypto) | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
В документе можно передать одну или две ЭП вместе с реквизитами создаваемого документа. Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе СББОЛ.
Документ может быть подписан следующими наборами подписей:
одна (единственная) подпись;
первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очередность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля, когда пользователь Партнера создается в Банке.
Формат дайджеста платежного требования
| Наименование поля | Описание поля |
|---|---|
| client | Идентификатор организации |
| clientId | Идентификатор сервиса |
| externalId | Идентификатор начисления, присвоенный партнером (UUID) |
| account | Счет клиента для списания комиссии |
| dateSince | Дата начала периода списания |
| dateUntil | Дата окончания периода списания |
| countServiceFact | Количество фактов потребления услуги за период |
| amount | Сумма начисления без НДС |
| amountVat | Сумма НДС |
| purpose | Назначение платежа |
| dateExpiration | Дата начала взимания пени при просрочке платежа |
Пример дайджеста
client=ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5
clientId=1005
externalId=22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6
account=40802810600000200000
dateSince=2018-12-31
dateUntil=2018-12-31
countServiceFact=20
amount=1.01
amountVat=1.01
purpose=Оплата заказа №123. НДС нет.
dateExpiration=2018-12-31