X-Payments:Detailed payment and transaction information request - Revision history

Dohtur at 11:43, 24 April 2018

2018-04-24T11:43:16Z

Dohtur at 11:37, 24 April 2018

2018-04-24T11:37:24Z

Dohtur at 11:26, 24 April 2018

2018-04-24T11:26:06Z

Dohtur at 11:15, 24 April 2018

2018-04-24T11:15:26Z

Dohtur: /* Response specification */

2016-11-15T13:09:11Z

‎Response specification

Dohtur at 10:42, 15 November 2016

2016-11-15T10:42:26Z

Show changes

Dohtur at 13:42, 26 July 2016

2016-07-26T13:42:20Z

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:27:38Z

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 get_additional_info
|-
| colspan="1" | txnId
| colspan="1" | Y
| colspan="1" | string, 32
| colspan="1" | A unique payment ID received in the payment initialisation request response
|-
| 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.
|}

===Request example===

<pre>
<txnId>e7f398cee98ec062abac0d2c937da181</txnId>
<target>payment</target>
<action>get_additional_info</action>
</pre>

===Response specification===

{| cellspacing="0" cellpadding="2" border="1"
| colspan="1" | '''Field'''
| colspan="1" | '''Type'''
| colspan="1" | '''Description'''
|-
| colspan="1" | payment
| colspan="1" | container
| colspan="1" | Payment information request response
|-
| colspan="1" | transactions
| colspan="1" | container
| colspan="1" | Transaction list
|-
| colspan="1" | transactions/date
| colspan="1" | integer, 11
| colspan="1" | Transaction date (Unix timestamp)
|-
| colspan="1" | transactions/action
| colspan="1" | string, 255
| colspan="1" | Transaction name
|-
| colspan="1" | transactions/status
| colspan="1" | string, 255
| colspan="1" | Transaction status
|-
| colspan="1" | transactions/message
| colspan="1" | string, 65536
| colspan="1" | Gateway transaction message
|-
| colspan="1" | transactions/total
| colspan="1" | string, 32
| colspan="1" | Transaction amount and currency
|-
| colspan="1" | transactions/txnid
| colspan="1" | string, 255
| colspan="1" | Gateway transaction unique ID
|-
| colspan="1" | transactions/payment_status
| colspan="1" | string, 255
| colspan="1" | The payment status after the transaction
|-
| colspan="1" | transactions/fields
| colspan="1" | container
| colspan="1" | Transaction additional fields list
|-
| colspan="1" | transactions/fields/name
| colspan="1" | string, 255
| colspan="1" | Field name
|-
| colspan="1" | transactions/fields/name
| colspan="1" | string, 255
| colspan="1" | Field value
|-
| colspan="1" | payment/cardValidation (API 1.5 and later)
| colspan="1" | container
| colspan="1" | container for Address validation system (AVS)
|-
| colspan="1" | payment/cardValidation/avs_z (API 1.5 and later)
| colspan="1" | string
| colspan="1" | Flag for AVS ZIP-code ("0" - unknown, "1" - matches, "2" - does not match)
|-
| colspan="1" | payment/cardValidation/avs_c (API 1.5 and later)
| colspan="1" | string
| colspan="1" | Flag for AVS cardholder name ("0" - unknown, "1" - matches, "2" - does not match)
|-
| colspan="1" | payment/cardValidation/avs_a (API 1.5 and later)
| colspan="1" | string
| colspan="1" | Flag for AVS street address ("0" - unknown, "1" - matches, "2" - does not match)
|-
| colspan="1" | payment/cardValidation/cvv (API 1.5 and later)
| colspan="1" | string
| colspan="1" | Flag for CVV/CVV2/CVD ("0" - unknown, "1" - matches, "2" - does not match)
|-
| colspan="1" | payment/maskedCardData (API 1.5 and later)
| colspan="1" | container
| colspan="1" | container for Credit Card details (which are allowed to store and display by PA-DSS)
|-
| colspan="1" | payment/maskedCardData/first6 (API 1.5 and later)
| colspan="1" | string
| colspan="1" | First six digits of the credit card number
|-
| colspan="1" | payment/maskedCardData/last4 (API 1.5 and later)
| colspan="1" | string
| colspan="1" | Last four digits of the credit card number
|-
| colspan="1" | payment/maskedCardData/type (API 1.5 and later)
| colspan="1" | string
| colspan="1" | Credit card type: VISA, MC, AMEX, etc
|-
| colspan="1" | payment/maskedCardData/expire_month (API 1.5 and later)
| colspan="1" | string
| colspan="1" | Credit card expiration month
|-
| colspan="1" | payment/maskedCardData/expire_year (API 1.5 and later)
| colspan="1" | string
| colspan="1" | Credit card expiration year
|}

