X-Payments:Detailed payment and transaction information request

From X-Payments Help
Revision as of 14:42, 15 November 2016 by Dohtur (talk | contribs)
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

Request specification

Field Required Type Description
target Y string, 128 Must equal payment
action Y string, 128 Must equal get_additional_info
txnId Y string, 32 A unique payment ID received in the payment initialisation request response
api_version Y string Must equal one of the following: 1.2, 1.3, 1.4, 1.5 etc.

Request example

<api_version>1.7</api_version>
<target>payment</target>
<action>get_additional_info</action>
<txnId>90d7b9e5834b6c0d817f5f3550756ed9</txnId>

Response specification

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

Response example

<data>
  <payment>
    <status>4</status>
    <message>Payment is charged</message>
    <isFraudStatus>1</isFraudStatus>
    <currency>USD</currency>
    <amount>100.00</amount>
    <authorized>0.00</authorized>
    <chargedAmount>100.00</chargedAmount>
    <capturedAmount>0.00</capturedAmount>
    <capturedAmountAvail>0.00</capturedAmountAvail>
    <voidedAmount>0.00</voidedAmount>
    <voidedAmountAvail>0.00</voidedAmountAvail>
    <refundedAmount>0.00</refundedAmount>
    <refundedAmountAvail>100.00</refundedAmountAvail>
    <fraudAuthorized>0.00</fraudAuthorized>
    <fraudCharged>0.00</fraudCharged>
    <authorizeInProgress>0.00</authorizeInProgress>
    <chargeInProgress>0.00</chargeInProgress>
    <advinfo>
      <Message></Message>
      <txn_id>12479</txn_id>
      <AVS>1: Cardholder name matches</AVS>
      <CVV2>M: CVV2 / CVC2/CVD Match.</CVV2>
    </advinfo>
    <transactionInProgress></transactionInProgress>
    <capturedAmountAvailMin>0.00</capturedAmountAvailMin>
    <capturedAmountAvailGateway>0.00</capturedAmountAvailGateway>
    <capturedAmountAvailMinGateway>0.00</capturedAmountAvailMinGateway>
    <voidedAmountAvailGateway>0.00</voidedAmountAvailGateway>
    <refundedAmountAvailGateway>100.00</refundedAmountAvailGateway>
    <cardValidation>
      <avs_z>0</avs_z>
      <avs_c>1</avs_c>
      <avs_a>0</avs_a>
      <cvv>1</cvv>
    </cardValidation>
    <maskedCardData>
      <first6>411111</first6>
      <last4>1111</last4>
      <type>VISA</type>
      <expire_month>11</expire_month>
      <expire_year>2019</expire_year>
      <cardholder_name></cardholder_name>
    </maskedCardData>
    <saveCard>Y</saveCard>
    <3dsecure>
      <s3d_enrolled></s3d_enrolled>
      <s3d_eci></s3d_eci>
      <s3d_cavv></s3d_cavv>
      <s3d_xid></s3d_xid>
      <s3d_pares></s3d_pares>
      <s3d_error>N</s3d_error>
      <s3d_message></s3d_message>
      <s3d_txnid></s3d_txnid>
      <s3d_authid></s3d_authid>
      <s3d_int_reason>D</s3d_int_reason>
      <s3d_orderid></s3d_orderid>
      <cavv></cavv>
    </3dsecure>
  </payment>
  <transactions type="cell">
    <date>1478018226</date>
    <action>Sale</action>
    <status>Success</status>
    <message>Transaction Normal</message>
    <total>100 USD</total>
    <txnid>116705738</txnid>
    <fields type="cell">
      <name>Authorization number</name>
      <value>ET137771</value>
    </fields>
    <fields type="cell">
      <name>AVS</name>
      <value>1: Cardholder name matches</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>0925049927141111</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>41</value>
    </fields>
    <fields type="cell">
      <name>[Kount] Transaction ID</name>
      <value>P5460K3KNLLH</value>
    </fields>
    <fields type="cell">
      <name>[NoFraud] Decision</name>
      <value>pass</value>
    </fields>
    <fields type="cell">
      <name>[NoFraud] Transaction ID</name>
      <value>jjoegjgh</value>
    </fields>
    <payment_status>Charged</payment_status>
  </transactions>
  <error></error>
  <error_message></error_message>
  <is_error_message></is_error_message>
  <version>3.0.2</version>
</data>


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:

Field Description
[Kount] %%%%%, where %%%%% is some number triggered rule, the number is the number of this rule
[Kount] Auto The status of the transaction in Kount ("R" - review, "D" - declined, "A" - approved)
[Kount] Errors list of errors (if any)
[Kount] Warnings: list of warnings (if any)
[Kount] Score Risk score
[Kount] Transaction ID 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


Retrieved from "https://www.x-payments.com/help/?title=X-Payments:Detailed_payment_and_transaction_information_request&oldid=847"