Request for operation completion with the full pre-authorization amount, monetary funds (depositOrder)

The request used for completing a pre-authorized order is depositOrder. This operation can be performed provided that the merchant has the corresponding permissions in the system.

Use the following URL to connect to the Test Service (WSDL):
https://3dsec.sberbank.ru/payment/webservices/merchant-ws?wsdl.

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

The request parameters are given in table below.

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.
`depositAmount`	N..5	Yes	The amount to be debited in the order currency. Can be less than or equal to the amount of pre-authorization. The amount cannot be less that one ruble.
`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.

If you do not specify the depositAmount parameter, completion will take place for the entire pre-authorized amount.

Response parameters

The response parameters are given in table below.

Name	Type	Mandatory	Description
`errorCode`	N3	No	Error code.
`errorMessage`	AN..512	No	Error description in the language passed in the `language` parameter in the request.

Error codes

Error code	Error text
0	The request has been processed without system errors.
5	The deposit amount exceeds the amount put on hold.
5	The deposit amount must be equal to zero or not less than one roble.
5	Access denied.
5	The user must change the password.
6	Wrong order number.
6	`[orderId]` is empty.
7	Payment must be in the correct state.
7	System error.

Examples

Request example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
    <soapenv:Header/>
    <soapenv:Body>
       <mer:depositOrder>
          <order language="ru" orderId="4302d369-a5e8-4432-a5e5-42acfab52c86" depositAmount="30000">
             <!-- Zero or more repetitions: -->
             <params name="param1" value="paramValue1"/>
          </order>
       </mer:depositOrder>
    </soapenv:Body>
 </soapenv:Envelope>

Response example

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
       <ns1:depositOrderResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
          <return errorCode="6" errorMessage="Invalid order number"/>
       </ns1:depositOrderResponse>
    </soap:Body>
 </soap:Envelope>