X-Payments:Payment initialisation request - Revision history

Dohtur at 13:41, 26 July 2016

2016-07-26T13:41:12Z

Dohtur at 10:43, 20 July 2016

2016-07-20T10:43:18Z

Dohtur at 10:42, 20 July 2016

2016-07-20T10:42:29Z

Dohtur: Created page with "===Request specification=== {| cellspacing="0" cellpadding="2" border="1" | colspan="1" | '''Field''' | colspan="1" | '''Required''' | colspan="1" | '''Type''' | colspan="1"..."

2016-07-20T08:22:40Z

Created page with "===Request specification=== {| cellspacing="0" cellpadding="2" border="1" | colspan="1" | '''Field''' | colspan="1" | '''Required''' | colspan="1" | '''Type''' | colspan="1"..."

New page

===Request specification===

{| cellspacing="0" cellpadding="2" border="1"
| colspan="1" | '''Field'''
| colspan="1" | '''Required'''
| colspan="1" | '''Type'''
| colspan="1" | '''Description'''
|-
| colspan="1" | target
| colspan="1" | Y
| colspan="1" | string, 128
| colspan="1" | Must equal payment
|-
| colspan="1" | action
| colspan="1" | Y
| colspan="1" | string, 128
| colspan="1" | Must equal init
|-
| colspan="1" | confId
| colspan="1" | Y
| colspan="1" | integer
| colspan="1" | Payment module configuration ID
|-
| colspan="1" | refId
| colspan="1" | Y
| colspan="1" | string, 128
| colspan="1" | Order ID in the online store
|-
| colspan="1" | returnUrl
| colspan="1" | Y
| colspan="1" | URL, 255
| colspan="1" | URL of the page to redirect the customer after payment
|-
| colspan="1" | callbackUrl
| colspan="1" | Y
| colspan="1" | URL, 255
| colspan="1" | URL to which X-Payments sends background requests with service information
|-
| colspan="1" | language
| colspan="1" | N
| colspan="1" | code of ISO 639-1 (Alpha-2)
| colspan="1" | Language code. If not specified - en
|-
| colspan="1" | cart
| colspan="1" | Y
| colspan="1" | container
| colspan="1" | A container with addresses description
|-
| colspan="1" | cart/billingAddress
| colspan="1" | Y
| colspan="1" | container
| colspan="1" | A container with the billing address description
|-
| colspan="1" | cart/billingAddress/firstname
| colspan="1" | Y
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/billingAddress/lastname
| colspan="1" | N
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/billingAddress/company
| colspan="1" | N
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/billingAddress/address
| colspan="1" | Y
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/billingAddress/city
| colspan="1" | Y
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/billingAddress/state
| colspan="1" | Y
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/billingAddress/country
| colspan="1" | Y
| colspan="1" | string, 2
| colspan="1" | ISO 3166-1 alpha-2 Country code https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
|-
| colspan="1" | cart/billingAddress/zipcode
| colspan="1" | Y
| colspan="1" | string, 32
| colspan="1" |
|-
| colspan="1" | cart/billingAddress/email
| colspan="1" | Y
| colspan="1" | emai, 255l
| colspan="1" |
|-
| colspan="1" | cart/billingAddress/phone
| colspan="1" | Y
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/billingAddress/fax
| colspan="1" | N
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/shippingAddress
| colspan="1" | Y
| colspan="1" | container
| colspan="1" | A container with the shipping address description
|-
| colspan="1" | cart/shippingAddress/firstname
| colspan="1" | Y
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/shippingAddress/lastname
| colspan="1" | N
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/shippingAddress/company
| colspan="1" | N
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/shippingAddress/address
| colspan="1" | Y
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/shippingAddress/city
| colspan="1" | Y
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/shippingAddress/state
| colspan="1" | Y
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/shippingAddress/country
| colspan="1" | Y
| colspan="1" | string, 2
| colspan="1" | ISO 3166-1 alpha-2 Country code https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
|-
| colspan="1" | cart/shippingAddress/zipcode
| colspan="1" | Y
| colspan="1" | string, 32
| colspan="1" |
|-
| colspan="1" | cart/shippingAddress/email
| colspan="1" | Y
| colspan="1" | email, 255
| colspan="1" |
|-
| colspan="1" | cart/shippingAddress/phone
| colspan="1" | Y
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/shippingAddress/fax
| colspan="1" | N
| colspan="1" | string, 255
| colspan="1" |
|-
| colspan="1" | cart/items
| colspan="1" | Y
| colspan="1" | container
| colspan="1" | A container with product description
|-
| colspan="1" | cart/items/sku
| colspan="1" | Y
| colspan="1" | string, 64
| colspan="1" | SKU (product code)
|-
| colspan="1" | cart/items/name
| colspan="1" | Y
| colspan="1" | string, 255
| colspan="1" | Product name
|-
| colspan="1" | cart/items/price
| colspan="1" | Y
| colspan="1" | currency
| colspan="1" | Product item price
|-
| colspan="1" | cart/items/quantity
| colspan="1" | N
| colspan="1" | integer
| colspan="1" | Ordered number of products. If not specified - 1
|-
| colspan="1" | cart/login
| colspan="1" | Y
| colspan="1" | string, 255
| colspan="1" | Unique customer ID in the online store (login, username, userid, etc.)
|-
| colspan="1" | cart/currency
| colspan="1" | N
| colspan="1" | string, 3
| colspan="1" | Payment currency code (ISO 4217 Alpha-3). If not specified, default payment configuration currency is used
|-
| colspan="1" | cart/shippingCost
| colspan="1" | -
| colspan="1" | currency
| colspan="1" | Shipping cost. By default - 0
|-
| colspan="1" | cart/taxCost
| colspan="1" | -
| colspan="1" | currency
| colspan="1" | Tax amount. By default - 0
|-
| colspan="1" | cart/discount
| colspan="1" | -
| colspan="1" | currency
| colspan="1" | Discount amount. By default - 0
|-
| colspan="1" | cart/totalCost
| colspan="1" | Y
| colspan="1" | currency
| colspan="1" | Total payment amount. Must equal to a sum of cart/items/price * cart/items/quantity + cart/shippingCost + cart/taxCost - cart/discount
|-
| colspan="1" | cart/description
| colspan="1" | -
| colspan="1" | string, 65536
| colspan="1" |
|-
| colspan="1" | cart/merchantEmail
| colspan="1" | Y
| colspan="1" | email, 255
| colspan="1" |
|-
| colspan="1" | cart/forceTransactionType
| colspan="1" | -
| colspan="1" | one of values: A or S or empty A - authorize S - sale
| colspan="1" | A flag of forced Sale or Authorize operation. Overrides the setting from the payment configuration. If the value is empty or the field is omitted, the operation is performed according to the payment configuration settings.
|-
| colspan="1" | api_version
| colspan="1" | Y
| colspan="1" | string
| colspan="1" | Must equal one of the following: 1.2, 1.3, 1.4, 1.5 etc.
|-
| colspan="1" | template (''supported by API 1.3 and later'')
| colspan="1" | N
| colspan="1" | string
| colspan="1" | The name of a template in X-Payments requested by the store. Forces the use of the specified template for the payment. If the string passed in this field does not match any template available in X-Payments, it will be ignored.
|-
| colspan="1" | saveCard (''supported by API 1.3 and later'')
| colspan="1" | N
| colspan="1" | string
| colspan="1" | Customer's choice at checkout ("Y" if customer would like to save the card)
|-
| colspan="1" | cart/kountCustomerUniq (''supported by API 1.6 and later'')
| colspan="1" | N
| colspan="1" | string, 32
| colspan="1" | This field is a unique customer identifier in the Kount system, which is send as a UNIQ field.
|}
 
