View source for X-Payments:Payment information request

<noinclude>{{XP_API_TOC}}</noinclude>

Starting from API version 1.9, the Payment and transaction information request and response are identical to the [[X-Payments:Detailed_payment_and_transaction_information_request | Detailed payment and transaction information request and response]].

===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_info
|-
| colspan="1" | txnId
| colspan="1" | Y
| colspan="1" | string, 32
| colspan="1" | Unique payment ID
|-
| colspan="1" | refresh
| colspan="1" | N
| colspan="1" | 0 or 1
| colspan="1" | A flag specifying that the data in X-Payments must be overwritten by the data from the payment gateway. By default - 0
|-
| 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>
<api_version>1.7</api_version>
<target>payment</target>
<action>get_info</action>
<txnId>e619c5c346cdc845ba44d00b0e76896a</txnId>
</pre>

===Response specification (API 1.9 and later)===

{| cellspacing="0" cellpadding="2" border="1"
| colspan="1" | '''Field'''
| colspan="1" | '''Type'''
| colspan="1" | '''Description'''
|-
| colspan="1" | payment
| colspan="1" | container
| colspan="1" | Container with [[X-Payments:Payment_information_request#PaymentInfoSpecification | Payment information]]
|-
| 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" | transactions/attempts
| colspan="1" | integer
| colspan="1" | Number of attempts of consecutive identical transactions. 
|-
|}

===Response specification (API 1.8 and earlier)===
Exactly as described by [[X-Payments:Payment_information_request#PaymentInfoSpecification | Payment information specification]] (see below)

<div id="PaymentInfoSpecification"></div>

===Payment information 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" | [[#Payment status codes|Payment status code]]
|-
| colspan="1" | message
| colspan="1" | string, 65536
| colspan="1" | Human readable message containing the payment status
|-
| colspan="1" | isFraudStatus
| colspan="1" | 0 or 1
| colspan="1" | Means that the payment is blocked by the gateway, because the customer has not passed the gateway security check
|-
| colspan="1" | currency
| colspan="1" | string, 3
| colspan="1" | Payment currency code
|-
| colspan="1" | amount
| colspan="1" | currency
| colspan="1" | Payment total
|-
| colspan="1" | authorized
| colspan="1" | currency
| colspan="1" | Authorized payment total
|-
| colspan="1" | chargedAmount
| colspan="1" | currency
| colspan="1" | Charged payment total
|-
| colspan="1" | capturedAmount
| colspan="1" | currency
| colspan="1" | Captured amount of the authorized amount
|-
| colspan="1" | capturedAmountAvail
| colspan="1" | currency
| colspan="1" | Amount that is authorized and can be captured
|-
| colspan="1" | voidedAmount
| colspan="1" | currency
| colspan="1" | Amount that is authorized but voided
|-
| colspan="1" | voidedAmountAvail
| colspan="1" | currency
| colspan="1" | Amount that is authorized and can be voided
|-
| colspan="1" | refundedAmount
| colspan="1" | currency
| colspan="1" | Amount that can be refunded
|-
| colspan="1" | refundedAmountAvail
| colspan="1" | currency
| colspan="1" | Amount that can be refunded
|-
| colspan="1" | fraudAuthorized
| colspan="1" | currency
| colspan="1" | A part of the authorized amount that was blocked by the gateway because the customer had not passed the gateway security check
|-
| colspan="1" | fraudCharged
| colspan="1" | currency
| colspan="1" | A part of the charged amount that was blocked by the gateway because the customer had not passed the gateway security check
|-
| colspan="1" | authorizeInProgress
| colspan="1" | currency
| colspan="1" | A part of the authorized amount that is being handled by the gateway
|-
| colspan="1" | chargeInProgress
| colspan="1" | currency
| colspan="1" | A part of the charged amount that is being handled by the gateway
|-
| colspan="1" | transactionInProgress
| colspan="1" | 0 or 1
| colspan="1" | Are there any payment transactions handled by the gateway?
|-
| colspan="1" | capturedAmountAvailMin
| colspan="1" | currency
| colspan="1" | Minimum amount that can be captured from the authorized amount
|-
| colspan="1" | capturedAmountAvailGateway
| colspan="1" | currency
| colspan="1" | Amount that can be captured from the authorized amount through the gateway
|-
| colspan="1" | capturedAmountAvailMinGateway
| colspan="1" | currency
| colspan="1" | Minimum amount that can be captured from the authorized amount through the gateway
|-
| colspan="1" | voidedAmountAvailGateway
| colspan="1" | currency
| colspan="1" | Amount that can be voided from the authorized amount through the gateway
|-
| colspan="1" | refundedAmountAvailGateway
| colspan="1" | currency
| colspan="1" | Amount that can be refunded from the authorized amount through the gateway
|-
| colspan="1" | txnId
| colspan="1" | string, 32
| colspan="1" | Unique payment ID
|-
| colspan="1" | lastMessage
| colspan="1" | string, 65536
| colspan="1" | Last gateway message
|-
| colspan="1" | error
| colspan="1" | string, 128
| colspan="1" | Error code
|-
| colspan="1" | error_message
| colspan="1" | string, 65536
| colspan="1" | Error message
|-
| colspan="1" | cardValidation (API 1.5 and later)
| colspan="1" | container
| colspan="1" | Container for Address validation system (AVS)
|-
| colspan="1" | cardValidation/avs_z <br />(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" | 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" | 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" | 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" | maskedCardData (API 1.5 and later)
| colspan="1" | container
| colspan="1" | Container for Credit Card details that are allowed to be stored and displayed by PA-DSS
|-
| colspan="1" | maskedCardData/first6 (API 1.5 and later)
| colspan="1" | string
| colspan="1" | First six digits of the credit card number
|-
| colspan="1" | maskedCardData/last4 (API 1.5 and later)
| colspan="1" | string
| colspan="1" | Last four digits of the credit card number
|-
| colspan="1" | maskedCardData/type (API 1.5 and later)
| colspan="1" | string
| colspan="1" | Credit card type: VISA, MC, AMEX, etc
|-
| colspan="1" | maskedCardData/expire_month (API 1.5 and later)
| colspan="1" | string
| colspan="1" | Credit card expiration month
|-
| colspan="1" | maskedCardData/expire_year (API 1.5 and later)
| colspan="1" | string
| colspan="1" | Credit card expiration year
|-
| colspan="1" | saveCard
| colspan="1" | string Y/N
| colspan="1" | Whether the customer chose to save the card for future orders in the shop
|-
| colspan="1" | 3dsecure (API 1.6 and later)
| colspan="1" | container
| colspan="1" | Detailed information about the 3-D Secure check
|-
| colspan="1" | 3dsecure/*
| colspan="1" | string
| colspan="1" | Fields with some specific data obtained from the 3-D Secure provider
|-
| colspan="1" | advInfo
| colspan="1" | container
| colspan="1" | Container with information from the payment processor
|-
| colspan="1" | advInfo/Message
| colspan="1" | string
| colspan="1" | Message from the payment processor; contains error from the payment gateway if the transaction is declined
|-
| colspan="1" | advInfo/txn_id
| colspan="1" | string
| colspan="1" | Transaction ID at the payment gateway end
|-
| colspan="1" | advInfo/AVS
| colspan="1" | string
| colspan="1" | Some information about the AVS (code or message)
|-
| colspan="1" | advInfo/CVV2
| colspan="1" | string
| colspan="1" | Some information about the CVV2 check (code or message)
|-
| colspan="1" | fraudCheckData (API 1.7 and later).
| colspan="1" | container
| colspan="1" | Container with some information related to the anti-fraud check. 
|-
| colspan="1" | fraudCheckData/code
| colspan="1" | string
| colspan="1" | Internal code indicating the service that performed the anti-fraud check. Can be one of the following:<br />- kount: Kount anti-fraud screening service (API 1.7)<br />- nofraud: NoFraud service (API 1.7)<br />- antifraud (API 1.8)<br />- gateway: internal payment gateway anti-fraud check <br />- xpayments: internal X-Payments anti-fraud check
|-
| colspan="1" | fraudCheckData/service
| colspan="1" | string
| colspan="1" | Human-readable name of the service that performed the anti-fraud check.
|-
| colspan="1" | fraudCheckData/result
| colspan="1" | string
| colspan="1" | Formalized result of the anti-fraud check:<br />- 0: Unknown result <br />- 1: Successful result; transaction passed the anti-fraud check <br />- 2: (API 1.7) Transaction should be reviewed by the merchant, or is still being reviewed by the anti-fraud service, and the exact result will be known later. <br />&nbsp;&nbsp;''OR:''<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(API 1.8) Transaction should be reviewed by the merchant.<br />- 3: Anti-fraud check was not passed; the transaction is declined.<br />-4: (API 1.8) Transaction is still being reviewed by the anti-fraud service, and the exact result will be known later.
|-
| colspan="1" | fraudCheckData/transactionId 
| colspan="1" | string
| colspan="1" | Transaction ID at the side of the service that performed the anti-fraud check.
|-
| colspan="1" | fraudCheckData/url
| colspan="1" | string
| colspan="1" | URL to the transcation in the backend of the service that performed the anti-fraud check.
|-
| colspan="1" | fraudCheckData/status 
| colspan="1" | string
| colspan="1" | Status of the anti-fraud check as it was returned by the service which had performed it.
|-
| colspan="1" | fraudCheckData/score
| colspan="1" | string
| colspan="1" | Anti-fraud score as it was calculated by the service which performed the anti-fraud check.
|-
| colspan="1" | fraudCheckData/rules
| colspan="1" | string
| colspan="1" | List of the triggered rules, configured or defined at the side of the service that performed the anti-fraud check. The rules are separated with a line-break.
|-
| colspan="1" | fraudCheckData/errors 
| colspan="1" | string
| colspan="1" | List of errors generated when the check was performed. These errors are returned by the service that performed the anti-fraud check. The errors are separated with a line-break.
|-
| colspan="1" | fraudCheckData/warnings
| colspan="1" | string
| colspan="1" | List of warnings generated when the check was performed. These warnings are returned by the service that performed the anti-fraud check. Warnings are separated with a line-break.
|-
| colspan="1" | fraudCheckData/additionalData (API 1.8)
| colspan="1" | string
| colspan="1" | Some additional data related to the anti-fraud check
|-
| colspan="1" | fraudCheckData/module (API 1.8)
| colspan="1" | string
| colspan="1" | Antifraud service module name: Kount, NoFraud, Signifyd
|}

{{Note|Fields ending in "Gateway" contain amounts that can be used in transactions through the gateway. For example, if a sum of $100 was authorized, and then a capture transaction was emulated for $100, the next refund operation will be available in the emulation mode only. The value of the refundedAmountAvailGateway field will be equal to 0.}}

===Response example===

<pre>
<data>
  <status>4</status>
  <message>Payment is charged</message>
  <isFraudStatus></isFraudStatus>
  <currency>USD</currency>
  <amount>34.99</amount>
  <authorized>0.00</authorized>
  <chargedAmount>34.99</chargedAmount>
  <capturedAmount>0.00</capturedAmount>
  <capturedAmountAvail>0.00</capturedAmountAvail>
  <voidedAmount>0.00</voidedAmount>
  <voidedAmountAvail>0.00</voidedAmountAvail>
  <refundedAmount>0.00</refundedAmount>
  <refundedAmountAvail>34.99</refundedAmountAvail>
  <fraudAuthorized>0.00</fraudAuthorized>
  <fraudCharged>0.00</fraudCharged>
  <authorizeInProgress>0.00</authorizeInProgress>
  <chargeInProgress>0.00</chargeInProgress>
  <advinfo>
    <Message>This transaction was accepted</Message>
    <txn_id>16202</txn_id>
  </advinfo>
  <transactionInProgress></transactionInProgress>
  <capturedAmountAvailMin>0.00</capturedAmountAvailMin>
  <capturedAmountAvailGateway>0.00</capturedAmountAvailGateway>
  <capturedAmountAvailMinGateway>0.00</capturedAmountAvailMinGateway>
  <voidedAmountAvailGateway>0.00</voidedAmountAvailGateway>
  <refundedAmountAvailGateway>34.99</refundedAmountAvailGateway>
  <cardValidation>
    <avs_z>0</avs_z>
    <avs_c>0</avs_c>
    <avs_a>0</avs_a>
    <cvv>0</cvv>
  </cardValidation>
  <maskedCardData>
    <first6>540400</first6>
    <last4>0001</last4>
    <type>MC</type>
    <expire_month>11</expire_month>
    <expire_year>2017</expire_year>
  </maskedCardData>
  <saveCard>N</saveCard>
  <3dsecure>
    <s3d_enrolled>Y</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></s3d_int_reason>
    <s3d_orderid></s3d_orderid>
    <cavv></cavv>
  </3dsecure>
  <fraudCheckData type="cell">
    <code>kount</code>
    <service>KOUNT Antifraud screening service</service>
    <result>2</result>
    <transactionId>P5YM0KV9W8BH</transactionId>
    <url>https://awc.test.kount.net/workflow/detail.html?id=P5YM0KV9W8BH</url>;
    <status>R</status>
    <score>29</score>
    <rules type="cell">702656 Billing Country not equal to BIN Country (Visa/MC)</rules>
  </fraudCheckData>
  <fraudCheckData type="cell">
    <code>nofraud</code>
    <service>NoFraud service</service>
    <result>1</result>
    <transactionId>waakazdi</transactionId>
    <url>https://portal.nofraud.com/transaction/waakazdi</url>;
    <status>pass</status>
  </fraudCheckData>
  <txnId>e619c5c346cdc845ba44d00b0e76896a</txnId>
  <lastMessage>This transaction was accepted</lastMessage>
  <error></error>
  <error_message></error_message>
  <is_error_message></is_error_message>
  <version>3.0.1</version>
</data>
</pre>

===Response example (with error)===

<pre>
<data>
  <error>508</error>
  <error_message>Payment with txn id "e7f398cee98ec062abac0d2c937da181" is not found</error_message>
  <is_error_message></is_error_message>
</data>
</pre>