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

Запрос завершения оплаты заказа

Описание (WSDL) сервиса находится на тестовом сервере, который доступен по адресу https://3dsec.sberbank.ru/payment/webservices/merchant-loyalty-ws.

Для списания суммы ранее предавторизованного заказа используется запрос autoCompletion.

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

  • A<n> – последовательность латинских букв длины <n>;
  • A..<n> – последовательность латинских букв длиной, не превышающей <n>;
  • N<n> – последовательность цифр длины <n>;
  • N..<n> – последовательность цифр длиной, не превышающей <n>;
  • AN<n> – последовательность латинских букв и цифр фиксированной длины <n>;
  • AN..<n> – последовательность латинских букв и цифр длиной, не превышающей <n>;
  • ANS<n> – последовательность латинских букв, цифр и символов фиксированной длины <n>
  • ANS..<n> – последовательность латинских букв, цифр и символов длиной, не превышающей <n>;
  • UTC – дата и время, при этом: дата должна быть передана без указания часового пояса, время московское, для протокола SOAP используется стандартная кодировка xs:dateTime.

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

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

orderId

ANS36

Да

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

compositeCompletionAmount

N..20

Да

Сумма списания, состоящая из суммы в деньгах и суммы баллов. Может быть меньше или равна остатку в заказе.

Если указать в этом параметре ноль, завершение произойдёт на всю предавторизованную сумму.

language

A2

Нет

Язык в кодировке ISO 639-1. Если не указан, будет использован язык, указанный в настройках магазина как язык по умолчанию.

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

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

errorCode

N..2

Нет

Код ошибки.

errorMessage

AN..512

Нет

Описание ошибки на языке, переданном в параметре language в запросе.

pcId

AN..512

Нет

Идентификатор операции в процессинге лояльности.

operation

AN..512

Да

Тип операции, возможны следующие значения:

  • PAYMENT;
  • AWARD;
  • REVERSE;
  • REFUND_PAYMENT;
  • REFUND_AWARD.

transactionId

AN..512

Нет

Идентификатор операции в платёжном шлюзе.

amount

N..20

Нет Сумма в баллах.

successful

AN..512

Да

Признак успешности операции, возможны следующие значения:

  • true (успешно);
  • false (неуспешно).

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:loy="http://engine.paymentgate.ru/webservices/merchant/loyalty">
   <soapenv:Header/>
   <soapenv:Body>
      <loy:autoCompletion>
         <autoCompletionRequest orderId="8ebb4b7b-a976-42e4-92b5-cf4ab4c8adf3" compositeCompletionAmount="50">  
         </autoCompletionRequest>
      </loy:autoCompletion>
   </soapenv:Body>
</soapenv:Envelope>

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

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:autoCompletionResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant/loyalty">
         <return errorCode="0" errorMessage="Успешно">
            <operations xsi:type="ns3:sbrfSpasiboLoyaltyOperation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns3="http://engine.paymentgate.ru/webservices/merchant/loyalty">
               <amount>4975</amount>
               <operation>REFUND_PAYMENT</operation>
               <successful>true</successful>
               <transactionId>1032269</transactionId>
               <pcId>27407238</pcId>
            </operations>
            <operations xsi:type="ns3:sbrfSpasiboLoyaltyOperation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns3="http://engine.paymentgate.ru/webservices/merchant/loyalty">
               <amount>4975</amount>
               <operation>REFUND_AWARD</operation>
               <successful>true</successful>
               <transactionId>1032270</transactionId>
               <pcId>27407239</pcId>
            </operations>
         </return>
      </ns1:autoCompletionResponse>
   </soap:Body>
</soap:Envelope>