Payer Authentication Detail Report
This section describes the elements of the Payer Authentication Detail report. Refer to
the for instructions for downloading
the report and additional report information. For more information about the
Business Center
Reporting User GuideReport Element
The
Report
element is the root element of the
report.<Report> <PayerAuthDetails> (PayerAuthDetail+) </PayerAuthDetails> </Report>
Element Name | Description |
---|---|
PayerAuthDetail | Contains the transaction in
the report. For a list of child elements, see <PayerAuthDetail>. |
PayerAuthDetails Element
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE Report SYSTEM "https://api.cybersource.com/reporting/v3/dtds/padr"> <PayerAuthDetails> <PayerAuthDetail> ... </PayerAuthDetail> </PayerAuthDetails>
PayerAuthDetail Element
The
PayerAuthDetail
element contains information about a single
transaction.<PayerAuthDetail> (RequestID) (MerchantID) (RequestDate) (TransactionType) (ProofXML)? (VEReq)? (VERes)? (PAReq)? (PARes)? (AuthInfo)? </PayerAuthDetail>
Element Name | Description | Type & Length |
---|---|---|
RequestID | Unique identifier generated for the transaction. This field
corresponds to the API field. | Numeric (26) |
MerchantID | Merchant ID used for the transaction. | String (30) |
RequestDate | Date on which the transaction was
processed. | DateTime (25) |
ProofXML | Data that includes the date and time of the enrollment
check and the VEReq and VERes elements. This field corresponds to
the consumerAuthenticationInformation.Auth
EnrollReply_proofXML API field. For a list of child
elements, see <ProofXML>. | String (1024) |
VEReq | Verify Enrollment Request (VEReq) is sent by the merchant’s
server to the directory server. The directory server also sends it to
the ACS to determine whether authentication is available for the
customer’s card number. For a list of child elements, see <VEReq>. | |
VERes | Verify Enrollment Response (VERes) is sent by the directory
server. For a list of child elements, see <VERes>. | |
PAReq | Payer Authentication Request message that you send to the ACS through the payment card company. Corresponds to the consumerAuthenticationInformation.payer
AuthEnrollReply_paReq API field.For a list of child elements, see <PAReq>. | |
PARes | Payer Authentication Response message sent by the ACS. For
a list of child elements, see <PARes>. | |
AuthInfo | Address and card verification data. For a list of child
elements, see AuthInfo Element. |
PayerAuthDetail Element
<PayerAuthDetail> <RequestID>0004223530000167905139</RequestID> <MerchantID>example_merchant</MerchantID> <RequestDate>2020-02-09T08:00:09-08:00</RequestDate> <TransactionType>ics_pa_enroll</TransactionType> <ProofXML> ... </ProofXML> <VEReq> ... </VEReq> <VERes> ... </VERes> <PAReq> ... </PAReq> <PARes> ... </PARes> </PayerAuthDetail>
ProofXML Element
The
ProofXML
element contains data that includes the date and time of the
enrollment check and the VEReq and VERes elements. This element corresponds to the
consumerAuthenticationInformation.proofXml
API field.<ProofXML> (Date) (DSURL) (PAN) (AcqBIN) (MerID) (Password) (Enrolled) </ProofXML>
Element Name | Description | Type & Length |
---|---|---|
Date | Date when the proof XML is generated. (Although the date and time should appear sequentially during all stages of the processing of an order, they might not because of differing time zones and synchronization between servers.) | DateTime (25) |
DSURL | URL for the directory server where the
proof XML originated. | String (50) |
PAN | Customer’s masked account number. This
element corresponds to the consumerAuthenticationInformation.payer AuthEnrollReply_proxyPAN
API field. | String (19) |
AcqBIN | First six digits of the acquiring bank’s
identification number. | Numeric (6) |
MerID | Identifier provided by your acquirer; used to login to the
ACS URL. | String (24) |
Password | Merchant's masked authentication password to the ACS; provided by your acquirer.
Applies only to cards issued outside the U.S. | String (8) |
Enrolled | Result of the enrollment check. This field can contain one
of these values: Y : Authentication available.N : Cardholder not participating.U : Unable to authenticate regardless of the reason. | String (1) |
ProofXML Element
<ProofXML> <Date>20200209 08:00:34</Date> <DSURL>https:123.456.789.01:234/DSMsgServlet</DSURL> <PAN>XXXXXXXXXXXX0771</PAN> <AcqBIN>123456</AcqBIN> <MerID>4444444</MerID> <Password /> <Enrolled>Y</Enrolled>> </ProofXML>
VEReq Element
The
VEReq
element contains the enrollment check request data.<VEReq> (PAN) (AcqBIN) (MerID) </VEReq>
Element Name | Description | Type & Length |
---|---|---|
PAN | Customer’s masked account number. This
element corresponds to the consumerAuthenticationInformation.
proxyPan API field. | String (19) |
AcqBIN | First six digits of the acquiring bank’s
identification number. | Numeric (6) |
MerID | Identifier provided by your acquirer; used to log in to the
ACS URL. | String (24) |
VEReq Element
<VEReq> <PAN>XXXXXXXXXXXX0771</PAN> <AcqBIN>123456</AcqBIN> <MerID>example</MerID> </VEReq>
VERes Element
The
VERes
element contains the enrollment check response data.<VERes> (Enrolled) (AcctID) (URL) </VERes>
Element Name | Description | Type & Length |
---|---|---|
Enrolled | Result of the enrollment check. This field
can contain one of these values:
| String (1) |
AcctID | Masked string used by the ACS. | String (28) |
URL | URL of Access Control Server where to send the PAReq. This
element corresponds to the consumerAuthenticationInformation.acsUrl API field. | String (1000) |
VERes Element
<VERes> <Enrolled>Y</Enrolled> <AcctID>NDAxMjAwMTAxMTAwMDc3MQ==</AcctID> <URL>https://www.example_url.com</URL> </VERes>
PAReq Element
The
PAReq
element contains the payer authentication request message. This
element corresponds to the
consumerAuthenticationInformation.pareq
API field.<PAReq> (AcqBIN) (MerID) (Name) (Country) (URL) (XID) (Date) (PurchaseAmount) (AcctID) (Expiry) </PAReq>
Element Name | Description | Type & Length |
---|---|---|
AcqBIN | First six digits of the acquiring
bank’s identification number. | Numeric (6) |
MerID | Identifier provided by your
acquirer; used to log in to the ACS URL. | String (24) |
Name | Merchant’s company name. | String (25) |
Country | Two-character code for the
merchant’s country of operation. | String (2) |
URL | Merchant’s business
website. | String |
XID | Unique transaction identifier
generated for each Payment Authentication Request (PAReq) message. The
PARes sent back by the issuing bank contains the XID of the PAReq. To
ensure that both XIDs are the same, compare it to the XID in the
response. To find all requests related to a transaction, you can also
search transactions for a specific XID. | String (28) |
Date | Date and time of request. (Although the date and time should appear sequentially
during all stages of the processing of an order, they may not
because of differing time zones and synchronization between
servers.) | DateTime (25) |
Purchase Amount | Authorization amount and currency for the transaction. This
element corresponds to the totals of the offer lines or from:
| Amount (15) |
AcctID | Masked string used by the
ACS. | String (28) |
Expiry | Expiration month and year of the
customer’s card. | Number (4) |
PAReq Element
<PAReq> <AcqBIN>123456</AcqBIN> <MerID>444444</MerID> <Name>example</Name> <Country>US</Country> <URL>http://www.example.com</URL> <XID>fr2VCDrbEdyC37MOPfIzMwAHBwE=</XID> <Date>2020-02-09T08:00:34-08:00</Date> <PurchaseAmount>1.00 USD</PurchaseAmount> <AcctID>NDAxMjAwMTAxMTAwMDc3MQ==</AcctID> <Expiry>2309</Expiry> </PAReq>
PARes Element
The
PARes
element contains the payer authentication response.<PARes> (AcqBIN) (MerID) (XID) (Date) (PurchaseAmount) (PAN) (AuthDate) (Status) (CAVV) (ECI) </PARes>
Element Name | Description | Type & Length |
---|---|---|
AcqBIN | First six digits of the acquiring
bank’s identification number. | Numeric (6) |
MerID | Identifier provided by your
acquirer; used to log in to the ACS URL. | String (24) |
XID | XID value returned in the
customer authentication response. This element corresponds to the consumerAuthenticationInformation.xid
and consumerAuthenticationInformation.xid | String (28) |
Date | Date and time of request. (Although the date and time should appear sequentially during all stages of the
processing of an order, they might not because of differing time
zones and synchronization between servers.) | DateTime (25) |
PurchaseAmount | Authorization amount and currency for the transaction. This
element corresponds to the totals of the offer lines or from:
orderInformation.amountDetails.totalAmount | Amount (15) |
PAN | Customer’s masked account number.
This element corresponds to the consumerAuthenticationInformation. proxyPan API field. | String (19) |
AuthDate | Date and time of
request. | DateTime (25) |
Status | Result of the authentication check. This field can contain
one of these values:
| String (1) |
CAVV | CAVV (Visa, American Express,
JCB, Diners Club, Discover, China UnionPay, and Elo) cards = * below) or
AAV (Mastercard, and Maestro cards = ** below) returned in the customer
authentication response. This element corresponds to the consumerAuthenticationInformation.cavv and
consumerAuthenticationInformation.ucaf
AuthenticationData | String (50) |
ECI | Electronic Commerce Indicator
returned in the customer authentication response. This element
corresponds to the consumerAuthenticationInformation.eci
and consumerAuthenticationInformation.ucaf
CollectionIndicator | Numeric (1) |
PARes Element
<PARes> <AcqBIN>123456</AcqBIN> <MerID>4444444</MerID> <XID>Xe5DcjrqEdyC37MOPfIzMwAHBwE=</XID> <Date>2020-02-09T07:59:46-08:00</Date> <PurchaseAmount>1002.00 USD</PurchaseAmount> <PAN>0000000000000771</PAN> <AuthDate>2020-02-09T07:59:46-08:00</AuthDate> <Status>Y</Status> <CAVV>AAAAAAAAAAAAAAAAAAAAAAAAAAA=</CAVV> <ECI>5</ECI> </PARes>
AuthInfo Element
The
AuthInfo
element contains address and card verification information.<AuthInfo> (AVSResult) (CVVResult) </AuthInfo>
Element Name | Description | Type & Length |
---|---|---|
AVSResult | Optional results of the address verification test. | String (1) |
CVVResult | Optional results of the card verification number test. | String (1) |
AuthInfo Element
<AuthInfo> <AVSResult>Y</AVSResult> <CVVResult/>git </AuthInfo>
Report Examples
These examples show a complete transaction: the failed enrollment check (enrolled card) and the
subsequent successful authentication.
For transactions in India, use
transactionProcessor.
Failed Enrollment Check
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE Result SYSTEM "https://api.cybersource.com/reporting/v3/dtd/padr"> <Report> Name="Payer Authentication Detail" Version="1.0” xmlns="https://api.cybersource.com/reporting/v3/dtds/padr" MerchantID="sample_merchant_id" ReportStartDate="2022-02-09T08:00:00-08:00" ReportEndDate="2022-02-10T08:00:00-08:00" <PayerAuthDetails> <PayerAuthDetail> RequestID=”1895549430000167904548” TransactionType=”ics_pa_enroll RequestDate=”2022-02-09T08:00:02-08:00” <ProofXML> <Date>20220209 08:00:34</Date> <DSURL>https:123.456.789.01:234/DSMsgServlet</DSURL> <PAN>XXXXXXXXXXXX0771</PAN> <AcqBIN>123456</AcqBIN> <MerID>4444444</MerID> <Password /> <Enrolled>Y</Enrolled> </ProofXML> <VEReq> <PAN>XXXXXXXXXXXX0771</PAN> <AcqBIN>123456</AcqBIN> <MerID>example</MerID> </VEReq> <VERes> <Enrolled>Y</Enrolled> <AcctID>NDAxMjAwMTAxMTAwMDc3MQ==</AcctID> <URL>https://www.sample_url.com</URL> </VERes> <PAReq> <AcqBIN>123456</AcqBIN> <MerID>example</MerID> <Name>Merchant Name</Name> <Country>US</Country> <URL>http://www.merchant_url.com</URL> <XID>2YNaNGDBEdydJ6WI6aFJWAAHBwE=</XID> <Date>2022-02-09T08:00:34-08:00</Date> <PurchaseAmount>1.00 USD</PurchaseAmount> <AcctID>NDAxMjAwMTAxMTAwMDc3MQ==</AcctID> <Expiry>2309</Expiry> </PAReq> </PayerAuthDetail> </PayerAuthDetails> </Report>
Successful Authentication
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE Result SYSTEM "https://api.cybersource.com/reporting/v3/dtd/padr"> <Report> <PayerAuthDetails> <PayerAuthDetail> RequestID=”1895549900000167904548” TransactionType=”ics_pa_validate” XID=”2YNaNGDBEdydJ6WI6aFJWAAHBwE=” RequestDate=”2022-02-09T08:00:02-08:00” <PARes> <AcqBIN>469216</AcqBIN> <MerID>6678516</MerID> <XID>2YNaNGDBEdydJ6WI6aFJWAAHBwE=</XID> <Date>2020-02-09T07:59:46-08:00</Date> <PurchaseAmount>1.00 USD</PurchaseAmount> <PAN>0000000000000771</PAN> <AuthDate>2022-02-09T07:59:46-08:00</AuthDate> <Status>Y</Status> <CAVV>AAAAAAAAAAAAAAAAAAAAAAAAAAA=</CAVV> <ECI>5</ECI> </PARes> </PayerAuthDetail> </PayerAuthDetails> </Report>