X-Payments:Test connection request

From X-Payments Help
Revision as of 17:40, 26 July 2016 by Dohtur (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
X-Payments API
  1. API versions supported
  2. Samples
  3. API requests
  4. API Requests from the store to X-Payments
    1. Admin area/X-Payments configuration
    2. Payment creation (Regular payment and tokenization)
    3. Payment information
    4. Actions on payments (secondary actions)
  5. Callback requests (web-hooks) from X-Payments to the store
  6. Browser-related
  7. Appendix A. Status codes.
  8. See also

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

Field Required Type Description
target Y string, 128 Must equal connect
action Y string, 128 Must equal test
testCode Y string, 128 Any string
api_version Y string Must equal one of the following: 1.2, 1.3, 1.4, 1.5 etc.


Request example

<target>connect</target>
<action>test</action>
<testCode>123</testCode>

Response specification

Field Type Description
hashCode string MD5 hash of the sent code
error string Error code (if any)
error_message string Error message
is_error_message string Flag indicating the error message presence
version string X-Payments version


Response example

Example of a good response:

<data>
  <hashCode>202cb962ac59075b964b07152d234b70</hashCode>
  <error></error>
  <error_message></error_message>
  <is_error_message></is_error_message>
  <version>3.0.1</version>
</data>

Example of a response with an error:

<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>