Agency API. Payments: различия между версиями

Материал из Центр поддержки системы бронировании
Перейти к навигации Перейти к поиску
(→‎Response)
Строка 3: Строка 3:
 
WSDL is located on URL: http://CLIENT_DOMAIN/wsdev/wsdl.php?version=1.0&for=PaymentInitialization
 
WSDL is located on URL: http://CLIENT_DOMAIN/wsdev/wsdl.php?version=1.0&for=PaymentInitialization
  
−
This query allow to get list of payment gateways to pay specific order.
+
This query allows to get a list of payment gateways to pay a specific order.
 
For each gateway following parameters are retrieved:
 
For each gateway following parameters are retrieved:
−
* Name of gateway
+
* ID of the payment method
−
* Payment charge that will be added to total price of an order
+
* Name of the gateway
−
* URL on which user have to be redirected to enter payment data on gateway side
+
* Payment charge that will be added to the total price of the order
−
* Optional URL on which user is redirected after finish of payment.
+
* URL on which user have to be redirected to enter payment data on the gateway side
 +
* Optional URL on which user is redirected after the payment is finished.
  
 
== Common request / response format ==
 
== Common request / response format ==
Строка 146: Строка 147:
  
 
'''Note: if the ''<RedirectUrl/>'' tag is empty, the ''SelectPayment'' method should be used.'''
 
'''Note: if the ''<RedirectUrl/>'' tag is empty, the ''SelectPayment'' method should be used.'''
 +
 +
== Selecting a payment method ==
 +
 +
WSDL is located on URL: http://CLIENT_DOMAIN/wsdev/wsdl.php?version=1.0&for=SelectPayment
 +
 +
This query allows to select a specific payment method. Currently it is available for Rapida gateway.
 +
 +
== Common request / response format ==
 +
 +
<div class="toccolours mw-collapsible mw-collapsed" style="width:1000px">
 +
==== Request ====
 +
<div class="mw-collapsible-content">
 +
<syntaxhighlight lang="xml" line enclose="div" style="font-size:9pt;background: #F9F9F9; border: 1px dashed #2F6FAB; padding: 10px 5px; margin: 10px 0;">
 +
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ver="http://CLIENT_DOMAIN/wsdev/?version%3D1.0%26for%3DSelectPayment">
 +
  <soapenv:Header/>
 +
  <soapenv:Body>
 +
    <ver:SelectPayment>
 +
      <RequestBin>
 +
        <Request>
 +
          <OrderId>?</OrderId>
 +
          <!--OrderId — Id of booked order. Mandatory-->
 +
          <PaymentMethodId>?</PaymentMethodId>
 +
          <!--PaymentMethodId - ID of the payment method. This parameter can be taken from the PaymentInitialization response. Mandatory-->
 +
        </Request>
 +
        <Source>
 +
          <ClientId>?</ClientId>
 +
          <!--ClientId — Client ID in Nemo. You can to see/add it Admin panel in section "Administration" - "Web service. Authorization". Mandatory-->
 +
          <APIKey>?</APIKey>
 +
          <!--APIKey — Secret access key to Nemo API. You can to see/add it Admin panel in section "Administration" - "Web service. Authorization". Mandatory-->
 +
          <Language>?</Language>
 +
          <!--Language — Example: RU-->
 +
          <Currency>?</Currency>
 +
          <!-- Currency — Example: RUB, EUR-->
 +
        </Source>
 +
      </RequestBin>
 +
    </ver:SelectPayment>
 +
  </soapenv:Body>
 +
</soapenv:Envelope>
 +
</syntaxhighlight>
 +
</div>
 +
</div>
 +
 +
<div class="toccolours mw-collapsible mw-collapsed" style="width:1000px">
 +
 +
==== Response ====
 +
<div class="mw-collapsible-content">
 +
<syntaxhighlight lang="xml" line enclose="div" style="font-size:9pt;background: #F9F9F9; border: 1px dashed #2F6FAB; padding: 10px 5px; margin: 10px 0;">
 +
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://CLIENT_DOMAIN/wsdev/?version%3D1.0%26for%3DSelectPayment">
 +
  <SOAP-ENV:Body>
 +
      <ns1:SelectPaymentResponse>
 +
        <ResponseBin>
 +
            <Response>
 +
              <TransactionId>?</TransactionId>
 +
              <!--TransactionId - ID of the payment transaction in the Nemo system-->
 +
              <PaymentParameters>
 +
                  <PaymentParameter>
 +
                    <Key>Code</Key>
 +
                    <Value>?</Value>
 +
                    <!--Value - payment code number. It is returned by the payment gateway.-->
 +
                  </PaymentParameter>
 +
                  <PaymentParameter>
 +
                    <Key>Timelimit</Key>
 +
                    <Value>2015-01-20 23:59:59</Value>
 +
                    <!--Value - payment time limit for the order-->
 +
                  </PaymentParameter>
 +
                  <PaymentParameter>
 +
                    <Key>Description</Key>
 +
                    <Value>?</Value>
 +
                    <!--Value - a brief description for the client. It may contain the timelimit, payment code or some other information. Can be changed in the payment gateway settings in the Nemo system-->
 +
                  </PaymentParameter>
 +
              </PaymentParameters>
 +
            </Response>
 +
        </ResponseBin>
 +
      </ns1:SelectPaymentResponse>
 +
  </SOAP-ENV:Body>
 +
