Расширенный запрос состояния заказа

Для запроса состояния зарегистрированного заказа используется запрос getOrderStatusExtended.

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

* В запросе необходимо передать или параметр orderId, или merchantOrderNumber. Если в запросе передаются оба параметра, приоритет orderId выше.

Существует несколько наборов параметров ответа. Какие именно наборы параметров будут возвращены, завит от версии getOrderStatusExtended, указанной в настройках мерчанта.

Параметры ответа для версий 01 и выше:

Атрибуты элемента paymentBonus:

Атрибуты элемента awardBonus:

Если в запросе на регистрацию заказа была передана корзина, то в ответе на расширенный запрос о состоянии заказа также передаётся блок orderBundle, содержащий корзину товаров заказа. Описание блока orderBundle представлено ниже. (Актуально для версии getOrderStatusExtended 03 и выше.).

Параметр orderBundle:

Параметры блока customerDetails:

Параметры блока deliveryInfo:

Параметры блока cartItems:

Атрибуты элемента items:

Атрибуты элемента quantity:

Параметры блока itemDetails:

Атрибуты параметра itemDetailsParams:

Параметры блока loyalties:

Коды ошибок (поле errorCode):

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
    <soapenv:Header/>
    <soapenv:Body>
       <mer:getOrderStatusExtended>
          <order orderId="694312ed-9dd1-4178-9009-e1ac1aa5fb92" language=" ">
             <merchantOrderNumber>?</merchantOrderNumber>
          </order>
       </mer:getOrderStatusExtended>
    </soapenv:Body>
 </soapenv:Envelope>

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

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
       <ns1:getOrderStatusExtendedResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
          <return orderNumber="24398" orderStatus="2" actionCode="0" actionCodeDescription="Запрос успешно обработан" amount="30000" currency="643" date="2014-03-06T12:31:29.585+04:00" orderDescription="testCart singlestep" ip="0.0.0.7" errorCode="0" errorMessage="Успешно">
             <merchantOrderParams name="sbrf_spasibo:amount_bonus" value="300"/>
             <attributes name="mdOrder" value="694312ed-9dd1-4178-9009-e1ac1aa5fb92"/>
             <cardAuthInfo maskedPan="478978**1233" expiration="201512" cardholderName="cardholder name" approvalCode="123456"/>
             <authDateTime>2014-03-06T12:31:29.585+04:00</authDateTime>
             <terminalId>999714</terminalId>
             <authRefNum>111111111111</authRefNum>
             <paymentAmountInfo paymentState="DEPOSITED" approvedAmount="30000" depositedAmount="30000" refundedAmount="0"/>
             <bankInfo bankCountryCode="UNKNOWN" bankCountryName="<Неизвестно>"/>
             <orderBundle>
                <orderCreationDate>2013-07-12T13:51:00+04:00</orderCreationDate>
                <customerDetails>
                   <email>johnsmith@mail.ru</email>
                   <phone>89851231234</phone>
                   <contact>Mega Tester</contact>
                   <deliveryInfo>
                      <deliveryType>courier</deliveryType>
                      <country>RU</country>
                      <city>Moscow</city>
                      <postAddress>Земляной Вал 50А стр.2</postAddress>
                   </deliveryInfo>
                </customerDetails>
                <cartItems>
                   <items positionId="3">
                      <name>Warm Grips</name>
                      <itemDetails>
                         <itemDetailsParams name="brand">Noname</itemDetailsParams>
                      </itemDetails>
                      <quantity measure="штук">1.0</quantity>
                      <itemAmount>10000</itemAmount>
                      <itemCurrency>643</itemCurrency>
                      <itemCode>G-16</itemCode>
                   </items>
                   <items positionId="1">
                      <name>Metzeler Enduro 3 Sahara</name>
                      <itemDetails>
                         <itemDetailsParams name="brand">Metzeler</itemDetailsParams>
                         <itemDetailsParams name="radius">17inch</itemDetailsParams>
                      </itemDetails>
                      <quantity measure="штук">1.0</quantity>
                      <itemAmount>10000</itemAmount>
                      <itemCurrency>643</itemCurrency>
                      <itemCode>T-M-14</itemCode>
                      <discount>
                         <discountType>discount</discountType>
                         <discountValue>777</discountValue>
                      </discount>
                   </items>
                   <items positionId="2">
                      <name>Universal Mirror Enduro</name>
                      <itemDetails>
                         <itemDetailsParams name="brand">Noname</itemDetailsParams>
                         <itemDetailsParams name="diameter">12mm</itemDetailsParams>
                      </itemDetails>
                      <quantity measure="штук">1.0</quantity>
                      <itemAmount>10000</itemAmount>
                      <itemCurrency>643</itemCurrency>
                      <itemCode>NM-15</itemCode>
                   </items>
                </cartItems>
             </orderBundle>
             <loyaltyInfo loyaltyName="sbrf_spasibo">
                <paymentBonus approvedAmountBonus="300" depositedAmountBonus="300" refundedAmountBonus="0" pcId="3139154" successful="true" paymentOperation="PAYMENT"/>
                <awardBonus approvedAmountAward="30000" depositedAmountAward="30000" refundedAmountAward="0" pcId="3139155" successful="true" paymentOperation="AWARD"/>
             </loyaltyInfo>
          </return>
       </ns1:getOrderStatusExtendedResponse>
    </soap:Body>
 </soap:Envelope>