'''List of template names in X-Payments 2.1.x (API v1.3)''':
:* '''default''': A template for the separate page. Used if the payment form is displayed on a separate page of your checkout process (not iframe).
:* '''fast''': Iframe for X-Cart 4 Fast Lane Checkout. Used for X-Cart 4 with the Fast Lane Checkout module. The payment form is displayed at the last step of the checkout process.
:* '''lite''': Iframe for X-Cart 4 One Page Checkout. Used for X-Cart 4 with the One Page Checkout module. The payment form is displayed in the payment section at checkout.
:* '''magento_iframe''': Iframe for Magento. Use this template for Magento and iframe.
:* '''mobile''': Template for mobile devices. Used with the X-Cart Mobile module.
:* '''xc5''': Iframe for X-Cart 5. Used for X-Cart 5 and iframe.

===Request example===

<pre>
<confId>8</confId>
<refId>1120</refId>
<cart>
<login>customer</login>
<billingAddress>
<firstname>John</firstname>
<lastname>Smith</lastname>
<address>10 Main street</address>
<city>Fillmore</city>
<state>UT</state>
<country>US</country>
<zipcode>84631</zipcode>
<company>IQ testing</company>
<email>bit-bucket@x-cart.com</email>
<phone>927348572</phone>
<fax></fax>
</billingAddress>
<shippingAddress>
<firstname>John</firstname>
<lastname>Smith</lastname>
<address>10 Main street</address>
<city>Fillmore</city>
<state>UT</state>
<country>US</country>
<zipcode>84631</zipcode>
<company>IQ testing</company>
<email>bit-bucket@x-cart.com</email>
<phone>927348572</phone>
<fax></fax>
</shippingAddress>
<items type="cell">
<sku>SKU17513</sku>
<name>Three Stone Princess Cut Diamond Ring</name>
<price>399.99</price>
<quantity>1</quantity>
</items>
<currency>USD</currency>
<shippingCost>15</shippingCost>
<taxCost>0</taxCost>
<discount>0</discount>
<totalCost>414.99</totalCost>
<description>Order(s) #1120</description>
<merchantEmail>bit-bucket@x-cart.com</merchantEmail>
<forceTransactionType></forceTransactionType>
</cart>
<returnUrl>https://example.com/xcart/payment/cc_xpc.php</returnUrl>
<callbackUrl>https://example.com/xcart/payment/cc_xpc.php</callbackUrl>
<language>ru</language>
<target>payment</target>
<action>init</action>
</pre>