</SOAP-ENV:Envelope>
 +
</syntaxhighlight>
 +
</div>
 +
</div>
 +
  
 
== См. также ==
 
== См. также ==
  
 
*[[Агентский АПИ]]
 
*[[Агентский АПИ]]

Версия 17:12, 20 января 2015

Getting list of allowed payment gateways

WSDL is located on URL: http://CLIENT_DOMAIN/wsdev/wsdl.php?version=1.0&for=PaymentInitialization

This query allows to get a list of payment gateways to pay a specific order. For each gateway following parameters are retrieved:

  • ID of the payment method
  • Name of the gateway
  • Payment charge that will be added to the total price of the order
  • URL on which user have to be redirected to enter payment data on the gateway side
  • Optional URL on which user is redirected after the payment is finished.

Common request / response format

Request

 1 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ver="http://CLIENT_DOMAIN/wsdev/?version%3D1.0%26for%3DPaymentInitialization">
 2    <soapenv:Header/>
 3    <soapenv:Body>
 4       <ver:InitPayment>
 5          <RequestBin>
 6             <Request>
 7                <OrderId>?</OrderId>
 8                <!--OrderId — Id of booked order. Mandatory--> 
 9                <ReturnUrlToCatch>?</ReturnUrlToCatch>
10                <!--ReturnUrlToCatch - Indicate if it is needed to return URL address to which user will be redirected after payment.-->
11                <!--Optional:--> 
12             </Request>
13             <Source>
14                <ClientId>?</ClientId>
15                <!--ClientId — Client ID in Nemo. You can to see/add it Admin panel in section "Administration" - "Web service. Authorization". Mandatory--> 
16                <APIKey>?</APIKey>
17                <!--APIKey — Secret access key to Nemo API. You can to see/add it Admin panel in section "Administration" - "Web service. Authorization". Mandatory--> 
18                <Language>?</Language>
19                <!--Language — Example: RU--> 
20                <Currency>?</Currency>
21                <!-- Currency — Example: RUB, EUR--> 
22             </Source>
23          </RequestBin>
24       </ver:InitPayment>
25    </soapenv:Body>
26 </soapenv:Envelope>

Response

 1 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://CLIENT_DOMAIN/wsdev/?version%3D1.0%26for%3DPaymentInitialization">
 2    <SOAP-ENV:Body>
 3       <ns1:InitPaymentResponse>
 4          <ResponseBin>
 5             <Response>
 6                <Gateways>
 7                   <Gateway>
 8                      <PaymentMethodId>?</PaymentMethodId>
 9                      <!--PaymentMethodId - ID of the payment method. This parameter can be used in the SelectPayment request-->
10                      <GatewayName>?</GatewayName>
11                      <!--GatewayName — Name of payment gateway. For example: Uniteller -->
12                      <PaymentCharge Currency="?">?</PaymentCharge>
13 	             <!--PaymentCharge — charge which have to be added to the total price. Currency — ISO Currency code, have to be the same as in the request.-->
14                      <RedirectUrl>?</RedirectUrl>
15                      <!--RedirectUrl — URL on which user is redirected to get on gateway payment page-->
16                      <UrlToCatch>?</UrlToCatch>
17 	             <!--UrlToCatch — URL on which user is redirected after payment finishing-->
18                   </Gateway>
19                </Gateways>
20             </Response>
21          </ResponseBin>
22       </ns1:InitPaymentResponse>
23    </SOAP-ENV:Body>
24 </SOAP-ENV:Envelope>

Samples of using

Request

 1 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ver="http://CLIENT_DOMAIN/wsdev/?version%3D1.0%26for%3DPaymentInitialization">
 2    <soapenv:Header/>
 3    <soapenv:Body>
 4       <ver:InitPayment>
 5          <RequestBin>
 6             <Request>
 7                <OrderId>276965</OrderId>
 8                <ReturnUrlToCatch>true</ReturnUrlToCatch>
 9             </Request>
