Request for order payment completion

The description (WSDL) of the service is located on the test server, which is available at https://3dsec.sberbank.ru/payment/webservices/merchant-loyalty-ws.

The request used for debiting a pre-authorized order is autoCompletion.

In this document, the following data type conventions are used when describing request and response parameters:

A<n> – a sequence of Latin letters of length <n>;
A..<n> – a sequence of Latin letters with a length not exceeding <n>;
N<n> – a sequence of digits of length <n>;
N..<n> – a sequence of digits with a length not exceeding <n>;
AN<n> – a sequence of Latin letters and numbers of fixed length <n>;
AN.. <n> – a sequence of Latin letters and numbers with a length not exceeding <n>;
ANS<n> – a sequence of Latin letters, numbers and characters of fixed length <n>
ANS.. <n> – a sequence of Latin letters, numbers and characters with a length not exceeding <n>;
UTC – date and time, in this case: the date must be passed without specifying the time zone, Moscow time, for the SOAP protocol, the standard encoding xs: dateTime is used.

Request parameters:

Name	Type	Mandatory	Description
`orderId`	ANS36	Yes	Identifier of the order in the payment system. It is unique within the system. The identifier is missing if the order registration failed due to an error detailed in errorCode.
`compositeCompletionAmount`	N..20	Yes	The amount to be debited, consisting of the amount in money and the amount of points. The amount can be equal to or less than the order remaining amount. If zero is passed in this parameter, completion will occur for the entire pre-authorized amount.
`language`	A2	No	Language in the ISO 639-1 encoding. If the language is not specified, the default language defined in the store settings is used.

Response parameters:

Name	Type	Mandatory	Description
`errorCode`	ANS..3	No	Error code.
`errorMessage`	AN..512	No	Error description in the language passed in the `language` parameter in the request.
`pcId`	AN..512	No	Loyalty processing transaction identifier.
`operation`	AN..512	Yes	Operation type, the following values are possible: `PAYMENT`; `AWARD`; `REVERSE`; `REFUND_PAYMENT`; `REFUND_AWARD`.
`transactionId`	AN..512	No	The identifier of the transaction in the payment gateway.
`amount`	N..20	No	Amount in points.
`successful`	AN..512	Yes	A feature of the success of the operation, the following values are possible: `true` (successful); `false` (unsuccessful).

Request example:

<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>

Response example:

<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="Success">
            <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>

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

Request for order payment completion