===Response specification===

{| cellspacing="0" cellpadding="2" border="1"
| colspan="1" | '''Field'''
| colspan="1" | '''Type'''
| colspan="1" | '''Description'''
|-
| colspan="1" | token
| colspan="1" | string,32
| colspan="1" | Temporary payment token, expires immediately after the customer has submitted the cardholder data form
|-
| colspan="1" | txnId
| colspan="1" | string,32
| colspan="1" | A unique payment ID. Is used for all further requests to this payment through the API.
|}

===Response example===

<pre>
<data>
<token>41b2ef3b34698d4f6ed73151ae7307d2</token>
<txnId>e7f398cee98ec062abac0d2c937da181</txnId>
<error></error>
<error_message></error_message>
</data>
</pre>

← Older revision		Revision as of 13:41, 26 July 2016
Line 1:		Line 1:
		+	<noinclude>{{XP_API_TOC}}</noinclude>
	===Request specification===		===Request specification===

@@ Line 351: / Line 351: @@
 </pre>
-==Response example (error)==
+===Response example (error)===
 <pre>
@@ Line 361: / Line 361: @@
 </pre>
-==Response example (another error)==
+===Response example (another error)===
 <pre>

@@ Line 269: / Line 269: @@
 <pre>
-<confId>8</confId>
+<api_version>1.6</api_version>
-<refId>1120</refId>
+<target>payment</target>
 <cart>
