Инструменты страницы

Запрос проведения рекуррентного платежа

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

  • string – строка;
  • array - массив данных;
  • object - объект данных;
  • data - дата;
  • boolean - булевый (логический) тип данных;
  • int. (integer) - целочисленный тип данных;
  • amount - числовой тип данных (сумма).

Параметры запроса:

Параметр Тип Обязательность Описание Пример

merchantUsername

string

Да

Идентификатор партнёра, полученный при регистрации в РБС.

petrovich

merchantPassword

string

Да

Пароль партнёра, полученный при регистрации в РБС.

!@QWERTY

transactionNumber

string Да

Уникальный номер транзакции на стороне партнёра, необходим для поддержания идемпотентности транзакций.

7654321DS

source

string Да Объект данных источника перевода, для передачи можно указать только binding.

binding

string Да Идентификатор связки. 87414E0F13AB4542AA9D10E81F74A6E3

preAuth

string Нет

Параметр, определяющий необходимость предварительной авторизации (блокирования средств на счету клиента до их списания). Доступны следующие значения:

  • true (истина) - параметр включён, оплата происходит с предавторизацией (происходит блокирование средств клиента до списания);
  • false (ложь) - параметр выключен (списание происходит сразу).

Если параметр не указан в запросе, списание происходит сразу, если указан - необходимо отправить отдельный запрос на завершение.

true

amount

object Да

Объект данных о сумме оплаты.

transactionAmount

amount

Да

Сумма оплаты в минорных единицах валюты (61.00 рублей = 6100).

6100

transactionFee

amount

Нет

Сумма комиссии по оплате в минорных единицах валюты (1.00 рублей = 100).

200

currency

string Да Валюта оплаты. 643

Формат запроса:

POST /api/payment/recurrent HTTP/1.1
Host: web.rbsdev.com/sbersafe
Content-Type: application/json
Accept: application/json; version=1.0
Content-Length: <content-lenght>
{
  "merchantUsername":"<merchantUsername>",
  "merchantPassword":"<merchantPassword>",
  "transactionNumber":"<transactionNumber>",
  "source":{
     "binding":"<binding>"
   },
  "preAuth":<true|false>,
  "amount":{
     "transactionAmount":<transactionAmount>,
     "transactionFee":<transactionFee>,
     "currency":"<currency>"
   }
}

Параметры ответа:

Параметр Тип Обязательность Описание Пример

mdOrder

string Да

Номер заказа в платёжном шлюзе. Уникален в пределах платёжного шлюза.

906bf262-bd53-4ac7-983c-07127954681b

transactionNumber

string Да

Уникальный номер транзакции на стороне партнёра, необходим для поддержания идемпотентности транзакций.

7654321DS

requestId

string Да

Идентификатор запроса

gbhjnkme-rdcfgv-hbjnkm-7689ui-okp3ew

status

string Да

Указание на статус результата обработки запроса

SUCCESS

Формат ответа:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: <content-lenght>
Cache-Control: no-store
    
{
  "mdOrder":"<mdOrder>",
  "transactionNumber":"<transactionNumber>",
  "requestId":"<requestId>",
  "status": "<status>"
}