X-Payments:Test connection request - Revision history

Dohtur at 13:40, 26 July 2016

2016-07-26T13:40:11Z

Dohtur: /* Response example */

2016-07-21T10:33:38Z

‎Response example

Dohtur at 10:34, 20 July 2016

2016-07-20T10:34:27Z

Dohtur: Created page with "Use this request to test the connection between the store and X-Payments. It can also help to detect the version of the X-Payments installation and the API version supported b..."

2016-07-20T08:20:04Z

Created page with "Use this request to test the connection between the store and X-Payments. It can also help to detect the version of the X-Payments installation and the API version supported b..."

New page

Use this request to test the connection between the store and X-Payments. It can also help to detect the version of the X-Payments installation and the API version supported by X-Payments.

===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 connect
|-
| colspan="1" | action
| colspan="1" | Y
| colspan="1" | string, 128
| colspan="1" | Must equal test
|-
| colspan="1" | testCode
| colspan="1" | Y
| colspan="1" | string, 128
| colspan="1" | Any string
|-
| 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.
|}
<br />

===Request example===

<pre>
<testCode>123</testCode>
<api_version>1.5</api_version>
<target>connect</target>
<action>test</action>
</pre>

===Response specification===

{| cellspacing="0" cellpadding="2" border="1"
| colspan="1" | '''Field'''
| colspan="1" | '''Type'''
| colspan="1" | '''Description'''
|-
| colspan="1" | hashCode
| colspan="1" | string
| colspan="1" | MD5 hash of the sent code
|-
| colspan="1" | error
| colspan="1" | string
| colspan="1" | Error code (if any)
|-
| colspan="1" | error_message
| colspan="1" | string
| colspan="1" | Error message
|-
| colspan="1" | is_error_message
| colspan="1" | string
| colspan="1" | Flag indicating the error message presence
|-
| colspan="1" | version
| colspan="1" | string
| colspan="1" | X-Payments version
|}
<br />

===Response example===

Example of a good response:
<pre>
<data>
<hashCode>202cb962ac59075b964b07152d234b70</hashCode>
<error></error>
<error_message></error_message>
<is_error_message></is_error_message>
<version>2.2.0</version>
</data>
</pre>

Example of a response with an error:
<pre>
<data>
<error>506</error>
<error_message>Your X-Payments connector module supports API version "1.9". This X-Payments supports the following API versions only: "1.1, 1.2, 1.3, 1.4, 1.5, 1.6".</error_message>
<is_error_message></is_error_message>
</data>
</pre>
<br />

← Older revision		Revision as of 13:40, 26 July 2016
Line 1:		Line 1:
		+	<noinclude>{{XP_API_TOC}}</noinclude>
	Use this request to test the connection between the store and X-Payments. It can also help to detect the version of the X-Payments installation and the API version supported by X-Payments.		Use this request to test the connection between the store and X-Payments. It can also help to detect the version of the X-Payments installation and the API version supported by X-Payments.

@@ Line 71: / Line 71: @@
 Example of a good response:
-<pre>
+<pre style="overflow: scroll">
 <data>
    <hashCode>202cb962ac59075b964b07152d234b70</hashCode>
@@ Line 82: / Line 82: @@
 Example of a response with an error:
-<pre>
+<pre style="overflow: scroll">
 <data>
    <error>506</error>

@@ Line 34: / Line 34: @@
 <pre>
 <target>connect</target>
 <action>test</action>
 </pre>
@@ Line 78: / Line 77: @@
    <error_message></error_message>
    <is_error_message></is_error_message>
-   <version>2.2.0</version>
+   <version>3.0.1</version>
 </data>
 </pre>