Quick start

  1. Register your order.
  2. Redirect the buyer to the payment page.
  3. Make an order status request.
  4. Do a reversal a or refund if necessary.

1. Order registration

Order registration is carried out using the method register.do (REST interface)/registerOrder (WSDL interface).

REST interface 

userName=username-api&password=password&amount=15000&returnUrl=https://test.ru

WSDL interface 

<soapenv:Body>
   <mer:registerOrder>
      <order amount="15000">
         <returnUrl>https://test.ru</returnUrl>
      </order>
   </mer:registerOrder>
</soapenv:Body>

2. Redirecting the buyer to the payment page

Redirect the user to formUrl received in response to an order registration request. Below are examples of responses to an order registration request.

REST interface 

{"orderId":"70906e55-7114-41d6-8332-4609dc6590f4","formUrl":"https://3dsec.sberbank.ru/payment/merchants/test/payment_ru.html?mdOrder=70906e55-7114-41d6-8332-4609dc6590f4"}

WSDL interface 

<soap:Body>
   <ns1:registerOrderResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
      <return orderId="05fcbc62-7ee6-4f1a-b3d5-6ca41a982283" errorCode="0" errorMessage="Successful">
         <formUrl>https://3dsec.sberbank.ru/payment/merchants/test/payment_ru.html?mdOrder=05fcbc62-7ee6-4f1a-b3d5-6ca41a982283 </formUrl>
      </return>
   </ns1:registerOrderResponse>
</soap:Body>

3. Request for order status

Send an order status request to the gateway using the method getOrderStatusExtended.do (REST interface)/getOrderStatusExtended (WSDL interface).

REST interface 

orderId=b8d70aa7-bfb3-4f94-b7bb-aec7273e1fce

WSDL interface 

    <soapenv:Body>
       <mer:getOrderStatusExtended>
          <order orderId="942e8534-ac73-4e3c-96c6-f6cc448018f7" language="en">
             <!--Optional:-->
             <merchantOrderNumber> </merchantOrderNumber>
            </order>
       </mer:getOrderStatusExtended>
    </soapenv:Body>

The order status will be returned in the orderSatus parameter.

The order status in the payment system is defined by the value of this parameter. It is missing if the order has not been found. Below is a list of possible values:

  • 0 – order is registered but unpaid;
  • 1 – the pre-authorized amount is held (for two-phase payments);
  • 2 – full authorization of the order amount was carried out;
  • 3 – authorization is canceled;
  • 4 – a refund operation was performed for the transaction;
  • 5 – authorization has been initiated through the access control server of the issuing bank;
  • 6 – authorization is declined.

4. Reversal or refund

After making a payment or holding funds in the buyer's account, you can refund or reverse the payment in personal account.

{(rater>id=rater6|name=Was this page helpful?|type=vote)}