X-Payments:Charge again transaction request (Tokenization) - Revision history

Dohtur at 11:59, 24 April 2018

2018-04-24T11:59:04Z

Dohtur: /* Response specification */

2016-12-01T13:59:40Z

‎Response specification

Dohtur: /* Request example */

2016-12-01T13:58:39Z

‎Request example

Dohtur: /* Request example */

2016-12-01T13:56:44Z

‎Request example

Dohtur at 13:55, 1 December 2016

2016-12-01T13:55:44Z

Dohtur at 13:53, 1 December 2016

2016-12-01T13:53:36Z

Dohtur at 13:52, 1 December 2016

2016-12-01T13:52:13Z

Dohtur at 13:41, 26 July 2016

2016-07-26T13:41:33Z

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:43:59Z

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 recharge
|-
| colspan="1" | txnId
| colspan="1" | Y
| colspan="1" | string, 32
| colspan="1" | Unique payment ID which references the token that will be used to identify the payment on the side of the payment gateway
|-
| colspan="1" | amount
| colspan="1" | Y
| colspan="1" | currency
| colspan="1" | The amount for which the "saved" card is to be charged using the token from the previous successful transaction
|-
| colspan="1" | description
| colspan="1" | Y
| colspan="1" | string
| colspan="1" | Description of the transaction
|-
| 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" | refId (supported by API 1.4 and later)
| colspan="1" | N
| colspan="1" | string, 128
| colspan="1" | Order ID in the online store
|}

===Request example===

<pre>
<txnId>e7f398cee98ec062abac0d2c937da181</txnId>
<amount>50.00</amount>
<description>Recurring payment for the new issue of Playboy</description>
<target>payment</target>
<action>recharge</action>
<api_version>1.2</api_version>
</pre>

===Response specification===

{| cellspacing="0" cellpadding="2" border="1"
| colspan="1" | '''Field'''
| colspan="1" | '''Type'''
| colspan="1" | '''Description'''
|-
| colspan="1" | status
| colspan="1" | integer, 1
| colspan="1" | [[#Operation status codes|Operation status code]]
|-
| colspan="1" | data
| colspan="1" | array
| colspan="1" |
|-
| colspan="1" | data[status]
| colspan="1" | integer
| colspan="1" | Status of the new payment (See [[#Payment status codes|Payment status codes]])
|-
| colspan="1" | data[transaction_id]
| colspan="1" | string
| colspan="1" | ID of the created payment for further references (capture/void/refund etc)
|-
| colspan="1" | data[error]
| colspan="1" | string
| colspan="1" |
|-
| colspan="1" | data[error_message]
| colspan="1" | string
| colspan="1" |
|-
| colspan="1" | data[is_error_message]
| colspan="1" | string
| colspan="1" |
|}
<br /><br />

← Older revision		Revision as of 13:59, 1 December 2016
Line 171:		Line 171:
	\|}		\|}
	<br /><br />		<br /><br />
		+
		+	===Response example===
		+
		+	<pre>
		+	<data>
		+	<status>4</status>
		+	<transaction_id>9f0811ad772a86aafb104d03afcb10ec</transaction_id>
		+	<error></error>
		+	<error_message></error_message>
		+	<is_error_message></is_error_message>
		+	<version>3.0.2</version>
		+	</data>
		+	</pre>

@@ Line 76: / Line 76: @@
 <refId>order_1234</refId>
 <callbackUrl>https://example.com/xcart/payment/cc_xpc.php</callbackUrl>;
 <txnId>143079cd2eec1645e332965f374f832a</txnId>
 </pre>

@@ Line 63: / Line 63: @@
 | colspan="1" | N
 | colspan="1" | container
-| colspan="1" | A container with addresses, purchased items, etc. See: [[X-Payments:Payment_initialisation_request) for detailed information | Payment initialization request]]
+| colspan="1" | A container with addresses, purchased items, etc. See: [[X-Payments:Payment_initialisation_request | Payment initialization request]]
 |}

@@ Line 3: / Line 3: @@
 In general, the key features are:
- - The credit card information itself is not stored in any way (neither in X-Payments, nor in the connected shopping cart).
+:* The credit card information itself is not stored in any way (neither in X-Payments, nor in the connected shopping cart).
- - X-Payments stores a tokenized credit card internally. This is gateway-specific information, and, in some cases, it is not available to the connected shopping cart.
+:* X-Payments stores a tokenized credit card internally. This is gateway-specific information, and, in some cases, it is not available to the connected shopping cart.
- - The connected shopping cart can execute payment by token using txnId - a unique ID of the original payment which was processed using the real credit card details.
+:* The connected shopping cart can execute payment by token using txnId - a unique ID of the original payment which was processed using the real credit card details.
 To be able to execute such a request, the following conditions must be met:
- - The payment gateway supports the tokenization feature.
+:* The payment gateway supports the tokenization feature.
- - Tokenization is enabled in the payment configuration in X-Payments (provided that there is such a setting). For example, this is true for Authorize.Net, NetBilling, Beanstream, etc.
+:* Tokenization is enabled in the payment configuration in X-Payments (provided that there is such a setting). For example, this is true for Authorize.Net, NetBilling, Beanstream, etc.
- - The buyer has chosen to save their credit card at checkout, or the card has been saved automatically for subscription/recurring payments.
+:* The buyer has chosen to save their credit card at checkout, or the card has been saved automatically for subscription/recurring payments.
 ===Request specification===

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

@@ Line 169: / Line 169: @@
 | colspan="1" | string
 | colspan="1" |
 |}
 <br /><br />

@@ Line 69: / Line 69: @@
 <pre>
-<txnId>e7f398cee98ec062abac0d2c937da181</txnId>
+<api_version>1.7</api_version>
 <target>payment</target>
 <action>recharge</action>
-<api_version>1.2</api_version>
+<amount>12.99</amount>
 </pre>

@@ Line 1: / Line 1: @@
 <noinclude>{{XP_API_TOC}}</noinclude>
 ===Request specification===
@@ Line 42: / Line 54: @@
 | colspan="1" | string, 128
 | colspan="1" | Order ID in the online store
 |}