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



Запрос на проведение рекуррентных платежей (recurrentPayment)

Для регистрации заказа используется запрос recurrentPayment

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

Параметры запроса представлены в таблице ниже.

Название Тип Обязательно Описание

orderNumber

ANS..32

Да

Номер заказа в системе магазина.

bindingId

AN..255

Да

Идентификатор связки, созданной ранее.

amount

N..12

Да

Сумма платежа в минимальных единицах валюты.

feeInput

N..8

Нет

Сумма комиссии в минимальных единицах валюты.

Параметр передается только при включении соответствующей пермиссии.

description

ANS..512

Нет

Описание заказа в свободной форме. В процессинг банка для включения в финансовую отчётность продавца передаются только первые 24 символа этого поля.

Чтобы получить возможность отправлять это поле в процессинг, обратитесь в техническую поддержку.

additionalParameters

Не актуально

Нет

Дополнительные параметры заказа, которые сохраняются для просмотра из личного кабинета продавца. Каждую новую пару имени и значения параметра следует отделять запятой. Ниже представлен пример использования. 

{
    "firstParamName": "firstParamValue",
    "secondParamName": "secondParamValue"
}

Если у продавца настроена фискализация, при указании в качестве дополнительных параметров email (адрес электронной почты покупателя) и/или phone (номер сотового телефона покупателя) эти параметры в первую очередь используются для отправки фискального чека.

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

  • sbrf_spasibo:amount_bonus
  • sbrf_sbermiles:amount_bonus
  • loyaltyId
  • overridenClientId

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

Параметры ответа представлены в таблице ниже.

Название Тип Обязательно Описание

success

A..5

Да

Указывает на успешность запроса. Доступны следующие значения:

  • true (истина) - запрос обработан успешно;
  • false (ложь) - запрос не прошёл.

data

Не актуально

Да

Возвращается, только если платёж прошёл успешно и содержит один вложенный параметр (см. ниже).

orderId

Номер заказа в платежной системе. Уникален в пределах системы. Отсутствует если регистрация заказа не удалась по причине ошибки, детализированной в ErrorCode.

error

Не актуально

Да

Возвращается, только если платёж не прошёл. Ниже представлены вложенные параметры.

code

Код ошибки.

description

Подробное техническое объяснение ошибки - содержимое этого параметра не предназначено для отображения пользователю.

message

Понятное описание ошибки - предназначено для отображения пользователю.

Коды ошибок

Код ошибки Текст ошибки
0

Обработка запроса прошла без системных ошибок.

1

Недостаточно средств на карте.

1

Неверный номер заказа.

2

Связка не найдена.

4
5

Возможность использования связок отключена.

5

Неверная сумма [amount].

5

Неверное имя пользователя.

5 Неверный пароль
5 Ошибка аутентификации
7

Системная ошибка.

10

Заказ с таким номером уже зарегистрирован.

10 Некорректное значение параметра [currency]
10 Некорректное значение параметра [language]
10 Повторяющийся номер заказа
10 Некорректное значение параметра [orderNumber]
10 Некорректное значение параметра [orderDescription]. Ссылки в описании заказа не допускаются

Примеры

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
   <soapenv:Header/>
   <soapenv:Body>
      <mer:recurrentPayment>
         <arg0>
            <orderNumber>123123</orderNumber>
            <bindingId>binding_id</bindingId>
            <amount>123</amount>
            <description>description</description>
            <additionalParameters>
               <entry>
                  <key>firstParamName</key>
                  <value>firstParamName</value>
               </entry>
            </additionalParameters>
         </arg0>
      </mer:recurrentPayment>
   </soapenv:Body>
</soapenv:Envelope>

Пример успешной оплаты

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:recurrentPaymentResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
         <return>
            <success>true</success>
            <data>
               <orderId>134561314642</orderId>
            </data>
            <orderStatus errorCode="0"/>
         </return>
      </ns1:recurrentPaymentResponse>
   </soap:Body>
</soap:Envelope>

Пример неуспешной оплаты

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:recurrentPaymentResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
         <return>
            <success>false</success>
            <error>
               <code>10</code>
               <description>Заказ с таким номером уже зарегистрирован.</description>
            </error>
            <orderStatus errorCode="0"/>
         </return>
      </ns1:recurrentPaymentResponse>
   </soap:Body>
</soap:Envelope>