10             <Source>
11                <ClientId>---</ClientId>
12                <APIKey>---</APIKey>
13                <Language>RU</Language>
14                <Currency>RUB</Currency>
15             </Source>
16          </RequestBin>
17       </ver:InitPayment>
18    </soapenv:Body>
19 </soapenv:Envelope>

Response

 1 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://CLIENT_DOMAIN/wsdev/?version%3D1.0%26for%3DPaymentInitialization">
 2    <SOAP-ENV:Body>
 3       <ns1:InitPaymentResponse>
 4          <ResponseBin>
 5             <Response>
 6                <Gateways>
 7                   <Gateway>
 8                      <PaymentMethodId>1075</PaymentMethodId>
 9                      <GatewayName>Uniteller</GatewayName>
10                      <PaymentCharge Currency="RUB">81.54</PaymentCharge>
11                      <RedirectUrl>http://CLIENT_DOMAIN/payment__select_outside?booking_id=276965&amp;one_time_booking_code=PZ7981&amp;method=27</RedirectUrl>
12                      <!--Пример ссылки-->
13                      <UrlToCatch>http://CLIENT_DOMAIN/poffice__bookinfo?&amp;booking_id=276965</UrlToCatch>
14                      <!--Пример ссылки-->
15                   </Gateway>
16                      <Gateway>
17                      <PaymentMethodId>1079</PaymentMethodId>
18                      <GatewayName>Rapida</GatewayName>
19                      <PaymentCharge Currency="RUB">123</PaymentCharge>
20                      <RedirectUrl/>
21                      <UrlToCatch xsi:nil="true"/>
22                   </Gateway>
23                </Gateways>
24             </Response>
25          </ResponseBin>
26       </ns1:InitPaymentResponse>
27    </SOAP-ENV:Body>
28 </SOAP-ENV:Envelope>

Note: if the <RedirectUrl/> tag is empty, the SelectPayment method should be used.

Selecting a payment method

WSDL is located on URL: http://CLIENT_DOMAIN/wsdev/wsdl.php?version=1.0&for=SelectPayment

This query allows to select a specific payment method. Currently it is available for Rapida gateway.

Common request / response format

Request

 1 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ver="http://CLIENT_DOMAIN/wsdev/?version%3D1.0%26for%3DSelectPayment">
 2   <soapenv:Header/>
 3   <soapenv:Body>
 4     <ver:SelectPayment>
 5       <RequestBin>
 6         <Request>
 7           <OrderId>?</OrderId>
 8            <!--OrderId — Id of booked order. Mandatory-->
 9           <PaymentMethodId>?</PaymentMethodId>
10           <!--PaymentMethodId - ID of the payment method. This parameter can be taken from the PaymentInitialization response. Mandatory-->
11         </Request>
12         <Source>
13           <ClientId>?</ClientId>
14            <!--ClientId — Client ID in Nemo. You can to see/add it Admin panel in section "Administration" - "Web service. Authorization". Mandatory-->
15           <APIKey>?</APIKey>
16            <!--APIKey — Secret access key to Nemo API. You can to see/add it Admin panel in section "Administration" - "Web service. Authorization". Mandatory-->
17           <Language>?</Language>
18           <!--Language — Example: RU-->
19           <Currency>?</Currency>
20           <!-- Currency — Example: RUB, EUR-->
21         </Source>
22       </RequestBin>
23     </ver:SelectPayment>
24   </soapenv:Body>
25 </soapenv:Envelope>

Response

 1 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://CLIENT_DOMAIN/wsdev/?version%3D1.0%26for%3DSelectPayment">
 2   <SOAP-ENV:Body>
 3       <ns1:SelectPaymentResponse>
 4          <ResponseBin>
 5             <Response>
 6                <TransactionId>?</TransactionId>
 7                <!--TransactionId - ID of the payment transaction in the Nemo system-->
 8                <PaymentParameters>
 9                   <PaymentParameter>
10                      <Key>Code</Key>
11                      <Value>?</Value>
12                      <!--Value - payment code number. It is returned by the payment gateway.-->
13                   </PaymentParameter>
14                   <PaymentParameter>
15                      <Key>Timelimit</Key>
16                      <Value>2015-01-20 23:59:59</Value>
17                      <!--Value - payment time limit for the order-->
18                   </PaymentParameter>
19                   <PaymentParameter>
20                      <Key>Description</Key>
21                      <Value>?</Value>
22                      <!--Value - a brief description for the client. It may contain the timelimit, payment code or some other information. Can be changed in the payment gateway settings in the Nemo system-->
23                   </PaymentParameter>
24                </PaymentParameters>
25             </Response>
26          </ResponseBin>
27       </ns1:SelectPaymentResponse>
28    </SOAP-ENV:Body>
29 </SOAP-ENV:Envelope>


См. также

Источник — https://support.nemo.travel/index.php?title=Agency_API._Payments&oldid=6514