-<login>customer</login>
+    <login>customer</login>
-<billingAddress>
+    <billingAddress>
-<firstname>John</firstname>
+        <firstname>John</firstname>
-<lastname>Smith</lastname>
+        <lastname>Young</lastname>
-<address>10 Main street</address>
+        <address>1610 N Main St</address>
-<city>Fillmore</city>
+        <city>Kissimmee</city>
-<state>UT</state>
+        <state>FL</state>
-<country>US</country>
+        <country>US</country>
-<zipcode>84631</zipcode>
+        <zipcode>34744</zipcode>
-<company>IQ testing</company>
+        <company></company>
-<email>bit-bucket@x-cart.com</email>
+        <email>user@example.com</email>
-<phone>927348572</phone>
+        <phone>18005551234</phone>
-<fax></fax>
+        <fax></fax>
-</billingAddress>
+    </billingAddress>
-<shippingAddress>
+    <shippingAddress>
-<firstname>John</firstname>
+        <firstname>John</firstname>
-<lastname>Smith</lastname>
+        <lastname>Young</lastname>
-<address>10 Main street</address>
+        <address>1610 N Main St</address>
-<city>Fillmore</city>
+        <city>Kissimmee</city>
-<state>UT</state>
+        <state>FL</state>
-<country>US</country>
+        <country>US</country>
-<zipcode>84631</zipcode>
+        <zipcode>34744</zipcode>
-<company>IQ testing</company>
+        <company></company>
-<email>bit-bucket@x-cart.com</email>
+        <email>user@example.com</email>
-<phone>927348572</phone>
+        <phone>18005551234</phone>
-<fax></fax>
+        <fax></fax>
-</shippingAddress>
+    </shippingAddress>
-<items type="cell">
+    <items type="cell">
-<sku>SKU17513</sku>
+        <sku>10022</sku>
-<name>Three Stone Princess Cut Diamond Ring</name>
+        <name>Yoda Plush Backpack</name>
-<price>399.99</price>
+        <price>34.99</price>
-<quantity>1</quantity>
+        <quantity>1</quantity>
-</items>
+    </items>
-<currency>USD</currency>
+    <currency>USD</currency>
-<shippingCost>15</shippingCost>
+    <shippingCost>15.95</shippingCost>
-<taxCost>0</taxCost>
+    <taxCost>0</taxCost>
-<discount>0</discount>
+    <discount>0</discount>
-<totalCost>414.99</totalCost>
+    <totalCost>49.98</totalCost>
-<description>Order(s) #1120</description>
+    <description>Order #100001</description>
-<merchantEmail>bit-bucket@x-cart.com</merchantEmail>
+    <merchantEmail>merchant@example.com</merchantEmail>
-<forceTransactionType></forceTransactionType>
+    <forceTransactionType></forceTransactionType>
 </cart>
-<returnUrl>https://example.com/xcart/payment/cc_xpc.php</returnUrl>
+<returnUrl>https://example.com/xcart/payment/cc_xpc.php</returnUrl>;
-<callbackUrl>https://example.com/xcart/payment/cc_xpc.php</callbackUrl>
+<callbackUrl>https://example.com/xcart/payment/cc_xpc.php</callbackUrl>;
-<language>ru</language>
+<language>en</language>
 </pre>
@@ Line 341: / Line 342: @@
 <pre>
 <data>
-<token>41b2ef3b34698d4f6ed73151ae7307d2</token>
+  <token>1f4aa2c4d4b2261600b080d5ba5f3957</token>
-<txnId>e7f398cee98ec062abac0d2c937da181</txnId>
+  <txnId>918799f09b48fd2e45e9946401c30d52</txnId>
-<error></error>
+  <error></error>
-<error_message></error_message>
+  <error_message></error_message>
 </data>
 </pre>