Пример ответа для версии getOrderStatusExtended 15 и выше:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:getOrderStatusExtendedResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
         <return orderNumber="1254003" orderStatus="2" actionCode="0" actionCodeDescription="" amount="8234100" currency="643" date="2020-03-18T17:56:54.386+03:00" depositedDate="2020-03-18T18:03:50.859+03:00" orderDescription="Тестовая оплата" ip="84.53.237.7" errorCode="0" errorMessage="Успешно">
            <merchantOrderParams name="sbrf_sbermiles:amount_bonus" value="240500"/>
            <merchantOrderParams name="loyaltyId" value="sbrf_spasibo,sbrf_sbermiles"/>
            <merchantOrderParams name="sbrf_spasibo:amount_bonus" value="1525400"/>
            <merchantOrderParams name="sbrf_spasibo:change_rate" value="1"/>
            <merchantOrderParams name="test" value="test"/>
            <merchantOrderParams name="sbrf_sbermiles:change_rate" value="1.2"/>
            <merchantOrderParams name="client_uuid" value="B0201548AD304A55BA59983882C46B83"/>
            <merchantOrderParams name="new_card_payment" value="true"/>
            <merchantOrderParams name="pay-button" value="true"/>
            <transactionAttributes name="merchantIp" value="84.53.237.7"/>
            <attributes name="mdOrder" value="c559e30a-f363-70cf-9e5a-e5e65e205139"/>
            <cardAuthInfo maskedPan="427601**6080" expiration="202412" cardholderName="CARDHOLDER NAME" approvalCode="123456" paymentSystem="VISA"/>
            <authDateTime>2020-03-18T17:57:45.194+03:00</authDateTime>
            <terminalId>123456</terminalId>
            <authRefNum>243686633625</authRefNum>
            <paymentAmountInfo paymentState="DEPOSITED" approvedAmount="8234100" depositedAmount="8234100" refundedAmount="0" feeAmount="0"/>
            <bankInfo bankName="SBERBANK OF RUSSIA" bankCountryCode="RU" bankCountryName="Россия"/>
            <payerData email="kuznecov@liqu.ru" phone="9040326222"/>
            <orderBundle>
               <customerDetails>
                  <email>kuznecov@liqu.ru</email>
                  <phone>9040326222</phone>
               </customerDetails>
               <cartItems>
                  <items positionId="1">
                     <name>Стиральная машина Siemens WS12T460OE</name>
                     <quantity measure="шт">1.0</quantity>
                     <itemAmount>6587281</itemAmount>
                     <depositedItemAmount>6587281</depositedItemAmount>
                     <itemCurrency>643</itemCurrency>
                     <itemCode>78864</itemCode>
                  </items>
                  <items positionId="2">
                     <name>Услуга - Доставка</name>
                     <quantity measure="шт">1.0</quantity>
                     <itemAmount>823410</itemAmount>
                     <depositedItemAmount>823410</depositedItemAmount>
                     <itemCurrency>643</itemCurrency>
                     <itemCode>0002</itemCode>
                  </items>
                  <items positionId="3">
                     <name>что-то - Доставка</name>
                     <quantity measure="шт">1.0</quantity>
                     <itemAmount>823409</itemAmount>
                     <depositedItemAmount>823409</depositedItemAmount>
                     <itemCurrency>643</itemCurrency>
                     <itemCode>0004</itemCode>
                  </items>
               </cartItems>
               <loyalties>
                  <loyalties loyaltyProgramName="sbrf_spasibo" positionId="1">
                     <bonusAmountForDebit>1220320</bonusAmountForDebit>
                     <bonusAmountForCredit>0</bonusAmountForCredit>
                  </loyalties>
                  <loyalties loyaltyProgramName="sbrf_spasibo" positionId="2">
                     <bonusAmountForDebit>152540</bonusAmountForDebit>
                     <bonusAmountForCredit>0</bonusAmountForCredit>
                  </loyalties>
                  <loyalties loyaltyProgramName="sbrf_spasibo" positionId="3">
                     <bonusAmountForDebit>152540</bonusAmountForDebit>
                     <bonusAmountForCredit>0</bonusAmountForCredit>
                  </loyalties>
                  <loyalties loyaltyProgramName="sbrf_sbermiles" positionId="1">
                     <bonusAmountForDebit>192399</bonusAmountForDebit>
                     <bonusAmountForCredit>0</bonusAmountForCredit>
                  </loyalties>
                  <loyalties loyaltyProgramName="sbrf_sbermiles" positionId="2">
                     <bonusAmountForDebit>24050</bonusAmountForDebit>
                     <bonusAmountForCredit>0</bonusAmountForCredit>
                  </loyalties>
                  <loyalties loyaltyProgramName="sbrf_sbermiles" positionId="3">
                     <bonusAmountForDebit>24051</bonusAmountForDebit>
                     <bonusAmountForCredit>0</bonusAmountForCredit>
                  </loyalties>
               </loyalties>
            </orderBundle>
            <loyaltyInfos loyaltyName="sbrf_sbermiles">
               <paymentBonus approvedAmountBonus="240500" depositedAmountBonus="240500" refundedAmountBonus="0" pcId="81924304" successful="true" paymentOperation="PAYMENT"/>
               <awardBonus approvedAmountAward="8234100" depositedAmountAward="8234100" refundedAmountAward="0" pcId="81924386" successful="true" paymentOperation="AWARD"/>
            </loyaltyInfos>
            <loyaltyInfos loyaltyName="sbrf_spasibo">
               <paymentBonus approvedAmountBonus="1525400" depositedAmountBonus="1525400" refundedAmountBonus="0" pcId="81924303" successful="true" paymentOperation="PAYMENT"/>
               <awardBonus approvedAmountAward="8234100" depositedAmountAward="8234100" refundedAmountAward="0" pcId="81924385" successful="true" paymentOperation="AWARD"/>
            </loyaltyInfos>
            <chargeback>false</chargeback>
            <paymentWay>CARD</paymentWay>
         </return>
      </ns1:getOrderStatusExtendedResponse>
   </soap:Body>
</soap:Envelope>