===Response example===

<pre>
<data>
<payment>
<status>2</status>
<message>Payment is authorized</message>
<isFraudStatus>1</isFraudStatus>
<currency>USD</currency>
<amount>10.61</amount>
<authorized>10.61</authorized>
<chargedAmount>0.00</chargedAmount>
<capturedAmount>0.00</capturedAmount>
<capturedAmountAvail>10.61</capturedAmountAvail>
<voidedAmount>0.00</voidedAmount>
<voidedAmountAvail>10.61</voidedAmountAvail>
<refundedAmount>0.00</refundedAmount>
<refundedAmountAvail>0.00</refundedAmountAvail>
<fraudAuthorized>0.00</fraudAuthorized>
<fraudCharged>0.00</fraudCharged>
<authorizeInProgress>0.00</authorizeInProgress>
<chargeInProgress>0.00</chargeInProgress>
<advinfo>
<Message></Message>
<Response code>1</Response>
<txn_id>6583</txn_id>
<Authorization number>ET154399</Authorization>
<AVS>5: Cardholder name incorrect, billing address and postal code match</AVS>
<Bank message>Approved</Bank>
<Bank response code>100</Bank>
<CVV2>M: CVV2 / CVC2/CVD Match.</CVV2>
<Processing status>Transaction Normal</Processing>
<Transarmor Token>8393008475641111</Transarmor>
<[Kount] 702650>Distance from Device to Billing > 1000km</[Kount] 702650>
<[Kount] 702656>Billing Country not equal to BIN Country (Visa/MC)</[Kount] 702656>
<[Kount] 702662>Billing Country not equal to Device Country</[Kount] 702662>
<[Kount] Auto>R</[Kount] Auto>
<[Kount] Errors></[Kount] Errors>
<[Kount] Score>26</[Kount] Score>
<[Kount] Transaction ID>3Z7903KDCTT0</[Kount] Transaction ID>
<[Kount] Warnings></[Kount] Warnings>
</advinfo>
<transactionInProgress></transactionInProgress>
<capturedAmountAvailMin>0.00</capturedAmountAvailMin>
<capturedAmountAvailGateway>10.61</capturedAmountAvailGateway>
<capturedAmountAvailMinGateway>0.00</capturedAmountAvailMinGateway>
<voidedAmountAvailGateway>10.61</voidedAmountAvailGateway>
<refundedAmountAvailGateway>0.00</refundedAmountAvailGateway>
<cardValidation>
<avs_z>1</avs_z>
<avs_c>2</avs_c>
<avs_a>1</avs_a>
<cvv>1</cvv>
</cardValidation>
<maskedCardData>
<first6>411111</first6>
<last4>1111</last4>
<type>VISA</type>
<expire_month>03</expire_month>
<expire_year>2020</expire_year>
</maskedCardData>
</payment>
<transactions type="cell">
<date>1438098759</date>
<action>Authorize</action>
<status>Success</status>
<message>Transaction Normal</message>
<total>10.61 USD</total>
<txnid>57629270</txnid>
<fields type="cell">
<name>Authorization number</name>
<value>ET154399</value>
</fields>
<fields type="cell">
<name>AVS</name>
<value>5: Cardholder name incorrect, billing address and postal code match</value>
</fields>
<fields type="cell">
<name>Bank message</name>
<value>Approved</value>
</fields>
<fields type="cell">
<name>Bank response code</name>
<value>100</value>
</fields>
<fields type="cell">
<name>CVV2</name>
<value>M: CVV2 / CVC2/CVD Match.</value>
</fields>
<fields type="cell">
<name>Processing status</name>
<value>Transaction Normal</value>
</fields>
<fields type="cell">
<name>Transarmor Token</name>
<value>8393008475641111</value>
</fields>
<fields type="cell">
<name>[Kount] 702650</name>
<value>Distance from Device to Billing > 1000km</value>
</fields>
<fields type="cell">
<name>[Kount] 702656</name>
<value>Billing Country not equal to BIN Country (Visa/MC)</value>
</fields>
<fields type="cell">
<name>[Kount] 702662</name>
<value>Billing Country not equal to Device Country</value>
</fields>
<fields type="cell">
<name>[Kount] Auto</name>
<value>R</value>
</fields>
<fields type="cell">
<name>[Kount] Score</name>
<value>26</value>
</fields>
<fields type="cell">
<name>[Kount] Transaction ID</name>
<value>3Z7903KDCTT0</value>
</fields>
<payment_status>Charged</payment_status>
</transactions>
<error></error>
<error_message></error_message>
<is_error_message></is_error_message>
<version>2.2.0</version>
</data>
</pre>

 
''The following pertains to API 1.5 and later:'' 
If the transaction was checked by Kount antifraud screening service, the "advinfo" and "tansaction/fields" containers contain information of kount results. The field names related to Kount start with the [Kount] prefix. The information can be extracted as follows:

{| cellspacing="0" cellpadding="2" border="1"
| colspan="1" | '''Field'''
| colspan="1" | '''Description'''
|-
| colspan="1"| [Kount] %%%%%, where %%%%% is some number
| colspan="1"| triggered rule, the number is the number of this rule
|-
| colspan="1"| [Kount] Auto
| colspan="1"| The status of the transaction in Kount ("R" - review, "D" - declined, "A" - approved)
|-
| colspan="1"| [Kount] Errors
| colspan="1"| list of errors (if any)
|-
| colspan="1"| [Kount] Warnings:
| colspan="1"| list of warnings (if any)
|-
| colspan="1"| [Kount] Score
| colspan="1"| Risk score
|-
| colspan="1"| [Kount] Transaction ID
| colspan="1"| Transaction ID in Kount, can be used to display the direct link to the transaction in Kount, https://awc.test.kount.net/workflow/detail.html?id=%%%%%% for test mode or https://awc.kount.net/workflow/detail.html?id=%%%%%%, where %%%%% should be replaced with the transaction ID
|}

← Older revision		Revision as of 11:26, 24 April 2018
Line 1:		Line 1:
	<noinclude>{{XP_API_TOC}}</noinclude>		<noinclude>{{XP_API_TOC}}</noinclude>
		+
		+	Starting from API version 1.9, the Detailed payment and transaction information request and response are identical to the [[X-Payments:Payment_information_request \| Payment information request and response]].
		+
	===Request specification===		===Request specification===

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

@@ Line 100: / Line 100: @@
 | colspan="1" | string, 255
 | colspan="1" | Field value
 |}

@@ Line 2: / Line 2: @@
 Starting from API version 1.9, the Detailed payment and transaction information request and response are identical to the [[X-Payments:Payment_information_request | Payment information request and response]].
-−
 ===Request specification===
@@ Line 67: / Line 68: @@
 | colspan="1" | transactions/action
 | colspan="1" | string, 255
-| colspan="1" | Transaction name
+| colspan="1" | Transaction name. In API 1.8, for consecutive identical transactions a note "(X attempts)" is added to this field, where X is the number of repetitive transactions.
 | colspan="1" | transactions/status
 | colspan="1" | string, 255

@@ Line 22: / Line 22: @@
 | colspan="1" | string, 32
 | colspan="1" | A unique payment ID received in the payment initialisation request response
 |-
 | colspan="1" | api_version

@@ Line 47: / Line 47: @@
 | colspan="1" | payment
 | colspan="1" | container
-| colspan="1" | Payment information request response
+| colspan="1" | See [[X-Payments:Payment_information_request | Payment information request]]
 |-
 | colspan="1" | transactions
@@ Line 92: / Line 92: @@
 | colspan="1" | string, 255
 | colspan="1" | Field value
 |}