0% found this document useful (0 votes)

365 views

Payer Authentication SO API

Uploaded by

Shamini Subramaniam

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

365 views

Payer Authentication SO API

Uploaded by

Shamini Subramaniam

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 236

Title Page

CyberSource Payer Authentication

Using the Simple Order API

October 2019

CyberSource Corporation HQ | P.O. Box 8999 | San Francisco, CA 94128-8999 | Phone: 800-530-9095
CyberSource Contact Information
For general information about our company, products, and services, go to
http://www.cybersource.com.

For sales questions about any CyberSource Service, email [email protected] or

call 650-432-7350 or 888-330-2300 (toll free in the United States).

For support information about any CyberSource Service, visit the Support Center at
http://www.cybersource.com/support.

Copyright
© 2019 CyberSource Corporation. All rights reserved. CyberSource Corporation ("CyberSource") furnishes this
document and the software described in this document under the applicable agreement between the reader of
this document ("You") and CyberSource ("Agreement"). You may use this document and/or software only in
accordance with the terms of the Agreement. Except as expressly set forth in the Agreement, the information
contained in this document is subject to change without notice and therefore should not be interpreted in any way
as a guarantee or warranty by CyberSource. CyberSource assumes no responsibility or liability for any errors
that may appear in this document. The copyrighted software that accompanies this document is licensed to You
for use only in strict accordance with the Agreement. You should read the Agreement carefully before using the
software. Except as permitted by the Agreement, You may not reproduce any part of this document, store this
document in a retrieval system, or transmit this document, in any form or by any means, electronic, mechanical,
recording, or otherwise, without the prior written consent of CyberSource.

Restricted Rights Legends

For Government or defense agencies. Use, duplication, or disclosure by the Government or defense agencies
is subject to restrictions as set forth the Rights in Technical Data and Computer Software clause at DFARS
252.227-7013 and in similar clauses in the FAR and NASA FAR Supplement.
For civilian agencies. Use, reproduction, or disclosure is subject to restrictions set forth in subparagraphs (a)
through (d) of the Commercial Computer Software Restricted Rights clause at 52.227-19 and the limitations set
forth in CyberSource Corporation's standard commercial agreement for this software. Unpublished rights
reserved under the copyright laws of the United States.

Trademarks
Authorize.Net, eCheck.Net, and The Power of Payment are registered trademarks of CyberSource Corporation.
CyberSource, CyberSource Payment Manager, CyberSource Risk Manager, CyberSource Decision Manager,
and CyberSource Connect are trademarks and/or service marks of CyberSource Corporation.
All other brands and product names are trademarks or registered trademarks of their respective owners.

2
CONTENTS
Contents

Recent Revisions to This Document 8

About This Guide 12

Audience and Purpose 12
Scope 12
Conventions 13
Note, Important, and Warning Statements 13
Text and Command Conventions 13
Related Documents 14
Customer Support 14

Chapter 1 Introducing Payer Authentication 15

Overview of Chargeback Protection 15
PSD2 16
3D Secure 2.x 16
Prerequisites for Implementing Payer Authentication 16
Integrating Payer Authentication into Your Business 17
Implementing 3D Secure 2.x 18
Scenario 1: You are a New Merchant 18
Scenario 2: You Use the CyberSource Simple Order API and Payer Authentication
Services for 3D Secure 1.0 19
Scenario 3: You Want to Integrate Using an SDK for your Mobile Application 20
Using Secure Acceptance with Payer Authentication 21
Payer Authentication Process 21
Hybrid Integration Process 21
Standard Integration Process 22
SDK Integration Process 23
Required Merchant Information 24

Payer Authentication Using the Simple Order API | October 2019 3

Contents

Chapter 2 Implementing Hybrid Payer Authentication 25

Process Overview 25
Before You Begin 26
Credentials/API Keys 26
Create the JWT 26
Add the JavaScript 26
BIN Detection 26
Implementing Hybrid Payer Authentication 27
Requesting the Check Enrollment Service (Hybrid) 27
Interpreting the Reply 28
Authenticating Enrolled Cards 29
Receiving the Authentication Results 30
Requesting the Validation Service 30
Interpreting the Reply 32
Redirecting Customers to Pass or Fail Message Page 32

Chapter 3 Implementing Standard Payer Authentication 33

Process Overview 33
Before You Begin 34
Credentials/API Keys 34
Create the JWT 34
Add the JavaScript 34
BIN Detection 34
Implementing Standard Payer Authentication 35
Starting Authentication 35
Redirecting Customers to Pass or Fail Message Page 36
Requesting the Check Enrollment Service (Standard) 37

Chapter 4 Implementing SDK Payer Authentication 40

Process Overview 40
Before You Begin 41
Credentials/API Keys 41
Create the JWT 41
Using the Android SDK 42
Update the Gradle Build Properties 42
Configure the Android SDK 42
Set Up the Initial Call 44
Using the iOS SDK 46
Download and Import the SDK 46
Set Up Your Build Environment 46
Configure the iOS SDK 46
Set Up the Initial Call 49

Payer Authentication Using the Simple Order API | October 2019 4

Contents

Implementing SDK Payer Authentication 51

Requesting the Check Enrollment Service (SDK) 51
Interpreting the Reply 52
Authenticating Enrolled Cards 53
Call Cardinal.cca_continue (Android SDK) 53
Call Cardinal session continue (iOS SDK) 55
Receiving the Authentication Results 57
Requesting the Validation Service 57
Interpreting the Reply 59
Redirecting Customers to Pass or Fail Message Page 59

Chapter 5 Upgrading Your Payer Authentication Implementation 60

Upgrading to 3D Secure 2.x 60
Benefits 60
PSD2 Impact 61
Mandates 61
Timelines 61
Recommended Integration 61
Configuration Requirements 62
CyberSource API Calls for Hybrid Integration 63
Configuring Your Web Site 65
Displaying the Authentication Window 65
Using CardinalCommerce JavaScript 65
Testing 67
Migration FAQ 68

Chapter 6 Testing Payer Authentication Services 70

Testing Process 70
Enrollment Check 70
Authentication Validation 71
Expected Results 72
Test Cases for 3D Secure 1.0 74
Visa Secure 74
Mastercard Identity Check 83
Maestro 91
American Express SafeKey 95
JCB J/Secure 101
Diners Club ProtectBuy 107
Discover ProtectBuy 113
Test Cases for 3D Secure 2.x 119
Visa Secure 119
Mastercard Identity Check 126
American Express SafeKey 134
Discover ProtectBuy and Diners Club ProtectBuy 142

Payer Authentication Using the Simple Order API | October 2019 5

Contents

Appendix A API Fields 149

Formatting Restrictions 149
Data Type Definitions 149
Numbered Elements 150
Request Fields 151
Reply Fields 172

Appendix B Reason Codes 191

Appendix C Request and Reply Examples 192

Standard Integration Examples 192
Check Enrollment Request Example 192
Check Enrollment Reply Example 193
Hybrid Integration Examples 194
Check Enrollment Request Example 194
Check Enrollment Reply Example 195
Validate Authentication Request Example 196
Validate Authentication Reply Example 197

Appendix D Web Site Modification Reference 198

Web Site Modification Checklist 198
3D Secure Services Logos 199
Informational Message Examples 200

Appendix E Payer Authentication Transaction Details in the Business Center 201

Searching for Payer Authentication Details 201
Enrolled Card 201
Enrollment Check 201
Authentication Validation 204
Card Not Enrolled 204
Payer Authentication Details 204
Transaction Details 206
Payer Authentication Search 206
Storing Payer Authentication Data 207

Payer Authentication Using the Simple Order API | October 2019 6

Contents

Appendix F Payer Authentication Reports 208

Payer Authentication Summary Report 208
Downloading the Report 209
Matching the Report to the Transaction Search Results 209
Interpreting the Report 210
Comparing Payer Authentication and Payment Reports 211
Payer Authentication Detail Report 212
Report 213
<Result> 213
<PayerAuthDetail> 213
<ProofXML> 215
<VEReq> 216
<VERes> 217
<PAReq> 218
<PARes> 219
<AuthInfo> 221
Examples 222
Failed Enrollment Check 222
Successful Authentication 223

Appendix G Rules-Based Payer Authentication 224

Available Rules 224
API Replies 225
Bypassed Authentication Transactions 225
Risk-Based Bank Transactions 226

Glossary 227

Index 234

Payer Authentication Using the Simple Order API | October 2019 7

REVISIONS
Recent Revisions to This
Document

Release Changes
October 2019 Added 3D Secure 2.x fields. See Appendix A, "API Fields," on page 149.
Note: The 3D Secure 2.x. fields are in beta release. The field descriptions, values, and lengths
are subject to change.
Request fields:
 billTo_httpBrowserColorDepth
 billTo_httpBrowserJavaEnabled
 billTo_httpBrowserJavaScriptEnabled
 billTo_httpBrowserLanguage
 billTo_httpBrowserScreenHeight
 billTo_httpBrowserScreenWidth
 billTo_httpBrowserTimeDifference
 item_#_shippingDestinationTypes
 payerAuthEnrollService_acquirerCountry
 payerAuthEnrollService_acsWindowSize
 payerAuthEnrollService_authenticationIndicator
 payerAuthEnrollService_deviceChannel
 payerAuthEnrollService_merchantFraudRate
 payerAuthEnrollService_merchantScore
 payerAuthEnrollService_priorAuthenticationData
 payerAuthEnrollService_priorAuthenticationMethod
 payerAuthEnrollService_priorAuthenticationReferenceID
 payerAuthEnrollService_priorAuthenticationTime
 payerAuthEnrollService_requestorInitiatedAuthenticationIndicator
 payerAuthEnrollService_sdkMaxTimeout
 payerAuthEnrollService_secureCorporatePaymentIndicator
 payerAuthEnrollService_totalOffersCount
 payerAuthEnrollService_whiteListStatus
 shipTo_destinationTypes

Payer Authentication Using the Simple Order API | October 2019 8

Recent Revisions to This Document

Release Changes
October 2019 Reply fields:
(continued)
 card_bin
 card_cardTypeName
 payerAuthEnrollReply_acsRenderingType
 payerAuthEnrollReply_acsTransactionID
 payerAuthEnrollReply_authenticationStatusReason
 payerAuthEnrollReply_authenticationType
 payerAuthEnrollReply_authorizationPayload
 payerAuthEnrollReply_cardholderMessage
 payerAuthEnrollReply_challengeCancelCode
 payerAuthEnrollReply_challengeRequired
 payerAuthEnrollReply_directoryServerErrorCode
 payerAuthEnrollReply_directoryServerErrorDescription
 payerAuthEnrollReply_effectiveAuthenticationType
 payerAuthEnrollReply_ivrEnabledMessage00
 payerAuthEnrollReply_ivrEncryptionKey
 payerAuthEnrollReply_ivrEncryptionMandatory
 payerAuthEnrollReply_ivrEncryptionType
 payerAuthEnrollReply_ivrLabel
 payerAuthEnrollReply_ivrPrompt
 payerAuthEnrollReply_ivrStatusMessage
 payerAuthEnrollReply_networkScore
 payerAuthEnrollReply_sdkTransactionID
 payerAuthEnrollReply_stepUpUrl
 payerAuthEnrollReply_threeDSServerTransactionID
 payerAuthEnrollReply_whiteListStatus
 payerAuthEnrollReply_whiteListStatusSource
 payerAuthValidateReply_acsRenderingType
 payerAuthValidateReply_acsTransactionID
 payerAuthValidateReply_authenticationStatusReason
 payerAuthValidateReply_authenticationType
 payerAuthValidateReply_authorizationPayload
 payerAuthValidateReply_challengeCancelCode
 payerAuthValidateReply_directoryServerErrorCode
 payerAuthValidateReply_directoryServerErrorDescription

Payer Authentication Using the Simple Order API | October 2019 9

Recent Revisions to This Document

Release Changes
October 2019 Reply fields: (continued)
(continued)
 payerAuthValidateReply_effectiveAuthenticationType
 payerAuthValidateReply_interactionCounter
 payerAuthValidateReply_sdkTransactionID
 payerAuthValidateReply_threeDSServerTransactionID
 payerAuthValidateReply_whiteListStatus
 payerAuthValidateReply_whiteListStatusSource
September 2019  Added a new chapter for SDK integration. See Chapter 4, "Implementing SDK Payer
Authentication," on page 40.
 Removed the Action Codes section from Chapter 3, "Implementing Standard Payer
Authentication," on page 33.
 Updated the "Test Cases for 3D Secure 2.x" for the following:
 Added the e-commerce indicator or ECI to several test cases where it was missing.

 Removed the ECI from "Test Case 2.6: Visa Secure

Card Enrolled: Authentication not Available on Lookup (Hybrid and Standard)" and
corresponding test cases for Mastercard, American Express, and Discover.
 Removed the XID from the Check Enrollment results for "Test Case 2.10a: Visa Secure
Card Enrolled: Successful Step Up Authentication (Hybrid)" and corresponding test cases
for Mastercard, American Express, and Discover.
 In test cases where ECI=7, added vbv_failure as a possible value along with internet for
the e-commerce indicator (Visa test cases only).
 Updated test case titles to include Hybrid and Standard where applicable.
 Removed the Validate Authentication column from Standard-only test cases.
 Added a note and e-commerce indicator values to enable 2.x Discover test cases to be
used for Diners Club ProtectBuy.
 Removed the Step Up Authentication with Merchant Bypass test cases.
 Removed the Incomplete Authentication test cases.
 Renumbered the 2.x test cases.
August 2019 Added a high-level process description of Payer Authentication for the SDK integration. See
"Payer Authentication Process," page 21.
July 2019  Added the Cardinal Cruise Direct Connection API as an integration option. See "Integrating
Payer Authentication into Your Business."
 Changed the name of Mastercard SecureCode to Mastercard Identity Check.
May 2019  Updated the guide to specify that the 3D Secure version and directory server transaction ID
fields must be included in your authorization request if you request payer authentication and
card authorization services separately. See the "Payer Authentication Process" section,
Chapter 2, "Implementing Hybrid Payer Authentication," on page 25 and Chapter 3,
"Implementing Standard Payer Authentication," on page 33.
 Changed the name of Verified by Visa to Visa Secure.
 Updated Appendix E, "Payer Authentication Transaction Details in the Business Center," on
page 201 for the new Business Center.

Payer Authentication Using the Simple Order API | October 2019 10

Recent Revisions to This Document

Release Changes
April 2019  Updated the introduction chapter to include PSD2 information, implementation steps for
various scenarios, and details about using Secure Acceptance with Payer Authentication.
See Chapter 1, "Introducing Payer Authentication," on page 15.
 Added a list of required fields for 3D Secure 2.x. See "Requesting the Check Enrollment
Service (Hybrid)," page 27 and "Requesting the Check Enrollment Service (Standard),"
page 37.
 Updated the "Test Cases for 3D Secure 2.x," page 119.
 Updated required and optional API fields for 3D Secure 2.x. See Appendix A, "API Fields,"
on page 149.
 Updated the following request fields:
 payerAuthEnrollService_challengeCode

 payerAuthEnrollService_fraudActivity
 payerAuthEnrollService_messageCategory
 payerAuthEnrollService_preorder
 payerAuthEnrollService_reorder
 Added the following reply fields:
 payerAuthEnrollReply_challengeRequired

 payerAuthEnrollReply_directoryServer TransactionID
 payerAuthValidateReply_directoryServer TransactionID

Payer Authentication Using the Simple Order API | October 2019 11

ABOUT GUIDE
About This Guide

Audience and Purpose

This guide is written for application developers who want to use the CyberSource Simple
Order API to integrate Payer Authentication services into their order management system.
It describes the tasks you must perform in order to complete this integration.

Implementing CyberSource Payer Authentication services requires software development

skills. You must write code that uses the API request and reply fields to integrate payer
authentication services into your existing order management system.

Scope
This guide describes how to use the Simple Order API to integrate payer authentication
services with your order management system. It does not describe how to get started
using the Simple Order API nor does it explain how to use CyberSource services other
than payer authentication. For that information, see "Related Documents," page 14.

Payer Authentication Using the Simple Order API | October 2019 12

About This Guide

Conventions

Note, Important, and Warning Statements

A Note contains helpful suggestions or references to material not contained in

this document.
Note

An Important statement contains information essential to successfully

completing a task or learning a concept.
Important

A Warning contains information or instructions, which, if not heeded, can result

in a security risk, irreversible loss of data, or significant cost in time or revenue
Warning or both.

Text and Command Conventions

Convention Usage
bold  Field and service names in text. For example:
Include the ics_applications field.
 Items that you are instructed to act upon. For example:
Click Save.
italic  Filenames and pathnames. For example:
Add the filter definition and mapping to your web.xml file.
 Placeholder variables for which you supply particular values.
Screen text  XML elements.
 Code examples and samples.
 Text that you enter in an API environment. For example:
 Set the davService_run field to true.

Payer Authentication Using the Simple Order API | October 2019 13

About This Guide

Related Documents
 Getting Started with CyberSource Advanced for the Simple Order API describes how
to get started using the Simple Order API. (PDF | HTML)

 Decision Manager Developer Guide Using the Simple Order API describes how to
integrate Decision Manager, a fraud detection service, with your order management
system. (PDF | HTML)

 Credit Card Services Using the Simple Order API describes how to integrate
CyberSource payment processing services into your business. (PDF | HTML)

 Secure Acceptance Hosted Checkout Integration Guide describes how to create

Secure Acceptance profiles, which enable you to integrate your order management
system with the Secure Acceptance web/mobile checkout. (PDF | HTML)

 Secure Acceptance Checkout API Integration Guide describes how to create Secure
Acceptance profiles, which enable you to integrate your order management system
with a web site to process transactions. (PDF | HTML)

 Reporting Developer Guide describes how to view and configure Business Center
reports. (PDF | HTML)

 The CyberSource API Versions page provides information about the CyberSource API
versions.

Refer to the Support Center for complete CyberSource technical documentation:

http://www.cybersource.com/support_center/support_documentation

Customer Support
For support information about any CyberSource service, visit the Support Center:
http://www.cybersource.com/support

Payer Authentication Using the Simple Order API | October 2019 14

CHAPTER
Introducing Payer
Authentication
1

CyberSource Payer Authentication services use JavaScript and the ICS services to
provide authentication.

Payer Authentication services enable you to add support to your web store for card
authentication services, including Visa SecureSM, Mastercard Identity Check®, Maestro®
(UK Domestic and international), American Express SafeKeySM, JCB J/Secure™, Diners
Club ProtectBuy, and Discover ProtectBuy.

These card authentication services deter unauthorized card use and protect you from
fraudulent chargeback activity referred to as liability shift. However, CyberSource Payer
Authentication is not a fraud management service, such as Decision Manager with
Advanced Fraud Screen. CyberSource recommends that you implement a comprehensive
fraud management program in addition to payer authentication services.

You can use payer authentication services with specific payment processors. To find out if
your payment processor supports this feature, see the “Payer Authentication” section in
Credit Card Services Using the Simple Order API (PDF | HTML).

Overview of Chargeback Protection

Visa, Mastercard, Maestro, American Express, JCB, Diners Club, and Discover offer
chargeback protection if merchants participate in 3D Secure card authentication
programs, such as Visa Secure or Mastercard Identity Check.

Chargebacks occur after a transaction is processed, and how they are handled varies
according to the region that issued the card. Payment card company rules might vary over
time and across geographical regions. CyberSource recommends that you contact your
merchant account provider to find out exactly how to interpret chargeback requirements
and which chargeback protections are offered.

Payer Authentication Using the Simple Order API | October 2019 15

Chapter 1 Introducing Payer Authentication

PSD2
PSD2 (Payment Service Directive 2) is the new European regulatory framework that
governs payment processing and customer security and authentication. PSD2 establishes
a European Economic Area (EEA) single market for payments (including the UK even if
departed from the EEA) to encourage safer and more innovative payment services. PSD2
mandates Strong Customer Authentication (SCA) for all electronic payments. This
requirement affects the way merchants receive payments from customers and how
customers are authenticated. PSD2 stipulates that two-factor authentication be applied for
all electronic payments.

3D Secure 2.x
3D Secure 2.x is the authentication protocol provided by the card networks to support
SCA. To comply with SCA, merchants must deploy 3D Secure 2.x to their checkout page
or use a compliant hosted checkout.

Additional data can be passed in now and will be automatically sent to issuers as they
upgrade to 3D Secure 2.x. CyberSource Payer Authentication service is also backward-
compatible with 3D Secure 1.0.

Prerequisites for Implementing Payer

Authentication
To use the payer authentication services, you and your developers must be able to
complete these tasks:
 Write code to enable a connection to the issuing bank.
 Add JavaScript to your website to facilitate the authentication.
 Add specific data to your API requests to CyberSource.
 Validate the necessary data.
 Provide the additional data to the authorization request.
 Modify your web site to help the customer understand the process.

Payer Authentication Using the Simple Order API | October 2019 16

Chapter 1 Introducing Payer Authentication

Integrating Payer Authentication into Your

Business
You can integrate payer authentication services into your existing business processes
whether you are currently using 3D Secure 1.0 or are new to payer authentication.

Four types of integration are available:

 Hybrid integration
 Standard integration
 SDK integration for your mobile application
 Cardinal Cruise Direct Connection API

For information on the Cardinal Cruise Direct Connection API, see the JavaScript
Documentation. For any questions, contact CardinalCommerce Customer Support
directly.

If you are using tokenization, you must use the Hybrid integration method.
The SDK integration is designed for 3D Secure 2.x transactions only.
Note

You can also use Secure Acceptance to enable 3D Secure 2.x for payer authentication
services. For more information, see "Using Secure Acceptance with Payer
Authentication."

The beginning chapters of this book provide an overview of the payer authentication
process for Standard, Hybrid, and SDK integrations. For further details, see:

 Chapter 2, "Implementing Hybrid Payer Authentication," on page 25

 Chapter 3, "Implementing Standard Payer Authentication," on page 33

 Chapter 4, "Implementing SDK Payer Authentication," on page 40

If you are a merchant who is currently using 3D Secure 1.0, see:

 Chapter 5, "Upgrading Your Payer Authentication Implementation," on page 60

Payer Authentication Using the Simple Order API | October 2019 17

Chapter 1 Introducing Payer Authentication

Implementing 3D Secure 2.x

This section describes the implementation steps for various scenarios.

Scenario 1: You are a New Merchant

Step 1 Contact your CyberSource account manager or sales manager to learn more about 3D
Secure 2.x and PSD2.

Step 2 Set up your merchant ID with CyberSource.

a Contact Customer Support to enable 3D Secure 2.x for the desired card type,
currencies, and acquiring bank. For details, see "Required Merchant Information."
You must request additional services such as payments using Secure Acceptance at
this time; you can request additional services such as token management as well.
b Log in to the Business Center to obtain the API keys for implementation.

Step 3 Implement 3D Secure 2.x.

 Using CyberSource Simple Order API:
a Add the CardinalCommerce JavaScript code to your checkout page.
b Configure your system to request the Check Enrollment and Validate
Authentication services. Include the required API fields in your request and
consider including optional fields based on your business needs.
For more information, see the "Payer Authentication Process" section and
Chapter 2, "Implementing Hybrid Payer Authentication," on page 25 or Chapter 3,
"Implementing Standard Payer Authentication," on page 33.
You can configure your system to request payment services through CyberSource
along with your payer authentication for 3D Secure 2.x; however, it is not required.

Step 4 Test your 3D Secure 2.x services.

This testing ensures that you understand the possible use cases as part of
implementation.
Refer to Chapter 6, "Testing Payer Authentication Services," on page 70 and run the test
cases in "Test Cases for 3D Secure 2.x."

Step 5 Configure your account for production.

a Request a boarding form from Customer Support for your processor or acquirer.
b Complete the boarding form with required information including your CyberSource
merchant ID, your acquirer merchant ID, and BIN information for all chosen card
types. For details, see "Required Merchant Information."

Payer Authentication Using the Simple Order API | October 2019 18

Chapter 1 Introducing Payer Authentication

Scenario 2: You Use the CyberSource Simple Order API and

Payer Authentication Services for 3D Secure 1.0

Step 1 Contact your CyberSource account manager, sales manager, or technical account
manager to learn more about 3D Secure 2.x and PSD2.

Step 2 Configure your test merchant ID with CyberSource.

a Contact Customer Support to make the necessary configuration changes to enable
3D Secure 2.x for the desired card type and currencies.
b Log in to the Business Center to obtain the API keys for implementation.

Step 3 Implement 3D Secure 2.x. by migrating to the Hybrid integration.

a Add the CardinalCommerce JavaScript code to your checkout page.
b Configure your system to request the Check Enrollment and Validate Authentication
services. Include the required API fields in your request and consider including
optional fields based on your business needs.
For more information, see Chapter 5, "Upgrading Your Payer Authentication
Implementation," on page 60.
You can configure your system to request payment services through CyberSource
along with your payer authentication for 3D Secure 2.x; however, it is not required.

Step 4 Test your 3D Secure 2.x services.

Step 5 Configure your account for production. Repeat Steps 2-4 for the production environment.

Payer Authentication Using the Simple Order API | October 2019 19

Chapter 1 Introducing Payer Authentication

Scenario 3: You Want to Integrate Using an SDK for your Mobile

Application

Step 1 Contact your CyberSource account manager, sales manager, or technical account
manager to learn more about 3D Secure 2.x and PSD2.

Step 2 Configure your test merchant ID with CyberSource.

a Contact Customer Support to make the necessary configuration changes to enable
3D Secure 2.x for the desired card type and currencies. For details, see "Required
Merchant Information."
b Log in to the Business Center to obtain the API keys for implementation.

Step 3 Implement 3D Secure 2.x.

You must use the CyberSource Simple Order API as well as the SDK in order to
implement a native mobile application. SDKs are available for iOS or Android.
a Implement the SDK to handle authentication steps within the native application. The
SDKs are the CardinalCommerce JavaScript equivalent for mobile applications.
For more information see Chapter 4, "Implementing SDK Payer Authentication," on
page 40.
b Configure your system to request the Check Enrollment and Validate Authentication
services. Include the required API fields in your request and consider including
optional fields based on your business needs.
For more information, see the "Payer Authentication Process" section and Chapter 2,
"Implementing Hybrid Payer Authentication," on page 25 or Chapter 3, "Implementing
Standard Payer Authentication," on page 33.
You can configure your system to request payment services through CyberSource
along with your payer authentication for 3D Secure 2.x; however, it is not required.

Step 4 Test your 3D Secure 2.x services.

Step 5 Configure your account for production. Repeat Steps 2-4 for the production environment.

Payer Authentication Using the Simple Order API | October 2019 20

Chapter 1 Introducing Payer Authentication

Using Secure Acceptance with Payer Authentication

Secure Acceptance offers the ability to enable 3D Secure 2.x for payer authentication
services. You can choose when to upgrade by selecting the option in your Secure
Acceptance profile in the Business Center.

For more information on implementing Secure Acceptance with payer authentication, see
the Secure Acceptance Hosted Checkout Integration Guide or Secure Acceptance
Checkout API Integration Guide.

Payer Authentication Process

This section describes the payer authentication process for Hybrid, Standard, and SDK
integrations.

Hybrid Integration Process

1 You generate a JSON Web Token (JWT).

2 You add the JavaScript tag to your checkout page.

3 Call Cardinal.setup().

4 Run BIN detection. If the BIN is eligible for 3D Secure 2.x, it gathers the proper Method
URL JavaScript required by the issuer to collect additional device data.

5 You request the Enrollment Check service, passing in transaction details and the
payerAuthEnrollService_referenceID request field.

6 If the issuing bank does not require authentication, you receive the following information in
the Enrollment Check reply:
 E-commerce indicator
 CAVV (all card types except Mastercard)
 AAV (Mastercard only)
 Transaction ID (XID)
 3D Secure version
 Directory server transaction ID

7 If the issuing bank requires authentication, you receive a response with the ACS URL of
the issuing bank, the payload, and the transaction ID that you include in the
Cardinal.continue JavaScript call.

8 The JavaScript displays the authentication window, and the customer enters the
authentication information.

9 The bank validates the customer credentials, and a JWT is returned that the merchant is
required to validate server-side for security reasons.

Payer Authentication Using the Simple Order API | October 2019 21

Chapter 1 Introducing Payer Authentication

10 You request the Validate Authentication service, extracting the processor transaction ID
value from the JWT and sending it in the payerAuthValidateService_
authenticationTransactionID request field. You receive the e-commerce indicator, CAVV
or AAV, transaction ID (XID), 3D Secure version, and directory server transaction ID.

Verify that the authentication was successful and continue processing your order.

You must pass all pertinent data for the card type and processor in your authorization
request. For more information, see "Requesting the Validation Service," page 30.

Standard Integration Process

1 You generate a JSON Web Token (JWT).

2 You add the JavaScript tag to your checkout page.

3 Call Cardinal.setup().

4 Run BIN detection. If the BIN is eligible for 3D Secure 2.x, it gathers the proper Method
URL JavaScript required by the issuer to collect additional device data.

5 When the customer places an order on your web site, you call the cardinal.start function to
pass in the transaction level data including the full PAN and order details.

6 The JavaScript verifies with the bank that the card is enrolled in a 3D Secure card
authentication program by using a server-to-server call.

7 If the issuing bank requires authentication, the JavaScript displays the authentication
window.

8 If required, the customer enters the authentication information.

9 The bank validates the customer credentials, and a JWT is returned that the merchant is
required to validate server-side for security reasons.

10 You request the ICS Enrollment Check service, extracting the processor transaction ID
value from the JWT and sending it in the payerAuthEnrollService_
authenticationTransactionID request field. You receive this information:

 E-commerce indicator
 CAVV (all card types except Mastercard)
 AAV (Mastercard only)
 Transaction ID (XID)
 3D Secure version
 Directory server transaction ID

Verify that the authentication was successful and continue processing your order.

Payer Authentication Using the Simple Order API | October 2019 22

Chapter 1 Introducing Payer Authentication

You must pass all pertinent data for the card type and processor in your authorization
request. For more information, see "Requesting the Check Enrollment Service
(Standard)," page 37.

SDK Integration Process

1 You generate a JSON Web Token (JWT).

2 Contact CardinalCommerce Customer Support for instructions to register for an API key.

3 Download and import the Cardinal Mobile SDK for either iOS or Android.

4 Set up your build environment.

5 Configure your SDK.

6 Call Cardinal session.setup().

7 Create an API call to your merchant server to request the Enrollment Check service,
passing in transaction details and the payerAuthEnrollService_referenceID request
field.

8 If the issuing bank does not require authentication, you receive the following information in
the Enrollment Check reply:

 E-commerce indicator
 CAVV (all card types except Mastercard)
 AAV (Mastercard only)
 Transaction ID (XID)
 3D Secure version
 Directory server transaction ID

9 If the issuing bank requires authentication, you receive a response with the payload, and
the transaction ID that you include in the Cardinal.continue call from your SDK.

10 The Cardinal Mobile SDK displays the authentication window, and the customer enters the
authentication information.

11 The bank validates the customer credentials and a JWT is returned by the SDK in the
onValidated callback that the merchant is required to validate server-side for security
reasons.

12 Create an API call to your merchant server to request the Validate Authentication service,
extracting the processor transaction ID value from the JWT and sending it in the
payerAuthValidateService_authenticationTransactionID request field. You receive the
e-commerce indicator, CAVV or AAV, transaction ID (XID), 3D Secure version, and
directory server transaction ID.

Payer Authentication Using the Simple Order API | October 2019 23

Chapter 1 Introducing Payer Authentication

Verify that the authentication was successful and continue processing your order.

You must pass all pertinent data for the card type and processor in your authorization
request. For more information, see "Requesting the Validation Service," page 57.

Required Merchant Information

Before using CyberSource Payer Authentication services in production, you must contact
Customer Support to provide information about your company and your acquiring bank so
that CyberSource can configure your account to implement these services.

You must provide the information listed in Table 1 to CyberSource before payer
authentication services can be enabled:

Table 1 Merchant Information Required for Payer Authentication Services

Information Description
About your company  Your CyberSource merchant ID.
 URL of your company’s web site, for example:
http://www.example.com
 Two-character ISO code for your country.
 3D Secure requestor ID
 3D Secure requestor name
 Merchant category code
Bank information  Name of your bank acquirer.
 Complete name and address of your bank contact,
including email address.
Visa, Mastercard, Maestro, Information provided by your bank acquirer about each
American Express, JCB, Diners payment card company for which you are configured:
Club, and Discover information
 6-digit BIN numbers.
Acquirer merchant ID
 Acquirer merchant ID: merchant ID assigned by your
acquirer.
 All currencies that you are set up to process.

Payer Authentication Using the Simple Order API | October 2019 24

CHAPTER
Implementing Hybrid Payer
Authentication
2

This chapter summarizes the process of integrating Hybrid Payer Authentication services
into your existing business processes. CyberSource Payer Authentication services use
CardinalCommerce JavaScript to leverage the authentication. The JavaScript
Documentation links in this chapter navigate to the Cardinal site.

Process Overview
Notify your CyberSource account representative that you want to implement payer
authentication (3D Secure). Give them the CyberSource merchant ID that you will use for
testing. For more information, see "Required Merchant Information," page 24.

Implementation tasks include:

 Add the JavaScript code to your checkout page

 For each purchase request

 Build the authentication request

 Call the payerAuthEnrollService: Payer Authentication Enrollment Check
service
 Invoke the authentication
 Handle declines
 Call the following services:
- payerAuthValidateService: Payer Authentication Validation (only for Hybrid
integration)
- ccAuthService: Card authorization service

 Use the test cases in Chapter 6, "Testing Payer Authentication Services," on page 70
to test your preliminary code and make the appropriate changes. You can change to
the test environment by changing the URL in your JavaScript code.

 Ensure that your account is configured for production.

Payer Authentication Using the Simple Order API | October 2019 25

Chapter 2 Implementing Hybrid Payer Authentication

Before You Begin

Before implementing payer authentication services, your business team must contact your
acquirer and CyberSource to begin setting up the service. Your software development
team should become familiar with the API fields and technical details of this service.

Credentials/API Keys
For implementation you need API keys to create the JSON Web Token (JWT). For further
information, contact CyberSource Customer Support.

Create the JWT

The Standard and Hybrid integration use JWTs (JSON Web Tokens) as the method of
authentication. To complete this step, see the JavaScript Documentation.

Add the JavaScript

Add Songbird.js to your checkout page and complete the additional steps:

1 Configure it: create the configuration object and pass it to Cardinal.configure().

2 Listen for Events: subscribe to events with Cardinal.on() and set up callback functions
for:

 payments.setupComplete: this optional event will trigger when the JavaScript has
successfully initialized, after calling Cardinal.setup().

 payments.validated: this event will trigger when the transaction has completed.

3 Initialize it: call Cardinal.setup() to trigger and pass your JWT to the JavaScript for each
transaction.

To complete these steps, see the JavaScript Documentation.

BIN Detection
BIN Detection is required and allows the card-issuing bank’s ACS provider to collect
additional device data; it can help speed up the authentication process by collecting this
data before the checkout page launches. This step occurs prior to authentication and must
occur before the Cardinal.start event (Standard integration) or Check Enrollment service
request (Hybrid integration). For further information, see the JavaScript Documentation.

Payer Authentication Using the Simple Order API | October 2019 26

Chapter 2 Implementing Hybrid Payer Authentication

Implementing Hybrid Payer Authentication

Requesting the Check Enrollment Service (Hybrid)

Request the Check Enrollment service to verify that the card is enrolled in a card
authentication program. When you request the ICS Enrollment Check service for the
Hybrid integration, the payerAuthEnrollService_referenceID request field is required.
The following fields are also required:

 billTo_city
 billTo_country
 billTo_email
 billTo_firstName
 billTo_lastName
 billTo_postalCode
 billTo_state
 billTo_street1
 card_accountNumber
 card_cardType
 card_expirationMonth
 card_expirationYear
 merchantID
 merchantReference Code
 payerAuthEnrollService_mobilePhone
 payerAuthEnrollService_referenceID
 payerAuthEnrollService_run
 payerAuthEnrollService_transactionMode
 purchaseTotals_currency
 purchaseTotals_grandTotalAmount

You can send additional request data in order to reduce your issuer step-up
authentication rates. It is best to send all available fields.
Note

For further details on required and optional fields, see "Request Fields," page 151.

Payer Authentication Using the Simple Order API | October 2019 27

Chapter 2 Implementing Hybrid Payer Authentication

You can use the enrollment check and card authorization services in the same request or
in separate requests:

 Same request: CyberSource attempts to authorize the card if your customer is not
enrolled in a payer authentication program. In this case, the field values that are
required in order to prove that you attempted to check enrollment are passed
automatically to the authorization service. If authentication is required, processing
automatically stops.

 Separate requests: you must manually include the enrollment check result values
(Enrollment Check Reply Fields) in the authorization service request (Card
Authorization Request Fields).

Table 2 lists these fields:

Table 2 Enrollment Check and Reply Fields

Identifier Enrollment Check Reply Field Card Authorization

Request Field
E-commerce indicator payerAuthEnrollReply_ ccAuthService_
commerceIndicator commerceIndicator
Collection indicator payerAuthEnrollReply_ ucaf_collectionIndicator
(Mastercard only) ucafCollectionIndicator
Result of the enrollment payerAuthEnrollReply_ ccAuthService_
check for Asia, Middle veresEnrolled veresEnrolled
East, and Africa Gateway
3D Secure version payerAuthEnrollReply_ ccAuthService_
specificationVersion paSpecificationVersion
Directory server payerAuthEnrollReply_ ccAuthService_
transaction ID directoryServer TransactionID directoryServerTransacti
onID
Note Not required for 3D
Secure 1.0.

Interpreting the Reply

The replies are similar for all card types. See Appendix C, "Request and Reply Examples,"
on page 192 for examples of enrollment replies.

 Enrolled Cards

You receive reason code 475 if the customer’s card is enrolled in a payer
authentication program. When you receive this reply, you can proceed to validate
authentication.

Payer Authentication Using the Simple Order API | October 2019 28

Chapter 2 Implementing Hybrid Payer Authentication

 Cards Not Enrolled

You receive reason code 100 in the following cases:

 When the account number is not enrolled in a payer authentication program. The
other services in your request are processed normally.
 When payer authentication is not supported by the card type.
When you receive this reply, you can proceed to card authorization.

Authenticating Enrolled Cards

When you have verified that a customer’s card is enrolled in a card authentication
program, you must take the URL of the card-issuing bank’s Access Control Server (ACS),
the payload, and the payerAuthEnrollReply_authenticationTransactionID reply field
and include them in the Cardinal.continue function in order to proceed with the
authentication session as shown in Example 1.

Example 1 Cardinal.continue

Cardinal.continue('cca',

"AcsUrl":"https://testcustomer34.cardinalcommerce.com/
merchantacsfrontend/pareq.jsp?vaa=b&gold=AAAAAAAA...AAAAAAA",

"Payload":"eNpVUk1zgjAQvedXME7PJEFBVdKt1CECeDkVCk2PcfcnNjv8Kr+7tx4nlbGO
cz/se6G1uMENPTPeeIz1G37WGEUth7YnpO21TfTvF3wDCBqspQ=="

"OrderDetails":{

"TransactionId" :"123456abc"

);

Cardinal.continue displays the authentication window if necessary and automatically

redirects the customer’s session over to the ACS URL for authentication. The customer’s
browser displays the authentication window with the option to enter their password.

Payer Authentication Using the Simple Order API | October 2019 29

Chapter 2 Implementing Hybrid Payer Authentication

Receiving the Authentication Results

Next payments.validated launches, and returns the authentication results and response
JWT along with the processor transaction ID as shown in Example 2.

Example 2 Decoded Response JWT

{
"iss": "5a4504be6fe3d1127cdfd94e",
"iat": 1555075930,
"exp": 1555083130,
"jti": "cc532159-636d-4fa8-931d-d4b0f4c83b99",
"ConsumerSessionId": "0_9a16b7f5-8b94-480d-bf92-09cd302c9230",
"aud": "d0cf3392-62c5-4107-bf6a-8fc3bb49922b",
"Payload": {
"Payment": {
"Type": "CCA",
"ProcessorTransactionId": "YGSaOBivyG0dzCFs2Zv0"
},
"ErrorNumber": 0,
"ErrorDescription": "Success"
}
}

Requesting the Validation Service

For enrolled cards, the next step is to request the validation service. When you make the
validation request, you must:

 Send the payerAuthValidateService_authenticationTransactionID request field

 Send the credit card information including the PAN, currency, and expiration date
(month and year).

The reply that you receive contains the validation result.

CyberSource recommends that you request both payer authentication and card
authorization services at the same time. When you do so, CyberSource automatically
sends the correct information to your payment processor; CyberSource converts the
values of these fields to the proper format required by your payment processor:

 E-commerce indicator: payerAuthEnrollReply_commerceIndicator

 CAVV: payerAuthValidateReply_cavv
 AAV: payerAuthValidateReply_ucafAuthenticationData
 XID: payerAuthEnrollReply_xid and payerAuthValidateReply_xid

If you request the services separately, you must manually include the validation result
values (Validation Check Reply Fields) in the authorization service request (Card

Payer Authentication Using the Simple Order API | October 2019 30

Chapter 2 Implementing Hybrid Payer Authentication

Authorization Request Fields). To receive liability shift protection, you must ensure that
you pass all pertinent data for the card type and processor in your request. Failure to do
so may invalidate your liability shift for that transaction. Include the electronic commerce
indicator (ECI), the transaction ID (XID), the 3D Secure version, the directory server
transaction ID, and the following card-specific information in your authorization request:

 For Visa, American Express, JCB, Diners Club, and Discover include the CAVV
(cardholder authentication verification value).
 For Mastercard, include the UCAF (universal cardholder authentication field) and the
collection indicator.

Table 3 lists these fields.

Table 3 Validation Check and Reply Fields

Identifier Validation Check Reply Field Card Authorization

Request Field
E-commerce indicator payerAuthValidateReply_ ccAuthService_
commerceIndicator commerceIndicator
Collection indicator payerAuthValidateReply_ ucaf_collectionIndicator
(Mastercard only) ucafCollectionIndicator
CAVV (Visa and American payerAuthValidateReply_cavv ccAuthService_cavv
Express only)
AAV (Mastercard only. payerAuthValidateReply_ ucaf_authenticationData
Known as UCAF) ucafAuthenticationData
XID payerAuthValidateReply_xid ccAuthService_xid
3D Secure version payerAuthValidateReply_ ccAuthService_
specificationVersion paSpecificationVersion
Directory server payerAuthValidateReply_ ccAuthService_
transaction ID directoryServer TransactionID directoryServerTransacti
onID
Note Not required for 3D
Secure 1.0.

Payer Authentication Using the Simple Order API | October 2019 31

Chapter 2 Implementing Hybrid Payer Authentication

Interpreting the Reply

If the authentication fails, Visa, American Express, JCB, Diners Club, and
Discover require that you do not accept the card. Instead, you must ask the
Important customer to use another payment method.

Proceed with the order according to the validation response that you receive. The replies
are similar for all card types:

 Success:

You receive the reason code 100, and other service requests, including authorization,
are processed normally.

 Failure:

You receive reason code 476 indicating that the authentication failed, so the other
services in your request are not processed.

 Error:

If you receive an error from the payment card company, process the order according
to your business rules. If the error occurs frequently, report it to Customer Support. If
you receive a CyberSource system error, determine the cause, and proceed with card
authorization only if appropriate.

To verify that the enrollment and validation checks are for the same transaction, ensure
that the XID in the enrollment check and validation replies are identical.

Redirecting Customers to Pass or Fail Message Page

After authentication is complete, redirect the customer to a page containing a success or
failure message. You must ensure that all messages that display to customers are
accurate, complete, and that they address all possible scenarios for enrolled and
nonenrolled cards. For example, if the authentication fails, a message such as the
following should be displayed to the customer:

Authentication Failed

Your card issuer cannot authenticate this card. Please select another card
or form of payment to complete your purchase.

Payer Authentication Using the Simple Order API | October 2019 32

CHAPTER
Implementing Standard
Payer Authentication
3

This chapter summarizes the process of integrating Standard Payer Authentication

services into your existing business processes. CyberSource Payer Authentication
services use CardinalCommerce JavaScript to leverage the authentication. The
JavaScript Documentation links in this chapter navigate to the Cardinal site.

Implementation tasks include:

 Add the JavaScript code to your checkout page

 For each purchase request

 Build the authentication request

 Invoke the authentication
 Handle declines
 Call the following services:
- payerAuthEnrollService: Payer Authentication Enrollment Check
- ccAuthService: Card authorization service

 Ensure that your account is configured for production.

Payer Authentication Using the Simple Order API | October 2019 33

Chapter 3 Implementing Standard Payer Authentication

Before You Begin

Credentials/API Keys
For implementation you need API keys to create the JSON Web Token (JWT). For further
information, contact CyberSource Customer Support.

Create the JWT

The Standard and Hybrid integration use JWTs (JSON Web Tokens) as the method of
authentication. To complete this step, see the JavaScript Documentation.

Add the JavaScript

Add Songbird.js to your checkout page and complete the additional steps:

1 Configure it: create the configuration object and pass it to Cardinal.configure().

2 Listen for Events: subscribe to events with Cardinal.on() and set up callback functions
for:

 payments.setupComplete: this optional event will trigger when the JavaScript has
successfully initialized, after calling Cardinal.setup().

 payments.validated: this event will trigger when the transaction has completed.

3 Initialize it: call Cardinal.setup() to trigger and pass your JWT to the JavaScript for each
transaction.

To complete these steps, see the JavaScript Documentation.

Payer Authentication Using the Simple Order API | October 2019 34

Chapter 3 Implementing Standard Payer Authentication

Implementing Standard Payer

Authentication

Starting Authentication
The JavaScript handles the device data collection, initiates the transaction for
authentication, displays the authentication window if required, and returns the
authentication results.

You initiate this authentication process, usually when the customer clicks the Place Order
or Submit Order button, by triggering Cardinal.start(). Cardinal.start() invokes the
authentication and authenticates the customer.

Create an order object to pass to the Cardinal.start() event. The more fields you include,
the less likely the cardholder will be challenged to provide credentials. See the JavaScript
Documentation for a list of 3D Secure 2.x fields.

Initiate Cardinal.start() before the authorization as shown in Example 3. The second

argument of data is a Request Order Object. You can construct this object ahead of time
or pass it directly as shown.

Example 3 Cardinal.start with Request Order Object

Cardinal.start("cca", {
OrderDetails: {
OrderNumber: "1234567890"
},
Consumer: {
Account: {
AccountNumber: "4000000000001000",
ExpirationMonth: "01",
ExpirationYear: "2099"
...
<Other 2.x required/optional fields>

}
}
...
});

Payer Authentication Using the Simple Order API | October 2019 35

Chapter 3 Implementing Standard Payer Authentication

Payments.validated returns the authentication results and response JWT along with the
processor transaction ID as shown in Example 4.

Example 4 Decoded Response JWT

Redirecting Customers to Pass or Fail Message Page

Authentication Failed

Your card issuer cannot authenticate this card. Please select another card
or form of payment to complete your purchase.

Payer Authentication Using the Simple Order API | October 2019 36

Chapter 3 Implementing Standard Payer Authentication

Requesting the Check Enrollment Service

(Standard)
Once the validation is complete, use the Check Enrollment service to obtain the values
needed for authorization.

To request the Check Enrollment service, extract the processor transaction ID value
from the JWT and send it in the payerAuthEnrollService_authenticationTransactionID
request field. The following fields are also required:

You can send additional request data in order to reduce your issuer step-up
authentication rates. It is best to send all available fields.
Note

For further details on required and optional fields, see "Request Fields," page 151.

Payer Authentication Using the Simple Order API | October 2019 37

Chapter 3 Implementing Standard Payer Authentication

 E-commerce indicator: payerAuthEnrollReply_commerceIndicator

 CAVV: payerAuthValidateReply_cavv
 AAV: payerAuthValidateReply_ucafAuthenticationData
 XID: payerAuthEnrollReply_xid and payerAuthValidateReply_xid

If you request the services separately, you must manually include the enrollment check
result values (Enrollment Check Reply Fields) in the authorization service request (Card
Authorization Request Fields). To receive liability shift protection, you must ensure that
you pass all pertinent data for the card type and processor in your request. Failure to do
so may invalidate your liability shift for that transaction. Include the electronic commerce
indicator (ECI), the transaction ID (XID), the 3D Secure version, the directory server
transaction ID, and the following card-specific information in your authorization request:

 For Visa, American Express, JCB, Diners Club, and Discover include the CAVV
(cardholder authentication verification value).

 For Mastercard, include the UCAF (universal cardholder authentication field) and the
collection indicator.

Table 4 lists these fields.

Table 4 Enrollment Check and Reply Fields

Identifier Enrollment Check Reply Field Card Authorization

Request Field
E-commerce indicator payerAuthEnrollReply_ ccAuthService_
commerceIndicator commerceIndicator
CAVV (Visa and American PayerAuthEnrollReply_cavv ccAuthService_cavv
Express only)
AAV (Mastercard only. payerAuthEnrollReply_ ucaf_authenticationData
Known as UCAF) ucafAuthenticationData
XID payerAuthEnrollReply_xid ccAuthService_xid
3D Secure version payerAuthEnrollReply_ ccAuthService_
specificationVersion paSpecificationVersion
Directory server payerAuthEnrollReply_ ccAuthService_
transaction ID directoryServer TransactionID directoryServerTransacti
onID
Note Not required for 3D
Secure 1.0.

Payer Authentication Using the Simple Order API | October 2019 38

Chapter 3 Implementing Standard Payer Authentication

In most cases, you request card authorization only once for each purchase. However, you
must send multiple authorization requests if the original authorization expires before it is
captured, which can occur when order fulfillment is split or delayed. In these cases, you
must include in subsequent authorization requests the same payer authentication data
contained in the original request so that your acquiring bank can track all related requests
if a dispute occurs. Authentication data can only be used for one authorization and cannot
be used multiple times or on subsequent authorizations.

Payer Authentication Using the Simple Order API | October 2019 39

CHAPTER
Implementing SDK Payer
Authentication
4

This chapter summarizes the process of integrating SDK Payer Authentication services
into your mobile application. CyberSource Payer Authentication services use the Cardinal
Mobile SDK for iOS or Android to facilitate the authentication. The JavaScript
Documentation links in this chapter navigate to the Cardinal site.

The SDK is only designed to handle 2.0 transactions. If a 1.0 transaction occurs, you must
include functionality to open up a WebView.

Implementation tasks include:

 Download, import, and configure the Cardinal Mobile SDK for either iOS or Android

 For each purchase request:

 Build the authentication request

 Make a back-end, server-to-server call to request the payerAuthEnrollService:
Payer Authentication Enrollment Check service
 Invoke the authentication
 Handle declines
 Make another back-end, server-to-server call to request the following services:
- payerAuthValidateService: Payer Authentication Validation
- ccAuthService: Card authorization service

 Use the test cases in Chapter 6, "Testing Payer Authentication Services," on page 70
to test your preliminary code and make the appropriate changes.

 Ensure that your account is configured for production.

Payer Authentication Using the Simple Order API | October 2019 40

Chapter 4 Implementing SDK Payer Authentication

Before You Begin

Implementing the SDK in your mobile application requires either Android or iOS platform
application programming skills. Android API 19 or iOS 8 and XCode 8 are required.

Credentials/API Keys
For implementation you need API keys to create the JSON Web Token (JWT). For
instructions to register for your Bintray user name and API keys, contact CyberSource
Customer Support.

You will receive an email invitation from [email protected] to join JFrog Bintray. When
you receive the email, click to join the organization and complete your registration.

To create your registration user name, include your merchant name and Cybersource in
the following format:

{Insert Merchant Name Here}_Cybersource

When you are fully registered, @cardinalcommerce is added to the end of your user
name. The final format of your user name will be:

{Insert Merchant Name Here}_Cybersource@cardinalcommerce

Once you complete your registration, you will be able to access your API keys.

Create the JWT

The Standard, Hybrid, and SDK integration use JWTs (JSON Web Tokens) as the method
of authentication. To complete this step, see the JavaScript Documentation.

Payer Authentication Using the Simple Order API | October 2019 41

Chapter 4 Implementing SDK Payer Authentication

Using the Android SDK

Update the Gradle Build Properties

In Android Studio, open the app directory (which can also be labeled Module: app) and
open the build.gradle file. Make sure that you edit the Gradle file that is located in the app
directory. Add the contents shown in Example 5 to the Gradle file.

Example 5 Gradle Build Properties

repositories {
...
maven {
url "https://cardinalcommerce.bintray.com/android"
credentials {
username ''//Bintray username
password ''//Bintray user API Key
}
}
}
dependencies {
...
//Cardinal Mobile SDK
implementation
'org.jfrog.cardinalcommerce.gradle:cardinalmobilesdk:2.1.4-1'

// Required libraries
implementation group: 'com.nimbusds', name: 'nimbus-jose-jwt',
version: '7.0.1'
implementation group: 'org.bouncycastle', name: 'bcprov-jdk15on',
version: '1.61'
}

Configure the Android SDK

Get the instance of the cardinal object by Cardinal.getInstance(). You can set multiple
configuration options in the SDK; if not specified, they are set to default. See Example 6 to
complete Cardinal.configure().

For more details on configuration options, see Table 5.

Payer Authentication Using the Simple Order API | October 2019 42

Chapter 4 Implementing SDK Payer Authentication

Example 6 Cardinal.configure

private Cardinal cardinal = Cardinal.getInstance();

@Override
protected void onCreate(Bundle savedInstanceState) {

CardinalConfigurationParameters cardinalConfigurationParameters = new

CardinalConfigurationParameters();

cardinalConfigurationParameters.setEnvironment(CardinalEnvironment.STAG
ING);
cardinalConfigurationParameters.setTimeout(8000);
JSONArray rType = new JSONArray();
rType.put(CardinalRenderType.OTP);
rType.put(CardinalRenderType.SINGLE_SELECT);
rType.put(CardinalRenderType.MULTI_SELECT);
rType.put(CardinalRenderType.OOB);
rType.put(CardinalRenderType.HTML);
cardinalConfigurationParameters.setRenderType(rType);

cardinalConfigurationParameters.setUiType(CardinalUiType.BOTH);

UiCustomization yourUICustomizationObject = new

UiCustomization();

cardinalConfigurationParameters.setUICustomization(yourUICustomizationO
bject);

cardinal.configure(this,cardinalConfigurationParameters);
}

Table 5 Android SDK Configuration Options

Method Description Default Values

setEnableDFSync On setting true, onSetupCompleted False
(boolean enableDFSync) will be called after device data
collected is sent to the server.
setEnableQuickAuth Sets enable quick auth false. False
(boolean enableQuickAuth)
setEnvironment(Setting up Sets the environment to which the CardinalEnvironment.
Cardinal Mobile SDK - SDK must connect. PRODUCTION
Android- V
2.1#CardinalEnvironment
environment)
setProxyAddress(java.lang. Sets the proxy to which the SDK ““
String proxyAddress) must connect.

Payer Authentication Using the Simple Order API | October 2019 43

Chapter 4 Implementing SDK Payer Authentication

Table 5 Android SDK Configuration Options (Continued)

Method Description Default Values

setRenderType(org.json.JS Sets renderLists all UI types that the JSONArray rType = new
ONArray renderType) device supports for displaying JSONArray();
specific challenge user interfaces
rType.put(Cardinal
within the SDK.
RenderType.OTP);
rType.put(Cardinal
RenderType.SINGLE_
SELECT);
rType.put(Cardinal
RenderType.MULTI_
SELECT);
rType.put(Cardinal
RenderType.OOB);
rType.put(Cardinal
RenderType.HTML);
setTimeout(int timeout) Sets the maximum amount of time 8000
(in milliseconds) for all exchanges.
setUICustomization Sets UICustomization Device Default Values
(UiCustomization UI
Customization)
setUiType(CardinalUiType Sets all UI types that the device CardinalUiType.BOTH
uiType) supports for displaying specific
challenge user interfaces within the
SDK.

Set Up the Initial Call

Calling Cardinal.init() begins the communication process with Cardinal, authenticates your
credentials (server JWT), and completes the data collection process. By the time the
customer is ready to check out, all necessary pre-processing is complete. Use the code
example shown in Example 7 for completing the cardinal.init().

Payer Authentication Using the Simple Order API | October 2019 44

Chapter 4 Implementing SDK Payer Authentication

Example 7 Cardinal.init() (Android SDK)

cardinal = Cardinal.getInstance();
String serverJwt = "INSERT_YOUR_JWT_HERE";
cardinal.init(serverJwt ,
new CardinalInitService() {
/**
* You may have your Submit button disabled on page load. Once you are
* set up for CCA, you may then enable it. This will prevent users
* from submitting their order before CCA is ready.
*/
@Override
public void onSetupCompleted(String consumerSessionId) {

}
/**
* If there was an error with set up, Cardinal will call this function
* with validate response and empty serverJWT
* @param validateResponse
* @param serverJwt will be an empty
*/
@Override
public void onValidated(ValidateResponse validateResponse, String
serverJwt) {

}
});

See the "Implementing SDK Payer Authentication" section for next steps.

Payer Authentication Using the Simple Order API | October 2019 45

Chapter 4 Implementing SDK Payer Authentication

Using the iOS SDK

Download and Import the SDK

Download the CardinalMobile.framework file using the cURL in Example 8.

Example 8 Download cURL

curl -L -u<USER_NAME>
:<API_KEY> https://cardinalcommerce.bintray.com/ios/<VERSION>-
<BUILD_NUMBER>/cardinalmobilesdk.zip
-o <LOCAL_FILE_NAME.EXT>

#Example:
curl -L -uUserName:ApiKey "https://cardinalcommerce.bintray.com/ios/
2.1.4-2/cardinalmobilesdk.zip" -o cardinalmobile2.1.4-2.zip

In your XCode project, drag the CardinalMobile.framework file into the Frameworks group
in your Xcode Project. (Create the group if it doesn't already exist.) In the import dialog
box, check the box to Copy items into the destinations group folder (or Destination: Copy
items if needed). The iOS SDK files are now available for linking in your project.

Set Up Your Build Environment

Step 1 Open Xcode and click on your project in the source list to the left of the main editor area.

Step 2 Select your application under the Targets section and go to the General tab.

Step 3 Expand the Embedded Binaries section and click the small plus (+) at the bottom of the
list.

Step 4 Add CardinalMobile.framework from the list.

Configure the iOS SDK

Create a new instance of the cardinal object by [CardinalSession new]. You can set
multiple configuration options in the SDK; if not specified, they are set to default. See
Example 9 or Example 10 to complete the iOS SDK configuration.

For more details on configuration options, see Table 6.

Payer Authentication Using the Simple Order API | October 2019 46

Chapter 4 Implementing SDK Payer Authentication

Objective-C Example
Example 9 CardinalSession new (iOS SDK - Objective-C)

#import <CardinalMobile/CardinalMobile.h>

CardinalSession *session;

//Setup can be called in viewDidLoad

- (void)setupCardinalSession {
session = [CardinalSession new];
CardinalSessionConfiguration *config = [CardinalSessionConfiguration
new];
config.deploymentEnvironment = CardinalSessionEnvironmentProduction;
config.timeout = CardinalSessionTimeoutStandard;
config.uiType = CardinalSessionUITypeBoth;

UiCustomization *yourCustomUi = [[UiCustomization alloc] init];

//Set various customizations here. See "iOS UI Customization"
documentation for detail.
config.uiCustomization = yourCustomUi;

CardinalSessionRenderTypeArray *renderType =
[[CardinalSessionRenderTypeArray alloc] initWithObjects:
CardinalSessionRenderTypeOTP,
CardinalSessionRenderTypeHTML,
nil];
config.renderType = renderType;

config.enableQuickAuth = false;
[session configure:config];
}

Payer Authentication Using the Simple Order API | October 2019 47

Chapter 4 Implementing SDK Payer Authentication

Swift Example
Example 10 CardinalSession new (iOS SDK - Swift)

import CardinalMobile

var session : CardinalSession!

//Setup can be called in viewDidLoad

func setupCardinalSession{
session = CardinalSession()
var config = CardinalSessionConfiguration()
config.deploymentEnvironment = .production
config.timeout = 8000
config.uiType = .both

let yourCustomUi = UiCustomization()

//Set various customizations here. See "iOS UI Customization"
documentation for detail.
config.uiCustomization = yourCustomUi

config.renderType = [CardinalSessionRenderTypeOTP,
CardinalSessionRenderTypeHTML]
config.enableQuickAuth = true
session.configure(config)
}

Table 6 iOS SDK Configuration Options

Method Description Default Values Possible Values

deploymentEnvironment The environment to CardinalSessionEnviron CardinalSessionEnvironment
which the SDK connects. mentProduction Staging
CardinalSessionEnvironment
Production
timeoutInMilliseconds Maximum amount of time 8000
(in milliseconds) for all
exchanges.
uiType Interface types that the CardinalSessionUIType CardinalSessionUITypeBoth
device supports for Both
CardinalSessionUITypeNative
displaying specific
challenge user interfaces CardinalSessionUITypeHTML
within the SDK.

Payer Authentication Using the Simple Order API | October 2019 48

Chapter 4 Implementing SDK Payer Authentication

Table 6 iOS SDK Configuration Options (Continued)

Method Description Default Values Possible Values

renderType List of all the render [CardinalSessionRender CardinalSessionRenderType
types that the device TypeOTP, OTP
supports for displaying
CardinalSessionRender CardinalSessionRenderType
specific challenge user
TypeHTML, HTML
interfaces within the
SDK. CardinalSessionRender CardinalSessionRenderType
TypeOOB, OOB
CardinalSessionRender CardinalSessionRenderType
TypeSingleSelect, SingleSelect
CardinalSessionRender CardinalSessionRenderType
TypeMultiSelect] MultiSelect
proxyServerURL Proxy server through nil
which the Cardinal SDK
Session operates.
enableQuickAuth Enable Quick false
Authentication
uiCustomization Set Custom nil
UICustomization for SDK
Controlled Challenge UI.
enableDFSync Enable DF Sync to get false
onSetupCompleted
called after collected
device data is sent to the
server.

Set Up the Initial Call

Calling cardinal session setup begins the communication process with Cardinal,
authenticates your credentials (server JWT), and completes the data collection process.
By the time the customer is ready to check out, all necessary pre-processing is complete.
Use the code example shown in Example 11 or Example 12 for completing the cardinal
session setup. The function call must be placed in your Checkout ViewController.

Payer Authentication Using the Simple Order API | October 2019 49

Chapter 4 Implementing SDK Payer Authentication

Objective-C Example
Example 11 Cardinal session setup (iOS SDK - Objective-C)

NSString *accountNumberString = @"1234567890123456";

NSString *jwtString = @"INSERT_YOUR_JWT_HERE";

[session setupWithJWT:jwtString
didComplete:^(NSString * _Nonnull consumerSessionId){
//
// You may have your Submit button disabled on page load. Once you are
// setup for CCA, you may then enable it. This will prevent users
// from submitting their order before CCA is ready.
//
} didValidate:^(CardinalResponse * _Nonnull validateResponse) {
// Handle failed setup
// If there was an error with setup, cardinal will call this
// function with validate response and empty serverJWT
}];

Swift Example
Example 12 Cardinal session setup (iOS SDK - Swift)

let accountNumberString = "1234567890123456"

let jwtString = "INSERT_YOUR_JWT_HERE"

session.setup(jwtString: jwtString, completed: { (consumerSessionId:

String) in
//
// You may have your Submit button disabled on page load. Once you
// are setup for CCA, you may then enable it. This will prevent
// users from submitting their order before CCA is ready.
//
}) { (validateResponse: CardinalResponse) in
// Handle failed setup
// If there was an error with setup, cardinal will call this
// function with validate response and empty serverJWT
}

Payer Authentication Using the Simple Order API | October 2019 50

Chapter 4 Implementing SDK Payer Authentication

Implementing SDK Payer Authentication

Requesting the Check Enrollment Service (SDK)

After the SDK completes the device collection from your mobile application and once the
customer clicks the ‘buy now’ button, you must make a back-end, server-to-server call to
request the Enrollment Check service.

The Check Enrollment service verifies that the card is enrolled in a card authentication
program. When you request the ICS Enrollment Check service for the SDK integration, the
payerAuthEnrollService_referenceID request field is required. The following fields are
also required:

You can send additional request data in order to reduce your issuer step-up
authentication rates. It is best to send all available fields.
Note

For further details on required and optional fields, see "Request Fields," page 151.

Payer Authentication Using the Simple Order API | October 2019 51

Chapter 4 Implementing SDK Payer Authentication

You can use the enrollment check and card authorization services in the same request or
in separate requests:

 Separate requests: you must manually include the enrollment check result values
(Enrollment Check Reply Fields) in the authorization service request (Card
Authorization Request Fields).

Table 7 lists these fields:

Table 7 Enrollment Check and Reply Fields

Identifier Enrollment Check Reply Field Card Authorization

Interpreting the Reply

The replies are similar for all card types. See Appendix C, "Request and Reply Examples,"
on page 192 for examples of enrollment replies.

 Enrolled Cards

You receive reason code 475 if the customer’s card is enrolled in a payer
authentication program. When you receive this reply, you can proceed to validate
authentication.

Payer Authentication Using the Simple Order API | October 2019 52

Chapter 4 Implementing SDK Payer Authentication

 Cards Not Enrolled

You receive reason code 100 in the following cases:

When you receive this reply, you can proceed to card authorization.

Authenticating Enrolled Cards

In the response from the enrollment check service, confirm that you receive the following
fields and values:

 3D Secure version = 2.x

 VERes enrolled = Y
 PARes status = C

These values identify whether it is a 2.x transaction and that a challenge is required. If the
3D Secure version is 1.0, then the SDK is no longer applicable and you must open up a
WebView.

Once you validate these fields, you call Cardinal.cca_continue (Android SDK) or Cardinal
session continue (iOS SDK) in order for the SDK to perform the challenge between the
customer and the issuing bank.

Call Cardinal.cca_continue (Android SDK)

When you have verified that a customer’s card is enrolled in a card authentication
program, you must take the payload, and the payerAuthEnrollReply_
authenticationTransactionID reply field and include them in the Cardinal.cca_continue
function in order to proceed with the authentication session as shown in Example 13.

Payer Authentication Using the Simple Order API | October 2019 53

Chapter 4 Implementing SDK Payer Authentication

Example 13 Cardinal.cca_continue (Android SDK)

/**
* Cca continue.
*
* @param transactionId the transaction id
* @param payload the payload
* @param currentActivity the current activity
* @throws InvalidInputException the invalid input exception
* @throws JSONException the json exception
* @throws UnsupportedEncodingException the unsupported encoding
exception
*/
try {
cardinal.cca_continue("[TRANSACTION ID ]", "[PAYLOAD]", this, new
CardinalValidateReceiver() {
/**
* This method is triggered when the transaction
* has been terminated. This is how SDK hands back
* control to the merchant's application. This method will
* include data on how the transaction attempt ended and
* you should have your logic for reviewing the results of
* the transaction and making decisions regarding next steps.
* JWT will be empty if validate was not successful.
*
* @param validateResponse
* @param serverJWT
*/
@Override
public void onValidated(Context currentContext,
ValidateResponse validateResponse, String serverJWT) {
}
});
}
catch (Exception e) {
// Handle exception
}

Payer Authentication Using the Simple Order API | October 2019 54

Chapter 4 Implementing SDK Payer Authentication

Call Cardinal session continue (iOS SDK)

When you have verified that a customer’s card is enrolled in a card authentication
program, you must take the payload, and the payerAuthEnrollReply_
authenticationTransactionID reply field and include them in the Cardinal session
continue function in order to proceed with the authentication session as shown in Example
14.

In Continue, you should pass a class conforming to a protocol CardinalValidationDelegate

(and implement a method stepUpDidValidate) as a parameter. Example 14 or Example 16
show an example of class conforming to CardinalValidationDelegate protocol.

Objective-C Examples
Example 14 Cardinal session continue (iOS SDK - Objective-C)

@interface YourViewController()<CardinalValidationDelegate>{ //Conform

your ViewController or any other class to CardinalValidationDelegate
protocol

}
@end

@implementation YourViewController

/**
* This method is triggered when the transaction has
* been terminated.This is how SDK hands back
* control to the merchant's application. This method will
* include data on how the transaction attempt ended and
* you should have your logic for reviewing the results of
* the transaction and making decisions regarding next steps.
* JWT will be empty if validate was not successful
*
* @param session
* @param validateResponse
* @param serverJWT
*/
-(void)cardinalSession:(CardinalSession *)session
stepUpDidValidateWithResponse:(CardinalResponse *)validateResponse
serverJWT:(NSString *)serverJWT{

@end

Payer Authentication Using the Simple Order API | October 2019 55

Chapter 4 Implementing SDK Payer Authentication

If Continue is called in the same class, call the method shown in Example 15 to start
StepUpFlow.

Example 15 Cardinal.continue Call in the Same Class (Objective-C)

[session continueWithTransactionId: @"[TRANSACTION_ID]"

payload: @"[PAYLOAD]"
didValidateDelegate: self];

Swift Examples
Example 16 Cardinal session continue (iOS SDK - Swift)

class YourViewController:CardinalValidationDelegate {

/**
* This method is triggered when the transaction has been
* terminated.This is how SDK hands back
* control to the merchant's application. This method will
* include data on how the transaction attempt ended and
* you should have your logic for reviewing the results of
* the transaction and making decisions regarding next steps.
* JWT will be empty if validate was not successful
*
* @param session
* @param validateResponse
* @param serverJWT
*/
func cardinalSession(cardinalSession session: CardinalSession!,
stepUpValidated validateResponse: CardinalResponse!, serverJWT: String!)
{

If Continue is called in the same class, call the method shown in Example 17 to start
StepUpFlow.

Example 17 Cardinal.continue Call in the Same Class (Swift)

session.continueWith(transactionId: "[TRANSACTION_ID]", payload:

"[PAYLOAD]", validationDelegate: self)

The SDK displays the authentication window if necessary and the customer enters their
authentication information.

Payer Authentication Using the Simple Order API | October 2019 56

Chapter 4 Implementing SDK Payer Authentication

Receiving the Authentication Results

Next onValidated() (Android SDK) or stepUpDidValidate (iOS SDK) launches, and returns
the authentication results and response JWT along with the processor transaction ID as
shown in Example 18.

Example 18 Decoded Response JWT

Requesting the Validation Service

For enrolled cards, the next step is to make a back-end, server-to-server call to request
the validation service.

When you make the validation request, you must:

 Send the payerAuthValidateService_authenticationTransactionID request field

 Send the credit card information including the PAN, currency, and expiration date
(month and year).

The reply that you receive contains the validation result.

 E-commerce indicator: payerAuthEnrollReply_commerceIndicator

 CAVV: payerAuthValidateReply_cavv
 AAV: payerAuthValidateReply_ucafAuthenticationData
 XID: payerAuthEnrollReply_xid and payerAuthValidateReply_xid

Payer Authentication Using the Simple Order API | October 2019 57

Chapter 4 Implementing SDK Payer Authentication

If you request the services separately, you must manually include the validation result
values (Validation Check Reply Fields) in the authorization service request (Card
Authorization Request Fields). To receive liability shift protection, you must ensure that
you pass all pertinent data for the card type and processor in your request. Failure to do
so may invalidate your liability shift for that transaction. Include the electronic commerce
indicator (ECI), the transaction ID (XID), the 3D Secure version, the directory server
transaction ID, and the following card-specific information in your authorization request:

Table 8 lists these fields.

Table 8 Validation Check and Reply Fields

Identifier Validation Check Reply Field Card Authorization

Payer Authentication Using the Simple Order API | October 2019 58

Chapter 4 Implementing SDK Payer Authentication

Interpreting the Reply

Proceed with the order according to the validation response that you receive. The replies
are similar for all card types:

 Success:

You receive the reason code 100, and other service requests, including authorization,
are processed normally.

 Failure:

You receive reason code 476 indicating that the authentication failed, so the other
services in your request are not processed.

 Error:

To verify that the enrollment and validation checks are for the same transaction, ensure
that the XID in the enrollment check and validation replies are identical.

Redirecting Customers to Pass or Fail Message Page

Authentication Failed

Your card issuer cannot authenticate this card. Please select another card
or form of payment to complete your purchase.

Payer Authentication Using the Simple Order API | October 2019 59

CHAPTER
Upgrading Your Payer
Authentication
5
Implementation
This chapter provides information about upgrading to 3D Secure 2.x for merchants
currently using CyberSource Payer Authentication services.

Upgrading to 3D Secure 2.x

Benefits
3D Secure 2.x provides the following benefits:

 More secure transactions as additional data is available.

 3D Secure 2.x is backward compatible. Additional data will automatically be sent to

issuers as they upgrade to 3D Secure 2.x.

 Improved user-friendly shopping experience for customers, including frictionless

authentication and shorter transaction times.

 Compatible with rules-based payer authentication.

 Mobile SDK will be available soon.

 Can result in higher authorization rates.

 Easier to upgrade to 3D Secure 2.2 when it becomes available. Version 2.2 includes
support for exemptions for PSD2 which might allow frictionless authentication,
including acquirer/issuer transactional risk assessment; white listing; low value, one
leg out, and merchant-initiated transactions. These exemptions will be defined as they
become available.

Payer Authentication Using the Simple Order API | October 2019 60

Chapter 5 Upgrading Your Payer Authentication Implementation

PSD2 Impact
Upgrading to 3D Secure 2.x is necessary if you are affected by PSD2.

PSD2 became applicable in January 2018 with additional security measures outlined in
the Regulatory Technical Standards (RTS) due to become applicable in September 2019.
PSD2 will require stronger identity checks for online payments, particularly for high-value
transactions.

PSD2 means changes for all companies in Europe that deal with payments. It has
implications for merchants including:

 Two-factor authentication will be required for all electronic payments, although there
are exemptions to allow a frictionless flow.

 3-D Secure e-commerce merchants will have to integrate dynamic authentication

tools (such as 3D Secure 2.x).

If you are impacted by PSD2 changes, it is very important that you upgrade to 3D Secure
2.x.

Mandates
PSD2 includes mandates around strong customer authentication (SCA) and exemptions
and challenges. See the following page for more information on the mandates:

https://demos.cardinalcommerce.com/3DS_Info/Country_Mandates/index.html

Timelines
See the following page for PSD2 compliance timelines:

https://demos.cardinalcommerce.com/3DS_Info/Cardinal_Timelines/index.html

Recommended Integration
Two types of integration are available for 3D Secure 2.x:

 Hybrid integration
 Standard integration

If you are currently using Payer Authentication services in your existing business
processes and need to upgrade to 3D Secure 2.x, CyberSource recommends using the
Hybrid integration.

Payer Authentication Using the Simple Order API | October 2019 61

Chapter 5 Upgrading Your Payer Authentication Implementation

The Hybrid integration most closely resembles the current process in which you request
the Enrollment Check service to verify that the customer is enrolled in one of the card
authentication programs and receive a response. With 3D Secure 2.x, the response
includes a new value, the processor transaction ID.

For enrolled cards, you include the ACS URL, payload, and processor transaction ID in
the Cardinal.continue function to proceed with the authentication session.

You then request the validation service, sending the processor transaction ID with your
request, and receive a response with the e-commerce indicator and CAVV or AAV.

If you are using tokenization, you must use the Hybrid integration method.

Important

The Standard integration uses JavaScript to perform more of the steps in the Payer
Authentication process.

The JavaScript collects the device data, interacts with the issuer, and verifies with the
bank that the card is enrolled in a 3D Secure card authentication program by using a
server-to-server call. If the issuing bank requires authentication, the JavaScript displays
the authentication window.

The bank validates the customer credentials and returns a JWT that you validate on the
server side. You must also extract the processor transaction ID value from the JWT.

At this point, you request the Enrollment Check service, sending the processor transaction
ID with your request. In the reply, you receive the e-commerce indicator and CAVV or AAV.

For more information about the Standard integration, see Chapter 3, "Implementing
Standard Payer Authentication," on page 33.

Configuration Requirements
For implementation you need API keys to create the JWT (JSON Web Token). For further
assistance, contact CyberSource Customer Support.

To upgrade your existing Payer Authentication implementation, notify CyberSource

Customer Support to make the necessary configuration changes; inform them whether
you are using an existing or new CyberSource merchant ID.

Payer Authentication Using the Simple Order API | October 2019 62

Chapter 5 Upgrading Your Payer Authentication Implementation

CyberSource API Calls for Hybrid

Integration
Call the payerAuthEnrollService Check Enrollment service to verify that the card is
enrolled in a card authentication program as you currently do. However, with 3D Secure
2.x, you can send additional request data; this might reduce your issuer step-up
authentication rates. 3D Secure 2.x supports the following new fields:

 billTo_customerAccountChangeDate
 billTo_customerAccountCreateDate
 billTo_customerAccountPasswordChangeDate
 billTo_passportCountry
 billTo_passportNumber
 item_#_productDescription
 payerAuthEnrollService_accountPurchases
 payerAuthEnrollService_addCardAttempts
 payerAuthEnrollService_alternateAuthentication Data
 payerAuthEnrollService_alternateAuthentication Date
 payerAuthEnrollService_alternateAuthentication Method
 payerAuthEnrollService_authentication TransactionID
 payerAuthEnrollService_challengeCode
 payerAuthEnrollService_customerCCAlias
 payerAuthEnrollService_defaultCard
 payerAuthEnrollService_fraudActivity
 payerAuthEnrollService_giftCardAmount
 payerAuthEnrollService_giftCardCount
 payerAuthEnrollService_giftCardCurrency
 payerAuthEnrollService_httpUserAccept
 payerAuthEnrollService_installmentTotalCount
 payerAuthEnrollService_marketingOptIn
 payerAuthEnrollService_marketingSource
 payerAuthEnrollService_merchantNewCustomer
 payerAuthEnrollService_merchantURL
 payerAuthEnrollService_messageCategory
 payerAuthEnrollService_npaCode
 payerAuthEnrollService_paymentAccountDate
 payerAuthEnrollService_preorder
 payerAuthEnrollService_preorderDate

Payer Authentication Using the Simple Order API | October 2019 63

Chapter 5 Upgrading Your Payer Authentication Implementation

 payerAuthEnrollService_recurringEndDate
 payerAuthEnrollService_recurringFrequency
 payerAuthEnrollService_recurringOriginalPurchaseDate
 payerAuthEnrollService_reorder
 payerAuthEnrollService_shipAddressUsageDate
 payerAuthEnrollService_transactionCountDay
 payerAuthEnrollService_transactionCountYear
 payerAuthEnrollService_transactionMode
 shipTo_destinationCode

You must also send the payerAuthEnrollService_referenceID request field with your
Check Enrollment service request.

When you have verified that a customer’s card is enrolled in a card authentication
program, you must take the URL of the card-issuing bank’s Access Control Server (ACS
URL), the payload, and the payerAuthEnrollReply_authenticationTransactionID reply
field and include them in the Cardinal.continue function in order to proceed with the
authentication session.

Payments.validated launches and returns the authentication results and response JWT
along with the processor transaction ID.

For enrolled cards, the next step is to call the payerAuthValidateService validation
service. When you make the validation request, you send the transaction details as you
currently do but also include the processor transaction ID value in the
payerAuthEnrollService_authenticationTransactionID request field. The reply that you
receive contains the validation result.

3D Secure 2.x has the following differences from the 3D Secure 1.0 Payer Authentication
integration:

 You do not receive the proof XML field.

 The additional fields for 3D Secure 2.x do not appear in the Payer Authentication
reports. These will be added in a future release.

 The processor transaction ID value is new; this field is passed to link the check
enrollment and validate authentication messages.

Payer Authentication Using the Simple Order API | October 2019 64

Chapter 5 Upgrading Your Payer Authentication Implementation

Configuring Your Web Site

This section provides a high-level look at how to set up your checkout page and configure
the components for CardinalCommerce JavaScript.

Displaying the Authentication Window

If the issuing bank requires authentication, the JavaScript displays the authentication
window to the customer.

To implement, you add the JavaScript tag to your checkout page, configure the
Cardinal.configure() component, and call Cardinal.setup() to trigger and pass your JWT to
the JavaScript for each transaction.

Using CardinalCommerce JavaScript

You must configure and include the components described in this section to use the
CardinalCommerce JavaScript.

JWT (JSON Web Token)

You generate the JWT on your back-end server. It allows Cardinal to confirm your identity
based on your credentials. The JWT includes your API Key, API Identifier, and Org Unit
ID.

You can use any third-party JWT library to generate your JWT. For more information, see
https://jwt.io.

You should generate a new JWT for each new transaction. You pass the JWT via the
Cardinal.setup (Init) call.

Example 19 JWT Example

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiMDc5ZTU5OC0zNWJiLTRiZW
MtYmNmOC1lYWJmNTZmZDg0YzYiLCJpYXQiOjE1Mjk1OTU0NzIsImV4cCI6MTUyOTYwMjY3M
iwiaXNzIjoiZGV2Y2VudGVybWVyY2hhbnQiLCJPcmdVbml0SWQiOiI1ODJiZTlkZWRhNTI5
MzJhOTQ2YzQ1YzQiLCJSZWZlcmVuY2VJZCI6IkNydWlzZVRlc3Rlci0zZmI4NWZiIiwiUGF
5bG9hZCI6eyJPcmRlckRldGFpbHMiOnsiT3JkZXJOdW1iZXIiOiJDcnVpc2VUZXN0ZXItM2
Zi ODVmYiJ9fSwiT2JqZWN0aWZ5UGF5bG9hZCI6dHJ1ZX0.JW00jFi1ppIMI1Cwd1_
J1v1gGwN5V82H6BxtligdzF0

Payer Authentication Using the Simple Order API | October 2019 65

Chapter 5 Upgrading Your Payer Authentication Implementation

Example 20 Decoded JWT Sent via the Cardinal.setup (Init)

{
"jti": "b079e598-35bb-4bec-bcf8-eabf56fd84c6",
"iat": 1529595472,
"exp": 1529602672,
"iss": "devcentermerchant",
"OrgUnitId": "582be9deda52932a946c45c4",
"ReferenceId": "CruiseTester-3fb85fb",
"Payload": {
"OrderDetails": {
"OrderNumber": "CruiseTester-3fb85fb",
{
{,
"ObjectifyPayload": true
}
}

Songbird.js Calls
Both the Hybrid and Standard integration use the following components except where
noted:

 Cardinal.configure allows you to view additional logging during testing (when it is set
to verbose). You can also configure whether your bank session opens as an inline or
modal window.

 Use Cardinal.setup (Init) to pass your JWT to the JavaScript. When the JavaScript
receives the Init, it verifies your identify as the merchant and begins device collection.

 BIN Detection allows you to pass the BIN at minimum and the full card number if
possible. See "BIN Detection" for further details.

 Cardinal.start (Standard integration only) is the JavaScript function that passes the
transaction-level details such as the PAN, currency, and expiration date (month and
year).

 Cardinal.continue (Hybrid integration only) is the JavaScript function that allows the
bank redirect to occur.

BIN Detection
BIN detection is a required step for the Standard or Hybrid integration. Send the BIN
before you send the transaction-level details. You are sending the BIN before
Cardinal.start for the Standard integration and before you request the Check Enrollment
service.

Payer Authentication Using the Simple Order API | October 2019 66

Chapter 5 Upgrading Your Payer Authentication Implementation

BIN detection allows the BIN (full card number if available) to be gathered and shared with
Cardinal before the customer initiates the transaction. Cardinal determines if the BIN is
eligible for 3D Secure 1.0 or 3D Secure 2.x, and initiates proper protocol routing.

If the BIN is eligible for 3D Secure 2.x, it gathers the proper Method URL JavaScript
required by the issuer for device fingerprint collection and risk assessment.

Handlers/Event Listeners
Both the Hybrid and Standard integration use the following components except where
noted:

 Payments.setupComplete notifies you when the Init has completed and confirms that
the device data has been collected. You must subscribe to this event.
This event also provides a Session ID which you can use as the
payerAuthEnrollService_referenceID request field for the Check Enrollment
service. (This field is required for the Hybrid integration.)

 Payments.validated provides the processor transaction ID value which you should

send in the Check Enrollment service for the Standard integration or the validation
service for the Hybrid integration to obtain the final authentication result.
You must subscribe to this event.
The JavaScript calls payments.validated earlier in the flow if there is an error on the
Cardinal.setup (Init) function. You can build logic around what to do if
payments.validated returns an error.

 Cardinal.start (Standard integration only) is the JavaScript function that passes the
transaction-level details such as the PAN, currency, and expiration date (month and
year).

 Cardinal.continue (Hybrid integration only) is the JavaScript function that allows the
bank redirect to occur.

Testing
See "Test Cases for 3D Secure 2.x," when you are ready to test your new implementation.
You can change to the test environment by changing the URL in your JavaScript code.

Payer Authentication Using the Simple Order API | October 2019 67

Chapter 5 Upgrading Your Payer Authentication Implementation

Migration FAQ
Q: Do I need to send in a new JWT for each transaction?

A: Yes, even though the JWT does not expire for two hours, you should send a new JWT
with each new transaction.

Q: Can Cardinal.setup(Init) run after I request the Check Enrollment service?

A: No, the Init collects the needed device information and this must happen before you
request the Check Enrollment service and send the transaction-level details.

Q: What happens if I receive an error on the Init?

A: Decode your JWT, verify that your credentials are correct, that the timestamp is in Unix
time, and that you have included the required information. For further assistance, contact
CyberSource Customer Support.

Q: How do you link the device data to the transaction-level data?

A: There are two ways to do this:

You can create a reference ID in the original JWT and then pass that same value for
the payerAuthEnrollService_referenceID request field for the Check Enrollment
service.

Payments.setupComplete returns a session ID and you can use that value for the
payerAuthEnrollService_referenceID request field for the Check Enrollment
service.

Q: When will the Payer Authentication reports include the new fields for 3D Secure 2.x?

A: They will be added in a future release.

Q: Will my current implementation continue to work while I am implementing and testing

the newer version in parallel?

A: Yes, current implementation will continue to work.

Q: Why should I implement 3D Secure 2.1 when version 2.2 will be available soon?

A: The 3D Secure 2.2 specification has not been finalized and this version may not be
ready by the PSD2 deadline of September 2019. 3D Secure 2.1 meets PSD2
requirements, with version 2.2 adding the possibility of using exemptions to reduce SCA.

Payer Authentication Using the Simple Order API | October 2019 68

Chapter 5 Upgrading Your Payer Authentication Implementation

Q: What is the difference between the Hybrid integration and the Standard integration?

A: The main difference is that the Standard integration does not include a Payer
Authentication validation service request. For more information, refer to Chapter 2,
"Implementing Hybrid Payer Authentication," on page 25 and Chapter 5, "Upgrading Your
Payer Authentication Implementation," on page 60.

Q: What testing should I conduct, to ensure that my code is working correctly?

A: Use the test cases ("Test Cases for 3D Secure 2.x," page 119) to test your preliminary
code and make the appropriate changes. You can change to the test environment by
changing the URL in your JavaScript code.

Q: How does 3D Secure 2.x authentication improve the experience for a customer who
uses a mobile or tablet device?

A: 3D Secure 2.x is agnostic to the device and you have control over the formatting of the
authentication form. 3D Secure 2.x also supports newer, more secure authentication
delivery tools, such as a one-time password (OTP) sent to a customer’s mobile device or
email.

Payer Authentication Using the Simple Order API | October 2019 69

CHAPTER
Testing Payer
Authentication Services
6

After you have completed the necessary changes to your Web and API integration, verify
that all components are working correctly by performing all the tests for the cards that you
support. Each test contains the specific input data and the most important results fields
that you receive in the API reply.

Testing Process
Use the card number specified in the test with the card’s expiration date set to the month
of December and the current year plus three. For example, for 2019, use 2022. You also
need the minimum required fields for an order.

Enrollment Check
For some of the enrolled cards, an authentication window appears after the enrollment
check completes.

To view the authentication window, you must enable your browser to display
popup windows.
Note The test password is always 1234.

Depending on the user’s action, two results are possible:

 If the user submits the password for the enrolled card, you receive the URL of the
Access Control Server (ACS) where the customer can be authenticated.

 If the user clicks the Exit link and clicks OK in the verification window, authentication
does not occur.

Payer Authentication Using the Simple Order API | October 2019 70

Chapter 6 Testing Payer Authentication Services

Table 9 lists the reply fields used in the test cases.

Table 9 Reply Fields Used in the Enrollment Check Test Cases

Name Used in Test Cases API Field

ACS URL payerAuthEnrollReply_acsURL
E-commerce indicator payerAuthEnrollReply_commerceIndicator
ECI payerAuthEnrollReply_eci
PAReq payerAuthEnrollReply_paReq
proofXML payerAuthEnrollReply_proofXML
Reason code payerAuthEnrollReply_reasonCode
VERes enrolled payerAuthEnrollReply_veresEnrolled
XID payerAuthEnrollReply_xid

Authentication Validation
Table 10 lists only the reply fields used in the test cases.

Table 10 Reply Fields Used in the Authentication Validation Test Cases

Name Used in Test Cases API Field

Authentication result payerAuthValidateReply_authenticationResult
E-commerce indicator payerAuthValidateReply_commerceIndicator
AAV (Mastercard only) payerAuthValidateReply_ucafAuthenticationData
CAVV ((all card types except payerAuthValidateReply_cavv
Mastercard)
Collection indicator payerAuthValidateReply_ucafCollectionIndicator
ECI payerAuthValidateReply_eci
PARes status payerAuthValidateReply_authenticationStatusMessage
Reason code payerAuthValidateReply_reasonCode
XID payerAuthValidateReply_xid

Payer Authentication Using the Simple Order API | October 2019 71

Chapter 6 Testing Payer Authentication Services

Expected Results
These flowcharts summarize the payer authentication process based on the enrollment
status of the card and the subsequent customer experience with the authentication path.

Use this information with the test cases to determine how to process orders.

Figure 1 Authentication Path for Visa, American Express, JCB, Diners Club, and Discover

Payer Authentication Using the Simple Order API | October 2019 72

Chapter 6 Testing Payer Authentication Services

Figure 2 Authentication Path for Mastercard and Maestro

Payer Authentication Using the Simple Order API | October 2019 73

Chapter 6 Testing Payer Authentication Services

Test Cases for 3D Secure 1.0

Visa Secure
You can use Payer Authentication services with 16- and 19-digit Visa cards if they are
supported by your processor.

Table 11 Possible Values for Visa Secure Reply Fields

Result and Interpretation Validate Authentication Reply

Authentication ECI Commerce Reason Code
Result Indicator
Success Successful authentication. 0 05 vbv 100

Recorded attempt to 1 06 vbv_ 100

authenticate. attempted
1
Failure System error that prevents 6 —2 100
(Customer the completion of
not authentication: you can
responsible) proceed with authorization,
but there is no liability shift.
Issuer unable to perform 6 07 internet 100
authentication.
No response from the 07 internet
Directory Servers or Issuer
vbv_failure
because of a problem.
(processors:
AIBMS, Barclays,
Streamline, or
FDC Germany)
Invalid PARes. -1 — — 476

Failure Authentication failed or 9 — — 476

(Customer cardholder did not complete
responsible) authentication.
If the authentication fails,
Visa requires that you do not
accept the card. You must
ask the customer to use
another payment method.
1 The ECI value can vary depending on the reason for the failure.
2 A dash (—) indicates that the field is blank or absent.

Payer Authentication Using the Simple Order API | October 2019 74

Chapter 6 Testing Payer Authentication Services

Test Case 1: Visa Secure Card Enrolled: Successful Authentication

Card Number 4000000000000002 With authentication window

4000000000000000022
4000000000000119 Without authentication window
Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.

authentication. Please authenticate before
proceeding with authorization.
Details ACS URL URL Authentication result 0
PAReq PAReq value CAVV CAVV value
proofXML proofXML value E-commerce indicator vbv
VERes enrolled Y ECI 05
XID XID value PARes status Y
XID XID value
Action 1 Add the signed PARes to the Validate Authentication request.
2 Ensure that the XID from the enrollment check matches that from the authentication validation.
3 Add the CAVV and ECI values to your authorization request.

Test Case 2: Visa Secure Card Enrolled: Successful Authentication but Invalid PARes

Card Number 4000000000000010 With authentication window

4000000000000000071
Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer We encountered a payer authentication
authentication. Please authenticate before problem: PARes signature digest value
proceeding with authorization. mismatch. PARes message has been modified.
Details ACS URL URL value Authentication result -1
PAReq PAReq value XID XID value
proofXML proofXML value
VERes enrolled Y
XID XID value
Action Do not proceed with authorization. Instead, ask the customer for another form of payment.

Payer Authentication Using the Simple Order API | October 2019 75

Chapter 6 Testing Payer Authentication Services

Test Case 3: Visa Secure Card Enrolled: Attempts Processing

Card Number 4000000000000101 Without authentication window

4000000000000000063 With authentication window
4000000000000127 Card enrollment option during purchase process
Auth. Type Activation during shopping
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.
authentication. Please authenticate before
proceeding with authorization.
Details ACS URL URL value Authentication result 1
PAReq PAReq value CAVV CAVV value
proofXML proofXML value E-commerce indicator vbv_attempted
VERes enrolled Y ECI 06
XID XID value PARes status A
XID XID value
Action If you request Validate Authentication and authorization services separately, follow these steps:
1 Add the signed PARes to the Validate Authentication request.
2 Ensure that the XID from the enrollment check matches that from the authentication validation.
3 Add the CAVV and ECI values to your authorization request.
If you request the Validate Authentication and authorization services together, the process
described above occurs automatically. Test card 4000000000000127 enables you to reproduce
the process by which the customer enrolls the card during the purchase. If the card is not enrolled,
a card enrollment option windows appears in the customer’s browser after the enrollment check.
The customer can activate the card at that time or later. In both cases, the card is authenticated,
and validation is successful.

Payer Authentication Using the Simple Order API | October 2019 76

Chapter 6 Testing Payer Authentication Services

Test Case 4: Visa Secure Card Enrolled: Incomplete Authentication

Card Number 4000000000000036

4000000000000000055
Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer  Issuer unable to perform authentication.
authentication. Please authenticate before
 ics_pa_validate service was successful.
proceeding with authorization.
Details ACS URL URL value Authentication result 6
PAReq PAReq value E-commerce indicator internet
proofXML proofXML value ECI 07
VERes enrolled Y PARes status U
XID XID value XID XID value
Action Ask the customer for another form of payment, or submit the transaction. No liability shift.

Test Case 5: Visa Secure Card Enrolled: Unsuccessful Authentication

Card Number 4000000000000028 With authentication window

4000000000000000048
Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer  User failed authentication.
authentication. Please authenticate before
 Payer cannot be authenticated.
proceeding with authorization.
Details ACS URL URL value Authentication result 9
PAReq PAReq value PARes status N
proofXML proofXML value XID XID value
VERes enrolled Y
XID XID value
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Payer Authentication Using the Simple Order API | October 2019 77

Chapter 6 Testing Payer Authentication Services

Test Case 6: Visa Secure Card Enrolled: Unsuccessful Authentication (Customer Exited)

Card Number 4000008531947799

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer  Customer prevents authentication.
authentication. Please authenticate before
 ics_pa_validate service was successful.
proceeding with authorization.
Details ACS URL URL value Authentication result 9
PAReq PAReq value PARes status N
proofXML proofXML value XID XID value
VERes enrolled Y
XID XID value
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Test Case 7: Visa Secure Card Enrolled: Unavailable Authentication

Card Number 4000000000000069

4000000000000000014
Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details E-commerce indicator internet
proofXML proofXML value
VERes enrolled U
Action Submit your authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 78

Chapter 6 Testing Payer Authentication Services

Test Case 8: Visa Secure Card Enrolled: Authentication Error

Card Number 4000000000000093

4000000000000000006
Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer We encountered a payer authentication
authentication. Please authenticate before problem: Error Processing PARes.
proceeding with authorization.
Details ACS URL URL value E-commerce indicator internet
PAReq PAReq value ECI 07
proofXML proofXML value
VERes enrolled Y
XID XID value
Action Ask the customer for another form of payment. No liability shift.

Test Case 9: Visa Secure Card Not Enrolled

Card Number 4000000000000051

4000000000000000030
Auth. Type Non-participating bank
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details E-commerce indicator vbv_attempted
ECI 06
proofXML proofXML value
VERes enrolled N
Action Submit your authorization request. Liability shift.

Payer Authentication Using the Simple Order API | October 2019 79

Chapter 6 Testing Payer Authentication Services

Test Case 10: Visa Secure Enrollment Check: Time-Out

Card Number 4000000000000044
Auth. Type Active authentication
Results Check Enrollment Validate Authentication
Summary Reason code 100
ics_pa_enroll service was successful.
Details E-commerce indicator internet
proofXML proofXML value
Action After 10-12 seconds, proceed with the authorization request. No liability shift.

Test Case 11: Visa Secure Enrollment Check Error

Card Number 4000000000000085 Error response

4000000000000077 Incorrect Configuration: Unable to Authenticate
Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details E-commerce indicator internet
proofXML proofXML value
VERes enrolled U
Action Proceed with the authorization request, and contact your support representative to resolve the
issue. No liability shift. If you requested payer authentication and authorization together, the
authorization is processed automatically.

Payer Authentication Using the Simple Order API | October 2019 80

Chapter 6 Testing Payer Authentication Services

Test Case 12: Visa Secure Enrollment RIBA_PASS

Card Number 4000180000000002

Auth. Type Passive authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.

Test Case 13: Visa Secure Enrollment RIBA_PASS: Unsuccessful Authentication

Card Number 4000180000000028

Auth. Type Passive authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

Payer Authentication Using the Simple Order API | October 2019 81

Chapter 6 Testing Payer Authentication Services

Test Case 14: Visa Secure Enrollment RIBA

Card Number 4000260000000002 With authentication window

Auth. Type Risk-based bank

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.

Test Case 15: Visa Secure Enrollment RIBA: Unsuccessful Authentication

Card Number 4000260000000028 With authentication window

Auth. Type Risk-based bank

Results Reason code 475 Reason code 476

Summary The cardholder is enrolled in payer  User failed authentication.

authentication. Please authenticate before
 Payer cannot be authenticated.
proceeding with authorization.
ACS URL URL value Authentication result 9
Details PAReq PAReq value PARes status N
proofXML proofXML value XID XID value
VERes enrolled Y
XID XID value
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Payer Authentication Using the Simple Order API | October 2019 82

Chapter 6 Testing Payer Authentication Services

Mastercard Identity Check

Table 12 Possible Values for Mastercard Identity Check and Maestro Reply Fields

Result and Interpretation payerAuthValidateReply_

authentication ucafCollection commerce reason
Result Indicator Indicator Code
Success Successful authentication. 0 2 spa 100

Recorded attempt to 1 1 spa 100

authenticate.
Authentication not completed. 1 0 spa 100

Failure System error (Issuer unable to 6 0 internet 100

(Customer perform authentication): you
not cannot authorize this card; no
responsible) liability shift.
Invalid PARes. -1 0 476
Failure Authentication failed or 9 0 – 476
(Customer cardholder did not complete
responsible) authentication.

Test Case 16: Mastercard Identity Check Card Enrolled: Successful Authentication

Card Number 5200000000000007 With authentication window

5200000000000114 Without authentication window
Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The card is enrolled in payer authentication. ics_pa_validate service was successful.
Please authenticate before proceeding with
authorization.
Details ACS URL URL Authentication result 0
PAReq PAReq value AAV AAV value
proofXML proofXML value Collection indicator 2
VERes enrolled Y E-commerce indicator spa
XID XID value PARes status Y
XID XID value
Action 1 Add the signed PARes to the Validate Authentication request.
2 Ensure that the XID from the enrollment check matches that from the authentication validation.
3 Add the required payer authentication values to your authorization request.

Payer Authentication Using the Simple Order API | October 2019 83

Chapter 6 Testing Payer Authentication Services

Test Case 17: Mastercard Identity Check Card Enrolled: Successful Authentication but Invalid
PARes

Card Number 5200000000000015 With authentication window

Auth. Type Active authentication

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer Payer authentication problem: PARes
authentication. Please authenticate before signature digest value mismatch. PARes
proceeding with authorization. message has been modified.
Details ACS URL URL Authentication result -1
PAReq PAReq value XID XID value
proofXML proofXML value
VERes enrolled Y
XID XID value
Action Do not process the authorization request. Instead ask the customer for another form of payment.

Test Case 18: Mastercard Identity Check Card Enrolled: Attempts Processing

Card Number 5200000000000122 Card enrollment option during purchase process

5200000000000106
Auth. Type Activation during shopping
Results Check Enrollment Validate Authentication
Summary Reason code 475 Reason code 100
The cardholder is enrolled in payer ics_pa_validate service was successful.
authentication. Please authenticate before
proceeding with authorization.
Details ACS URL URL Authentication result 1
PAReq PAReq value AAV AAV value
proofXML proofXML value Collection indicator 1
VERes enrolled Y E-commerce indicator spa
XID XID value PARes status A
XID XID value
Action This test card enables you to reproduce the process by which the customer enrolls the card during
the purchase. If the card is not enrolled, a card enrollment option windows appears in the
customer’s browser after the enrollment check. The customer can activate the card at that time or
later. In both cases, the card is authenticated, and validation is successful.
1 Add the signed PARes to the validation request.
2 In the reply, ensure that the XID from the enrollment check matches that from the validation.
3 Add the required payer authentication values to your authorization request.

Payer Authentication Using the Simple Order API | October 2019 84

Chapter 6 Testing Payer Authentication Services

Test Case 19: Mastercard Identity Check Card Enrolled: Incomplete Authentication

Card Number 5200000000000031 Without authentication window

Auth. Type Active authentication

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer  ics_pa_validate service was successful.
authentication. Please authenticate before
 Issuer unable to perform authentication.
proceeding with authorization.
Details ACS URL URL value Authentication result 6
PAReq PAReq value Collection indicator 0
proofXML proofXML value E-commerce indicator internet
VERes enrolled Y PARes status U
XID XID value XID XID value
Action Ask the customer for another form of payment, or submit the transaction. No liability shift.

Test Case 20: Mastercard Identity Check Card Enrolled: Unsuccessful Authentication

Card Number 5200000000000023 With authentication window

Auth. Type Active authentication

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer  User failed authentication
authentication. Please authenticate before
 Payer could not be authenticated.
proceeding with authorization.
Details ACS URL URL value Authentication result 9
PAReq PAReq value PARes status N
proofXML proofXML value
VERes enrolled Y XID XID value
XID XID value
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Payer Authentication Using the Simple Order API | October 2019 85

Chapter 6 Testing Payer Authentication Services

Test Case 21: Mastercard Identity Check Card Enrolled: Unsuccessful Authentication
(Customer Exited)

Card Number 5641821000010028

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

Test Case 22: Mastercard Identity Check Card Enrolled: Unavailable Authentication

Card Number 5200000000000064

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details Collection indicator 0
E-commerce indicator internet
proofXML proofXML value
VERes enrolled U
Action Submit the transaction. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 86

Chapter 6 Testing Payer Authentication Services

Test Case 23: Mastercard Identity Check Card Enrolled: Authentication Error

Card Number 5200000000000098 Without authentication window

Auth. Type Active authentication

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer We encountered a payer authentication
authentication. Please authenticate before problem: Error Processing PARes.
proceeding with authorization.
Details ACS URL URL value Collection indicator 0
PAReq PAReq value E-commerce indicator internet
proofXML proofXML value
VERes enrolled Y
XID XID value
Action Ask the customer for another form of payment. No liability shift.

Test Case 24: Mastercard Identity Check Enrollment Check Time-Out

Card Number 5200000000000049

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details Collection indicator 0
E-commerce indicator spa
proofXML proofXML value
Action After 10-12 seconds, proceed with the authorization message. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 87

Chapter 6 Testing Payer Authentication Services

Test Case 25: Mastercard Identity Check Enrollment Check Error

Card Number 5200000000000080

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details Collection indicator 0
E-commerce indicator internet
proofXML proofXML value
VERes enrolled U
Action Proceed with the authorization request, and contact your support representative to resolve the
issue. No liability shift. If you requested payer authentication and authorization together, the
authorization is processed automatically.

Test Case 26: Mastercard Identity Check RIBA_PASS

Card Number 5200180000000007

Auth. Type Passive authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

Payer Authentication Using the Simple Order API | October 2019 88

Chapter 6 Testing Payer Authentication Services

Test Case 27: Mastercard Identity Check RIBA_PASS: Unsuccessful Authentication

Card Number 5200180000000023

Auth. Type Passive authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

Test Case 28: Mastercard Identity Check RIBA

Card Number 5200260000000007 With authentication window

Auth. Type Risk-based bank

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

Payer Authentication Using the Simple Order API | October 2019 89

Chapter 6 Testing Payer Authentication Services

Test Case 29: Mastercard Identity Check RIBA: Unsuccessful Authentication

Card Number 5200260000000023 With authentication window

Auth. Type Risk-based bank

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

Payer Authentication Using the Simple Order API | October 2019 90

Chapter 6 Testing Payer Authentication Services

Maestro
Test Case 30: Maestro Card Enrolled: Successful Authentication

Card Number 6759411100000008 Without authentication window

6759410000006404 With authentication window
Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

Test Case 31: Maestro Card Enrolled: Successful Authentication but Invalid PARes

Card Number 6331101234567892 Without authentication window

Auth. Type Active authentication

Results Check Enrollment Validate Authentication
Summary Reason code 475 Reason code 476
The cardholder is enrolled in payer Payer authentication problem: PARes
authentication. Please authenticate before signature digest value mismatch. PARes
proceeding with authorization. message has been modified.
Details ACS URL URL Authentication result -1
PAReq PAReq value XID XID value
proofXML proofXML value
VERes enrolled Y
XID XID value
Action Do not process the authorization request. Instead ask the customer for another form of payment.

Payer Authentication Using the Simple Order API | October 2019 91

Chapter 6 Testing Payer Authentication Services

Test Case 32: Maestro Card Enrolled: Attempts Processing

Card Number 560000000000000193 Card enrollment option during purchase process

Auth. Type Activation during shopping

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.
authentication. Please authenticate before
proceeding with authorization.
Details ACS URL URL Authentication result 1
PAReq PAReq value AAV AAV value
proofXML proofXML value E-commerce indicator spa
VERes enrolled Y PARes status A
XID XID value XID XID value
Action This test card enables you to reproduce the process by which the customer enrolls the card during
the purchase. If the card is not enrolled, a card enrollment option windows appears in the
customer’s browser after the enrollment check. The customer can activate the card at that time or
later. In both cases, the card is authenticated, and validation is successful.
1 Add the signed PARes to the Validate Authentication request.
2 Ensure that the XID from the enrollment check matches that from the authentication validation.
3 Add the required payer authentication values to your authorization request.

Test Case 33: Maestro Card Enrolled: Incomplete Authentication

Card Number 6331101250353227 Without authentication window

Auth. Type Active authentication

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer Issuer unable to perform authentication.
authentication. Please authenticate before
proceeding with authorization.
Details ACS URL URL value Authentication result 6
PAReq PAReq value Collection indicator 0
proofXML proofXML value E-commerce indicator spa
VERes enrolled Y PARes status U
XID XID value XID XID value
Action Ask the customer for another form of payment, or submit the transaction. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 92

Chapter 6 Testing Payer Authentication Services

Test Case 34: Maestro Card Enrolled: Unsuccessful Authentication

Card Number 6331100610194313 Without authentication window

Auth. Type Active authentication

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer User failed authentication
authentication. Please authenticate before
proceeding with authorization.
Details ACS URL URL value Authentication result 9
PAReq PAReq value PARes status N
proofXML proofXML value XID XID value
VERes enrolled Y
XID XID value
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Test Case 35: Maestro Card Enrolled: Unavailable Authentication

Card Number 6331100266977839

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details Collection indicator 0
E-commerce indicator spa
proofXML proofXML value
Action Submit the transaction. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 93

Chapter 6 Testing Payer Authentication Services

Test Case 36: Maestro Card Enrolled: Authentication Error

Card Number 560000511607577094 Without authentication window

Auth. Type Active authentication

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer We encountered a payer authentication
authentication. Please authenticate before problem: Error Processing PARes.
proceeding with authorization.
Details ACS URL URL value Collection indicator 0
PAReq PAReq value E-commerce indicator internet
proofXML proofXML value
VERes enrolled Y
XID XID value
Action Do not request authorization. Instead ask the customer for another form of payment. No liability
shift.

Test Case 37: Maestro Enrollment Check Error

Card Number 560000841211092515

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

Payer Authentication Using the Simple Order API | October 2019 94

Chapter 6 Testing Payer Authentication Services

American Express SafeKey

Table 13 Possible Values for American Express SafeKey Reply Fields

Result and Interpretation Validate Authentication Reply

Authentication ECI Commerce Reason Code
Result Indicator
Success Successful authentication. 0 05 aesk 100

Recorded attempt to 1 06 aesk_ 100

authenticate. attempted
1
Failure System error that prevents the 6 —2 100
(Customer completion of authentication:
not you can proceed with
responsible) authorization, but there is no
liability shift.
Issuer unable to perform 6 07 internet 100
authentication.
Incomplete or unavailable 07 internet
authentication.
Invalid PARes. -1 — — 476
Failure Authentication failed or 9 — — 476
(Customer cardholder did not complete
responsible) authentication.
If the authentication fails, Visa
requires that you do not accept
the card. You must ask the
customer to use another
payment method.
1 The ECI value can vary depending on the reason for the failure.
2 A dash (—) indicates that the field is blank or absent.

Payer Authentication Using the Simple Order API | October 2019 95

Chapter 6 Testing Payer Authentication Services

Test Case 38: American Express SafeKey Card Enrolled: Successful Authentication

Card Number 340000000003961 Without authentication window

371449111020228 With authentication window
Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

Test Case 39: American Express SafeKey Card Enrolled: Successful Authentication but Invalid
PARes

Card Number 340000000006022

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

Payer Authentication Using the Simple Order API | October 2019 96

Chapter 6 Testing Payer Authentication Services

Test Case 40: American Express SafeKey Card Enrolled: Attempts Processing

Card Number 340000000003391 Without authentication window

344400000000569 Card enrollment option during purchase process
Auth. Type Activation during shopping
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

Test Case 41: American Express SafeKey Card Enrolled: Incomplete Authentication

Card Number 340000000002302 Without authentication window

Auth. Type Active authentication

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.
authentication. Please authenticate before
proceeding with authorization.
Details ACS URL URL value Authentication result 6
PAReq PAReq value E-commerce indicator internet
proofXML proofXML value ECI 07
VERes enrolled Y PARes status U
XID XID value XID XID value
Action Ask the customer for another form of payment, or submit the transaction. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 97

Chapter 6 Testing Payer Authentication Services

Test Case 42: American Express SafeKey Card Enrolled: Unsuccessful Authentication

Card Number 340000000000033 Without authentication window

Auth. Type Active authentication

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer  User failed authentication.
authentication. Please authenticate before
 Payer cannot be authenticated.
proceeding with authorization.
Details ACS URL URL value Authentication result 9
PAReq PAReq value PARes status N
proofXML proofXML value ECI 07
VERes enrolled Y XID XID value
XID XID value
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Test Case 43: American Express SafeKey Card Enrolled: Unavailable Authentication

Card Number 340000000007780

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details E-commerce indicator internet
proofXML proofXML value
VERes enrolled U
Action Submit your authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 98

Chapter 6 Testing Payer Authentication Services

Test Case 44: American Express SafeKey Card Enrolled: Authentication Error

Card Number 340000000009299

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer We encountered a payer authentication
authentication. Please authenticate before problem: Error Processing PARes.
proceeding with authorization.
Details ACS URL URL value ECI 07
PAReq PAReq value E-commerce Indicator internet
proofXML proofXML value
VERes enrolled Y
XID XID value
Action Ask the customer for another form of payment. No liability shift.

Test Case 45: American Express SafeKey Card Not Enrolled

Card Number 340000000008135

Auth. Type Non-participating bank
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details E-commerce indicator internet
ECI 07
proofXML proofXML value
VERes enrolled N
Action Submit the transaction.

Payer Authentication Using the Simple Order API | October 2019 99

Chapter 6 Testing Payer Authentication Services

Test Case 46: American Express SafeKey Enrollment Check: Time-Out

Card Number 340000000008309
Auth. Type Active authentication
Results Check Enrollment Validate Authentication
Summary Reason code 100
ics_pa_enroll service was successful.
Details E-commerce indicator internet
ECI 07
proofXML proofXML value
Action After 10-12 seconds, proceed with the authorization request. No liability shift.

Test Case 47: American Express SafeKey Enrollment Check Error

Card Number 340000000007244

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details E-commerce indicator internet
proofXML proofXML value
VERes enrolled U
Action Proceed with the authorization request, and contact your support representative to resolve the
issue. If you requested payer authentication and authorization together, the authorization is
processed automatically. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 100
Chapter 6 Testing Payer Authentication Services

JCB J/Secure
Table 14 Possible Values for JCB J/Secure Reply Fields

Result and Interpretation payerAuthValidateReply_

authentication eci commerceIndicator reasonCode
Result
Success Successful authentication. 0 05 js 100

Recorded attempt to 1 06 js_attempted 100

authenticate
1
Failure System error that prevents the 6 —2
(Customer completion of authentication:
not you can proceed with
responsible) authorization, but no liability
shift.
Issuer unable to perform 6 07 internet 100
authentication
Incomplete or unavailable 07 internet
authentication.
js_failure
Invalid PARes. -1 00 476
Failure Authentication failed or 9 — — 476
(Customer cardholder did not complete
responsible) authentication.
If the authentication fails, Visa
requires that you do not accept
the card. You must ask the
customer to use another
payment method.
1 The ECI value can vary depending on the reason for the failure.
2 A dash (—) indicates that the field is blank or absent.

Payer Authentication Using the Simple Order API | October 2019 101
Chapter 6 Testing Payer Authentication Services

Test Case 48: JCB J/Secure Card Enrolled: Successful Authentication

Card Number 3569990010083722 Without authentication window

Auth. Type Active authentication

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

Test Case 49: JCB J/Secure Card Enrolled: Successful Authentication but Invalid PARes
(Signature Failure)

Card Number 3569990010083748

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer We encountered a payer authentication
authentication. Please authenticate before problem: PARes signature digest value
proceeding with authorization. mismatch. PARes message has been modified.
Details ACS URL URL value Authentication result -1
PAReq PAReq value XID XID value
VERes enrolled Y
Action Do not proceed with authorization. Instead ask the customer for another form of payment.

Payer Authentication Using the Simple Order API | October 2019 102
Chapter 6 Testing Payer Authentication Services

Test Case 50: JCB J/Secure Card Enrolled: Attempted Authentication

Card Number 3569960010083758

Auth. Type Activation during shopping
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

Test Case 51: JCB J/Secure Card Enrolled: Incomplete Authentication (Unavailable)

Card Number 3541599998103643 Without authentication window

Auth. Type Active authentication

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

Payer Authentication Using the Simple Order API | October 2019 103
Chapter 6 Testing Payer Authentication Services

Test Case 52: JCB J/Secure Card Enrolled: Failed Authentication

Card Number 3569990110083721 Without authentication window

Auth. Type Active authentication

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

Test Case 53: JCB J/Secure Card Enrolled: Unavailable Authentication

Card Number 3541599999103865

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details E-commerce indicator internet
proofXML proofXML value
VERes enrolled U
Action Submit your authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 104
Chapter 6 Testing Payer Authentication Services

Test Case 54: JCB J/Secure Card Enrolled: Authentication Error Processing PARes

Card Number 3541599999103881

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer We encountered a payer authentication
authentication. Please authenticate before problem: Error Processing PARes.
proceeding with authorization.
Details ACS URL URL value ECI 07
PAReq PAReq value E-commerce indicator internet
proofXML proofXML value
VERes enrolled Y
XID XID value
Action Ask the customer for another form of payment. No liability shift.

Test Case 55: JCB J/Secure Card Not Enrolled

Card Number 3569970010083724

Auth. Type Non-participating bank
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details E-commerce indicator js_attempted
ECI 06
proofXML proofXML value
VERes enrolled N
Action Submit your authorization request.

Payer Authentication Using the Simple Order API | October 2019 105
Chapter 6 Testing Payer Authentication Services

Test Case 56: JCB J/Secure Enrollment Check: Time-Out

Card Number 3569980010083723
Auth. Type Active authentication
Results Check Enrollment Validate Authentication
Summary Reason code 100
ics_pa_enroll service was successful.
Details E-commerce indicator internet
proofXML proofXML value
Action After 10-12 seconds, proceed with the authorization request. No liability shift.

Test Case 57: JCB J/Secure Enrollment Check: Lookup Error Processing Message Request

Card Number 3541599969103614

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

Payer Authentication Using the Simple Order API | October 2019 106
Chapter 6 Testing Payer Authentication Services

Diners Club ProtectBuy

Table 15 Possible Values for Diners Club ProtectBuy Reply Fields

Result and Interpretation Validate Authentication Reply

Authentication ECI Commerce Reason Code
Result Indicator
Success Successful authentication. 0 05 pb 100

Recorded attempt to 1 06 pb_ 100

Incomplete or unavailable 07 internet

authentication.
Invalid PARes. -1 — — 476
Failure Authentication failed or 9 — — 476
(Customer cardholder did not complete
responsible) authentication.
If the authentication fails, Visa
requires that you do not accept
the card. You must ask the
customer to use another
payment method.
1 The ECI value can vary depending on the reason for the failure.
2 A dash (—) indicates that the field is blank or absent.

Payer Authentication Using the Simple Order API | October 2019 107
Chapter 6 Testing Payer Authentication Services

Test Case 58: Diners Club ProtectBuy Card Enrolled: Successful Authentication

Card Number 3005000000006246

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.

authentication. Please authenticate before
proceeding with authorization.
Details ACS URL URL Authentication result 0
PAReq PAReq value CAVV CAVV value
proofXML proofXML value E-commerce indicator pb
VERes enrolled Y ECI 05
XID XID value PARes status Y
XID XID value
Action 1 Add the signed PARes to the Validate Authentication request.
2 Ensure that the XID from the enrollment check matches that from the authentication validation.
3 Add the CAVV and ECI values to your authorization request.

Test Case 59: Diners Club ProtectBuy Card Enrolled: Successful Authentication but Invalid PARes

Card Number 3005000000004373

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

Payer Authentication Using the Simple Order API | October 2019 108
Chapter 6 Testing Payer Authentication Services

Test Case 60: Diners Club ProtectBuy Card Enrolled: Attempts Processing

Card Number 3005000000005271 Card enrollment option during purchase process

Auth. Type Activation during shopping

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

Test Case 61: Diners Club ProtectBuy Card Enrolled: Incomplete Authentication

Card Number 3005000000007376

Auth. Type Active authentication
Results Check Enrollment Validate Authentication
Summary Reason code 475 Reason code 100
The cardholder is enrolled in payer  Issuer unable to perform authentication.
authentication. Please authenticate before
 ics_pa_validate service was successful.
proceeding with authorization.
Details ACS URL URL value Authentication result 6
PAReq PAReq value E-commerce indicator internet
proofXML proofXML value ECI 07
VERes enrolled Y PARes status U
XID XID value XID XID value
Action Ask the customer for another form of payment, or submit the transaction. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 109
Chapter 6 Testing Payer Authentication Services

Test Case 62: Diners Club ProtectBuy Card Enrolled: Unsuccessful Authentication

Card Number 3005000000005925

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

Test Case 63: Diners Club ProtectBuy Card Enrolled: Unavailable Authentication

Card Number 3005000000006030

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details E-commerce indicator internet
proofXML proofXML value
VERes enrolled U
Action Submit your authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 110
Chapter 6 Testing Payer Authentication Services

Test Case 64: Diners Club ProtectBuy Card Enrolled: Authentication Error

Card Number 3005000000005602

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

Test Case 65: Diners Club ProtectBuy Card Not Enrolled

Card Number 3005000000007269

Auth. Type Non-participating bank
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details E-commerce indicator internet
ECI 07
proofXML proofXML value
VERes enrolled N
Action Submit the transaction.

Payer Authentication Using the Simple Order API | October 2019 111
Chapter 6 Testing Payer Authentication Services

Test Case 66: Diners Club ProtectBuy Enrollment Check: Time-Out

Card Number 3005000000001890
Auth. Type Active authentication
Results Check Enrollment Validate Authentication
Summary Reason code 100
ics_pa_enroll service was successful.
Details E-commerce indicator internet
proofXML proofXML value
Action After 10-12 seconds, proceed with the authorization request. No liability shift.

Test Case 67: Diners Club ProtectBuy Enrollment Check Error

Card Number 3005000000009877 Error response

3005000000004837 Incorrect Configuration: Unable to Authenticate
Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

Payer Authentication Using the Simple Order API | October 2019 112
Chapter 6 Testing Payer Authentication Services

Discover ProtectBuy
Table 16 Possible Values for Discover ProtectBuy Reply Fields

Result and Interpretation Validate Authentication Reply

Authentication ECI Commerce Reason Code
Result Indicator
Success Successful authentication. 0 05 dipb 100

Recorded attempt to 1 06 dipb_ 100

Incomplete or unavailable 07 internet

Payer Authentication Using the Simple Order API | October 2019 113
Chapter 6 Testing Payer Authentication Services

Test Case 68: Discover ProtectBuy Card Enrolled: Successful Authentication

Card Number 6011000000000004

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.

authentication. Please authenticate before
proceeding with authorization.
Details ACS URL URL Authentication result 0
PAReq PAReq value CAVV CAVV value
proofXML proofXML value E-commerce indicator dipb
VERes enrolled Y ECI 05
XID XID value PARes status Y
XID XID value
Action 1 Add the signed PARes to the Validate Authentication request.
2 Ensure that the XID from the enrollment check matches that from the authentication validation.
3 Add the CAVV and ECI values to your authorization request.

Test Case 69: Discover ProtectBuy Card Enrolled: Successful Authentication but Invalid PARes

Card Number 6011000000000012

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

Payer Authentication Using the Simple Order API | October 2019 114
Chapter 6 Testing Payer Authentication Services

Test Case 70: Discover ProtectBuy Card Enrolled: Attempts Processing

Card Number 6011000000000038 Card enrollment option during purchase process

Auth. Type Activation during shopping

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

Test Case 71: Discover ProtectBuy Card Enrolled: Incomplete Authentication

Card Number 6011000000000103

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

Payer Authentication Using the Simple Order API | October 2019 115
Chapter 6 Testing Payer Authentication Services

Test Case 72: Discover ProtectBuy Card Enrolled: Unsuccessful Authentication

Card Number 6011000000000020

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

Test Case 73: Discover ProtectBuy Card Enrolled: Unavailable Authentication

Card Number 6011000000000061

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details E-commerce indicator internet
proofXML proofXML value
VERes enrolled U
Action Submit your authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 116
Chapter 6 Testing Payer Authentication Services

Test Case 74: Discover ProtectBuy Card Enrolled: Authentication Error

Card Number 6011000000000095

Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

Test Case 75: Discover ProtectBuy Card Not Enrolled

Card Number 6011000000000053

Auth. Type Non-participating bank
Results Check Enrollment Validate Authentication

Summary Reason code 100

ics_pa_enroll service was successful.
Details E-commerce indicator internet
ECI 07
proofXML proofXML value
VERes enrolled N
Action Submit the transaction.

Payer Authentication Using the Simple Order API | October 2019 117
Chapter 6 Testing Payer Authentication Services

Test Case 76: Discover ProtectBuy Enrollment Check: Time-Out

Card Number 6011000000000046
Auth. Type Active authentication
Results Check Enrollment Validate Authentication
Summary Reason code 100
ics_pa_enroll service was successful.
Details E-commerce indicator internet
proofXML proofXML value
Action After 10-12 seconds, proceed with the authorization request. No liability shift.

Test Case 77: Discover ProtectBuy Enrollment Check Error

Card Number 6011000000000087 Error response

6011000000000079 Incorrect Configuration: Unable to Authenticate
Auth. Type Active authentication
Results Check Enrollment Validate Authentication

Summary Reason code 100

Payer Authentication Using the Simple Order API | October 2019 118
Chapter 6 Testing Payer Authentication Services

Test Cases for 3D Secure 2.x

This section includes test cases for the Cardinal Cruise Hybrid or Standard integration.

Use the card number specified in the test with the card’s expiration date set to the month
of January and the current year plus three. For example, for 2019, use 2022. You also
need the minimum required fields for an order.

XID values are included in 3D Secure 2.x test cases for legacy reasons.
The 3D Secure version and directory server transaction ID fields are returned
Note for the Check Enrollment and Validate Authentication services but are not
included in the 3D Secure 2.x test cases.

Visa Secure
Test Case 2.1: Visa Secure Card Enrolled: Successful Frictionless Authentication (Hybrid and
Standard)

Card Number 4000000000001000

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status Y
CAVV CAVV value
E-commerce indicator vbv
ECI 05
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Payer Authentication Using the Simple Order API | October 2019 119
Chapter 6 Testing Payer Authentication Services

Test Case 2.2: Visa Secure Card Enrolled: Unsuccessful Frictionless Authentication (Hybrid and
Standard)

Card Number 4000000000001018

Results Check Enrollment Validate Authentication

Summary Reason code 476 NA

 User failed authentication.
 Payer cannot be authenticated.
Details VERes enrolled Y
PARes status N
E-commerce indicator internet or vbv_failure
ECI 07
Action It is not recommended to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Test Case 2.3: Visa Secure Card Enrolled: Attempts Processing Frictionless Authentication (Hybrid
and Standard)

Card Number 4000000000001026

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status A
CAVV CAVV value
E-commerce indicator vbv_attempted
ECI 06
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Payer Authentication Using the Simple Order API | October 2019 120
Chapter 6 Testing Payer Authentication Services

Test Case 2.4: Visa Secure Card Enrolled: Unavailable Frictionless Authentication (Hybrid and
Standard)

Card Number 4000000000001034

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status U
E-commerce indicator internet or vbv_failure
ECI 07
Action Submit your authorization request. No liability shift.

Test Case 2.5: Visa Secure Card Enrolled: Rejected Frictionless Authentication (Hybrid and
Standard)

Card Number 4000000000001042

Results Check Enrollment Validate Authentication

Summary Reason code 476 NA

 User failed authentication.
 Payer cannot be authenticated.
Details VERes enrolled Y
PARes status R
E-commerce indicator internet or vbv_failure
ECI 07
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Test Case 2.6: Visa Secure Card Enrolled: Authentication not Available on Lookup (Hybrid and
Standard)

Card Number 4000000000001059

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled U
E-commerce indicator internet or vbv_failure
Action Submit your authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 121
Chapter 6 Testing Payer Authentication Services

Test Case 2.7: Visa Secure Enrollment Check Error (Hybrid and Standard)

Card Number 4000000000001067

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled U
E-commerce indicator internet or vbv_failure
Action Proceed with the authorization request, and contact your support representative to resolve the
issue. No liability shift. If you requested payer authentication and authorization together, the
authorization is processed automatically.

Test Case 2.8: Visa Secure Enrollment Check: Time-Out (Hybrid only)
Card Number 4000000000001075
Results Check Enrollment Validate Authentication
Summary Reason code 100 NA
ics_pa_enroll service was successful.
Details PARes status U
E-commerce indicator internet or vbv_failure
ECI 07
Action After 10-12 seconds, proceed with the authorization request. No liability shift.

Test Case 2.9: Visa Secure Bypassed Authentication (Hybrid and Standard)
Card Number 4000000000001083
Results Check Enrollment Validate Authentication
Summary Reason code 100 NA
ics_pa_enroll service was successful.
Details VERes enrolled B
E-commerce indicator internet
Action Submit your authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 122
Chapter 6 Testing Payer Authentication Services

Test Case 2.10a: Visa Secure Card Enrolled: Successful Step Up Authentication (Hybrid)

Card Number 4000000000001091

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

ACS URL URL value CAVV CAVV value

E-commerce indicator vbv

ECI 05
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Test Case 2.10b: Visa Secure Card Enrolled: Successful Step Up Authentication (Standard)

Card Number 4000000000001091

Results Check Enrollment

Summary Reason code 100

Payer Authentication Using the Simple Order API | October 2019 123
Chapter 6 Testing Payer Authentication Services

Test Case 2.11a: Visa Secure Card Enrolled: Unsuccessful Step Up Authentication (Hybrid)

Card Number 4000000000001109

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer  User failed authentication.
authentication. Please authenticate before
 Payer cannot be authenticated.
proceeding with authorization.
Details VERes enrolled Y
PAReq PAReq value PARes status N
ACS URL URL value ECI 07
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Test Case 2.11b: Visa Secure Card Enrolled: Unsuccessful Step Up Authentication (Standard)

Card Number 4000000000001109

Results Check Enrollment

Summary Reason code 476

 User failed authentication.
 Payer cannot be authenticated.
Details VERes enrolled Y
PARes status N
ECI 07
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Test Case 2.12a: Visa Secure Card Enrolled: Unavailable Step Up Authentication (Hybrid)

Card Number 4000000000001117

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.
authentication. Please authenticate before
proceeding with authorization.
Details VERes enrolled Y
PAReq PAReq value PARes status U
ACS URL URL value E-commerce indicator internet or vbv_failure
ECI 07
Action Retry authentication or process without liability shift.

Payer Authentication Using the Simple Order API | October 2019 124
Chapter 6 Testing Payer Authentication Services

Test Case 2.12b: Visa Secure Card Enrolled: Unavailable Step Up Authentication (Standard)

Card Number 4000000000001117

Results Check Enrollment

Summary Reason code 100

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status U
E-commerce indicator internet or vbv_failure
ECI 07
Action Retry authentication or process without liability shift.

Payer Authentication Using the Simple Order API | October 2019 125
Chapter 6 Testing Payer Authentication Services

Mastercard Identity Check

Mastercard requires that the 3D Secure version and directory server

transaction ID are included along with all pertinent data in your authorization
Note request.

Test Case 2.13: Mastercard Identity Check Card Enrolled: Successful Frictionless Authentication
(Hybrid and Standard)

Card Number 5200000000001005

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.

Details VERes enrolled Y
PARes status Y
AAV AAV value
E-commerce indicator spa
Collection indicator 2
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Test Case 2.14: Mastercard Identity Check Card Enrolled: Unsuccessful Frictionless
Authentication (Hybrid and Standard)

Card Number 5200000000001013

Results Check Enrollment Validate Authentication

Summary Reason code 476 NA

 User failed authentication.
 Payer cannot be authenticated.
Details VERes enrolled Y
PARes status N
E-commerce indicator internet
Collection indicator 0
Action It is not recommended to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Payer Authentication Using the Simple Order API | October 2019 126
Chapter 6 Testing Payer Authentication Services

Test Case 2.15: Mastercard Identity Check Card Enrolled: Attempts Processing Frictionless
Authentication (Hybrid and Standard)

Card Number 5200000000001021

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status A
AAV AAV value
E-commerce indicator spa
Collection indicator 1
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Test Case 2.16: Mastercard Identity Check Card Enrolled: Unavailable Frictionless Authentication
(Hybrid and Standard)

Card Number 5200000000001039

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status U
E-commerce indicator internet
Collection indicator 0
Action Submit your authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 127
Chapter 6 Testing Payer Authentication Services

Test Case 2.17: Mastercard Identity Check Card Enrolled: Rejected Frictionless Authentication
(Hybrid and Standard)

Card Number 5200000000001047

Results Check Enrollment Validate Authentication

Summary Reason code 476 NA

 User failed authentication.
 Payer cannot be authenticated.
Details VERes enrolled Y
PARes status R
E-commerce indicator internet
Collection indicator 0
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Test Case 2.18: Mastercard Identity Check Card Enrolled: Authentication not Available on Lookup
(Hybrid and Standard)

Card Number 5200000000001054

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled U
E-commerce indicator internet
Collection indicator 0
Action Submit your authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 128
Chapter 6 Testing Payer Authentication Services

Test Case 2.19: Mastercard Identity Check Enrollment Check Error (Hybrid and Standard)

Card Number 5200000000001062

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled U
E-commerce indicator internet
Collection indicator 0
Action Proceed with the authorization request, and contact your support representative to resolve the
issue. No liability shift. If you requested payer authentication and authorization together, the
authorization is processed automatically.

Test Case 2.20: Mastercard Identity Check Enrollment Check: Time-Out (Hybrid only)
Card Number 5200000000001070
Results Check Enrollment Validate Authentication
Summary Reason code 100 NA
ics_pa_enroll service was successful.
Details PARes status U
E-commerce indicator internet
Collection indicator 0
Action After 10-12 seconds, proceed with the authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 129
Chapter 6 Testing Payer Authentication Services

Test Case 2.21: Mastercard Identity Check Bypassed Authentication (Hybrid and Standard)
Card Number 5200000000001088
Results Check Enrollment Validate Authentication
Summary Reason code 100 NA
ics_pa_enroll service was successful.
Details VERes enrolled B
E-commerce indicator internet
Collection indicator 0
Action Submit your authorization request. No liability shift.

Test Case 2.22a: Mastercard Identity Check Card Enrolled: Successful Step Up Authentication
(Hybrid)

Card Number 5200000000001096

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.
authentication. Please authenticate before
proceeding with authorization.
Details VERes enrolled Y
PAReq PAReq value PARes status Y
ACS URL URL value AAV AAV value
E-commerce indicator spa
Collection indicator 2
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Payer Authentication Using the Simple Order API | October 2019 130
Chapter 6 Testing Payer Authentication Services

Test Case 2.22b: Mastercard Identity Check Card Enrolled: Successful Step Up Authentication
(Standard)

Card Number 5200000000001096

Results Check Enrollment

Summary Reason code 100

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status Y
AAV AAV value
E-commerce indicator spa
Collection indicator 2
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Test Case 2.23a: Mastercard Identity Check Card Enrolled: Unsuccessful Step Up Authentication
(Hybrid)

Card Number 5200000000001104

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer  User failed authentication.
authentication. Please authenticate before
 Payer cannot be authenticated.
proceeding with authorization.
Details VERes enrolled Y
PAReq PAReq value PARes status N
ACS URL URL value Collection indicator 0
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Payer Authentication Using the Simple Order API | October 2019 131
Chapter 6 Testing Payer Authentication Services

Test Case 2.23b: Mastercard Identity Check Card Enrolled: Unsuccessful Step Up Authentication
(Standard)

Card Number 5200000000001104

Results Check Enrollment

Summary Reason code 476

 User failed authentication.
 Payer cannot be authenticated.
Details VERes enrolled Y
PARes status N
Collection indicator 0
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Test Case 2.24a: Mastercard Identity Check Card Enrolled: Unavailable Step Up Authentication
(Hybrid)

Card Number 5200000000001112

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.
authentication. Please authenticate before
proceeding with authorization.
Details VERes enrolled Y
PAReq PAReq value PARes status U
ACS URL URL value E-commerce indicator internet
Collection indicator 0
Action Retry authentication or process without liability shift.

Payer Authentication Using the Simple Order API | October 2019 132
Chapter 6 Testing Payer Authentication Services

Test Case 2.24b: Mastercard Identity Check Card Enrolled: Unavailable Step Up Authentication
(Standard)

Card Number 5200000000001112

Results Check Enrollment

Summary Reason code 100

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status U
E-commerce indicator internet
Collection indicator 0
Action Retry authentication or process without liability shift.

Payer Authentication Using the Simple Order API | October 2019 133
Chapter 6 Testing Payer Authentication Services

American Express SafeKey

Test Case 2.25: American Express SafeKey Card Enrolled: Successful Frictionless Authentication
(Hybrid and Standard)

Card Number 340000000001007

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.

Details VERes enrolled Y
PARes status Y
CAVV CAVV value
E-commerce indicator aesk
ECI 05
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Test Case 2.26: American Express SafeKey Card Enrolled: Unsuccessful Frictionless
Authentication (Hybrid and Standard)

Card Number 340000000001015

Results Check Enrollment Validate Authentication

Summary Reason code 476 NA

 User failed authentication.
 Payer cannot be authenticated.
Details VERes enrolled Y
PARes status N
E-commerce indicator internet
ECI 07
Action It is not recommended to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Payer Authentication Using the Simple Order API | October 2019 134
Chapter 6 Testing Payer Authentication Services

Test Case 2.27: American Express SafeKey Card Enrolled: Attempts Processing
Frictionless Authentication (Hybrid and Standard)

Card Number 340000000001023

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status A
CAVV CAVV value
E-commerce indicator aesk_attempted
ECI 06
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Test Case 2.28: American Express SafeKey Card Enrolled: Unavailable Frictionless Authentication
(Hybrid and Standard)

Card Number 340000000001031

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status U
E-commerce indicator internet
ECI 07
Action Submit your authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 135
Chapter 6 Testing Payer Authentication Services

Test Case 2.29: American Express SafeKey Card Enrolled: Rejected Frictionless Authentication
(Hybrid and Standard)

Card Number 340000000001049

Results Check Enrollment Validate Authentication

Summary Reason code 476 NA

 User failed authentication.
 Payer cannot be authenticated.
Details VERes enrolled Y
PARes status R
E-commerce indicator internet
ECI 07
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Test Case 2.30: American Express SafeKey Card Enrolled: Authentication not Available on Lookup
(Hybrid and Standard)

Card Number 340000000001056

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled U
E-commerce indicator internet
Action Submit your authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 136
Chapter 6 Testing Payer Authentication Services

Test Case 2.31: American Express SafeKey Enrollment Check Error (Hybrid and Standard)

Card Number 340000000001064

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled U
E-commerce indicator internet
Action Proceed with the authorization request, and contact your support representative to resolve the
issue. No liability shift. If you requested payer authentication and authorization together, the
authorization is processed automatically.

Test Case 2.32: American Express SafeKey Enrollment Check: Time-Out (Hybrid only)
Card Number 340000000001072
Results Check Enrollment Validate Authentication
Summary Reason code 100 NA
ics_pa_enroll service was successful.
Details VERes enrolled U
E-commerce indicator internet
ECI 07
Action After 10-12 seconds, proceed with the authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 137
Chapter 6 Testing Payer Authentication Services

Test Case 2.33: American Express SafeKey Bypassed Authentication (Hybrid and Standard)
Card Number 340000000001080
Results Check Enrollment Validate Authentication
Summary Reason code 100 NA
ics_pa_enroll service was successful.
Details VERes enrolled B
E-commerce indicator internet
ECI 07
Action Submit your authorization request. No liability shift.

Test Case 2.34a: American Express SafeKey Card Enrolled: Successful Step Up Authentication
(Hybrid)

Card Number 340000000001098

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.
authentication. Please authenticate before
proceeding with authorization.
Details VERes enrolled Y
PAReq PAReq value PARes status Y
ACS URL URL value CAVV CAVV value
E-commerce indicator aesk
ECI 05
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Payer Authentication Using the Simple Order API | October 2019 138
Chapter 6 Testing Payer Authentication Services

Test Case 2.34b: American Express SafeKey Card Enrolled: Successful Step Up Authentication
(Standard)

Card Number 340000000001098

Results Check Enrollment

Summary Reason code 100

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status Y
CAVV CAVV value
E-commerce indicator aesk
ECI 05
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Test Case 2.35a: American Express SafeKey Card Enrolled: Unsuccessful Step Up Authentication
(Hybrid)

Card Number 340000000001106

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer  User failed authentication.
authentication. Please authenticate before
 Payer cannot be authenticated.
proceeding with authorization.
Details VERes enrolled Y
PAReq PAReq value PARes status N
ACS URL URL value ECI 07
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Payer Authentication Using the Simple Order API | October 2019 139
Chapter 6 Testing Payer Authentication Services

Test Case 2.35b: American Express SafeKey Card Enrolled: Unsuccessful Step Up Authentication
(Standard)

Card Number 340000000001106

Results Check Enrollment

Summary Reason code 476

Test Case 2.36a: American Express SafeKey Card Enrolled: Unavailable Step Up Authentication
(Hybrid)

Card Number 340000000001114

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.
authentication. Please authenticate before
proceeding with authorization.
Details VERes enrolled Y
PAReq PAReq value PARes status U
ACS URL URL value E-commerce indicator internet
ECI 07
Action Retry authentication or process without liability shift.

Payer Authentication Using the Simple Order API | October 2019 140
Chapter 6 Testing Payer Authentication Services

Test Case 2.36b: American Express SafeKey Card Enrolled: Unavailable Step Up Authentication
(Standard)

Card Number 340000000001114

Results Check Enrollment

Summary Reason code 100

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status U
E-commerce indicator internet
ECI 07
Action Retry authentication or process without liability shift.

Payer Authentication Using the Simple Order API | October 2019 141
Chapter 6 Testing Payer Authentication Services

Discover ProtectBuy and Diners Club ProtectBuy

To test Diners Club ProtectBuy, use the Discover card numbers in the
following section, but use card type of 005 (Diners) rather than 004
Note (Discover).

Test Case 2.37: Discover/Diner ProtectBuy Card Enrolled: Successful Frictionless Authentication
(Hybrid and Standard)

Card Number 6011000000001002

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.

Details VERes enrolled Y
PARes status Y
CAVV CAVV value
E-commerce indicator dipb (Discover)
pb (Diners Club)
ECI 05
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Test Case 2.38: Discover/Diner ProtectBuy Card Enrolled: Unsuccessful Frictionless

Authentication (Hybrid and Standard)

Card Number 6011000000001010

Results Check Enrollment Validate Authentication

Summary Reason code 476 NA

Payer Authentication Using the Simple Order API | October 2019 142
Chapter 6 Testing Payer Authentication Services

Test Case 2.39: Discover/Diner ProtectBuy Card Enrolled: Attempts Processing Frictionless
Authentication (Hybrid and Standard)

Card Number 6011000000001028

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status A
CAVV CAVV value
E-commerce indicator dipb_attempted
(Discover)
pb_attempted (Diners
Club)
ECI 06
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Test Case 2.40: Discover/Diner ProtectBuy Card Enrolled: Unavailable Frictionless Authentication
(Hybrid and Standard)

Card Number 6011000000001036

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status U
E-commerce indicator internet
ECI 07
Action Submit your authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 143
Chapter 6 Testing Payer Authentication Services

Test Case 2.41: Discover/Diner ProtectBuy Card Enrolled: Rejected Frictionless Authentication
(Hybrid and Standard)

Card Number 6011000000001044

Results Check Enrollment Validate Authentication

Summary Reason code 476 NA

Test Case 2.42: Discover/Diner ProtectBuy Card Enrolled: Authentication not Available on Lookup
(Hybrid and Standard)

Card Number 6011000000001051

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

ics_pa_enroll service was successful.
Details VERes enrolled U
E-commerce indicator internet
Action Submit your authorization request. No liability shift.

Test Case 2.43: Discover/Diner ProtectBuy Enrollment Check Error (Hybrid and Standard)

Card Number 6011000000001069

Results Check Enrollment Validate Authentication

Summary Reason code 100 NA

Payer Authentication Using the Simple Order API | October 2019 144
Chapter 6 Testing Payer Authentication Services

Test Case 2.44: Discover/Diner ProtectBuy Enrollment Check: Time-Out (Hybrid only)
Card Number 6011000000001077
Results Check Enrollment Validate Authentication
Summary Reason code 100 NA
ics_pa_enroll service was successful.
Details VERes enrolled U
E-commerce indicator internet
ECI 07
Action After 10-12 seconds, proceed with the authorization request. No liability shift.

Test Case 2.45: Discover/Diner ProtectBuy Bypassed Authentication (Hybrid and Standard)
Card Number 6011000000001085
Results Check Enrollment Validate Authentication
Summary Reason code 100 NA
ics_pa_enroll service was successful.
Details VERes enrolled B
E-commerce indicator internet
ECI 07
Action Submit your authorization request. No liability shift.

Payer Authentication Using the Simple Order API | October 2019 145
Chapter 6 Testing Payer Authentication Services

Test Case 2.46a: Discover/Diner ProtectBuy Card Enrolled: Successful Step Up Authentication
(Hybrid)

Card Number 6011000000001093

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.
authentication. Please authenticate before
proceeding with authorization.
Details VERes enrolled Y
PAReq PAReq value PARes status Y
ACS URL URL value CAVV CAVV value
E-commerce indicator dipb (Discover)
pb (Diners Club)
ECI 05
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Test Case 2.46b: Discover/Diner ProtectBuy Card Enrolled: Successful Step Up Authentication
(Standard)

Card Number 6011000000001093

Results Check Enrollment

Summary Reason code 100

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status Y
CAVV CAVV value
E-commerce indicator dipb (Discover)
pb (Diners Club)
ECI 05
XID XID value
Action If you request Validate Authentication and authorization services separately, add the required
payer authentication values to your authorization request. If you request the Validate
Authentication and authorization services together, the process described above occurs
automatically.

Payer Authentication Using the Simple Order API | October 2019 146
Chapter 6 Testing Payer Authentication Services

Test Case 2.47a: Discover/Diner ProtectBuy Card Enrolled: Unsuccessful Step Up Authentication
(Hybrid)

Card Number 6011000000001101

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 476

The cardholder is enrolled in payer  User failed authentication.
authentication. Please authenticate before
 Payer cannot be authenticated.
proceeding with authorization.
Details VERes enrolled Y
PAReq PAReq value PARes status N
ACS URL URL value ECI 07
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Test Case 2.47b: Discover/Diner ProtectBuy Card Enrolled: Unsuccessful Step Up Authentication
(Standard)

Card Number 6011000000001101

Results Check Enrollment

Summary Reason code 476

 User failed authentication.
 Payer cannot be authenticated.
Details VERes enrolled Y
PAReq status N
ECI 07
Action You are not permitted to submit this transaction for authorization. Instead ask the customer for
another form of payment.

Payer Authentication Using the Simple Order API | October 2019 147
Chapter 6 Testing Payer Authentication Services

Test Case 2.48a: Discover/Diner ProtectBuy Card Enrolled: Unavailable Step Up Authentication
(Hybrid)

Card Number 6011000000001119

Results Check Enrollment Validate Authentication

Summary Reason code 475 Reason code 100

The cardholder is enrolled in payer ics_pa_validate service was successful.
authentication. Please authenticate before
proceeding with authorization.
Details VERes enrolled Y
PAReq PAReq value PARes status U
ACS URL URL value E-commerce indicator internet
ECI 07
Action Retry authentication or process without liability shift.

Test Case 2.48b: Discover/Diner ProtectBuy Card Enrolled: Unavailable Step Up Authentication
(Standard)

Card Number 6011000000001119

Results Check Enrollment

Summary Reason code 100

ics_pa_enroll service was successful.
Details VERes enrolled Y
PARes status U
E-commerce indicator internet
ECI 07
Action Retry authentication or process without liability shift.

Payer Authentication Using the Simple Order API | October 2019 148
APPENDIX
API Fields
A

This appendix describes the Simple Order API fields that you can use to access
CyberSource Payer Authentication services. The API and client toolkits can be
downloaded from the CyberSource web site at the following URL:

http://www.cybersource.com/developers/develop/integration_methods/simple_order_
and_soap_toolkit_api/

The 3D Secure 2.x. fields are in beta release. The field descriptions, values,
and lengths are subject to change.
Note

Formatting Restrictions
Unless otherwise noted, all field names are case sensitive and all fields accept special
characters such as @, #, and %.

The values of the item_#_ fields must not contain carets (^) or colons (:)
because these characters are reserved for use by the CyberSource services.
Note For Atos, the billTo_ fields must not contain colons (:).
The values of all request fields must not contain new lines or carriage returns.
However, they can contain embedded spaces and any other printable
characters. All leading and trailing spaces will be removed.

Data Type Definitions

For more information about these data types, see the World Wide Web Consortium (W3C)
XML Schema Part 2: Datatypes specification:

Payer Authentication Using the Simple Order API | October 2019 149
Appendix A API Fields

http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/

Data Type Description

Integer Whole number {…, -3, -2, -1, 0, 1, 2, 3, …}.
String Sequence of letters, numbers, spaces, and special characters, such as @ and #.

Numbered Elements
The CyberSource XML schema includes several numbered elements. You can include
these complex elements more than once in a request. For example, when a customer
order includes more than one item, you must include multiple <item> elements in your
request. Each item is numbered, starting with 0. The XML schema uses an id attribute in
the item’s opening tag to indicate the number. For example:
<item id="0">

As a name-value pair field name, this tag is represented as item_0. In this portion of the
field name, the underscore before the number does not indicate hierarchy in the XML
schema. The item fields are generically referred to as item_#_<element name> in the
documentation.

Below is an example of the numbered <item> element and the corresponding name-
value pair field names. If you are using the Simple Object Access Protocol (SOAP), the
client contains a corresponding Item class.
Example 21 Numbered XML Schema Element Names and
Name-Value Pair Field Names

XML Schema Corresponding Name-Value

Element Names Pair Field Names
<item id="0">
<unitPrice> item_0_unitPrice
<quantity> item_0_quantity
</item>
<item id="1">
<unitPrice> item_1_unitPrice
<quantity> item_1_quantity
</item>

When a request is in XML format and includes an <item> element, the

element must include an id attribute. For example: <item id="0">.
Important

Payer Authentication Using the Simple Order API | October 2019 150
Appendix A API Fields

Request Fields
See Credit Card Services Using the Simple Order API (PDF | HTML) and Getting Started
with CyberSource Advanced (PDF | HTML) for more information about using the Simple
Order API to access CyberSource services using either name-value pairs or XML.

The fields in the following table refer to the enroll and validate services only.
Please review Credit Card Services Using the Simple Order API (PDF | HTML)
Note for more information about the fields specific to the authorization.

Table 17 Request Fields

Field Name Description Required/ Type &

Optional Length
airlineData_leg_#_ International Air Transport Association (IATA) Enroll (O) String (2)
carrierCode code for the carrier for this leg of the trip.
Required for each leg.
Required for American Express SafeKey (U.S.)
for travel-related requests.
airlineData_leg_#_ Departure date for the first leg of the trip. Enroll (O) Integer (8)
departureDate Format: YYYYMMDD.
Required for American Express SafeKey (U.S.)
for travel-related requests.
Note The numbered element name should
contain 0 instead of #. Payer Authentication
services only use the first leg of the trip. See
"Numbered Elements," page 150.
airlineData_leg_#_ International Air Transport Association (IATA) Enroll (O) String (5)
destination code for the destination airport for this leg of the
trip.
Required for each leg.
Required for American Express SafeKey (U.S.)
for travel-related requests.
airlineData_leg_#_ International Air Transport Association (IATA) Enroll (O) String (5)
originatingAirportCode code for the originating airport for the first leg of
the trip.
Required for American Express SafeKey (U.S.)
for travel-related requests.

Payer Authentication Using the Simple Order API | October 2019 151
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
airlineData_ Number of passengers for whom the ticket was Enroll (O) Integer (3)
numberOfPassengers issued. If you do not include this field in your
request, CyberSource uses a default value of 1.
Required for American Express SafeKey (U.S.)
for travel-related requests.
airlineData_passenger_#_ First name of the passenger to whom the ticket Enroll (O) String (60)
firstName was issued. If there are multiple passengers,
include all listed on the ticket.
Do not include special characters such as
commas, hyphens, or apostrophes. Only ASCII
characters are supported.
Required for American Express SafeKey (U.S.)
for travel-related requests.
airlineData_passenger_#_ Last name of the passenger to whom the ticket Enroll (O) String (60)
lastName was issued. If there are multiple passengers,
include all listed on the ticket.
Do not include special characters such as
commas, hyphens, or apostrophes. Only ASCII
characters are supported.
Required for American Express SafeKey (U.S.)
for travel-related requests.
billTo_city City of the billing address. Enroll (R) String (50)
billTo_country Billing country for the account. Use the two- Enroll (R) String (2)
character country codes.
billTo_ Date the cardholder’s account was last Enroll (O) Integer (8)
customerAccountChange changed. This includes changes to the billing or
Date shipping address, new payment accounts or
new users added.
This field can contain one of these values:
 -1: Guest account
 0: Changed during this transaction
If neither applies, enter the date in YYYYMMDD
format.
Recommended for Discover ProtectBuy.

Payer Authentication Using the Simple Order API | October 2019 152
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
billTo_ Date the cardholder opened the account. Enroll (O) Integer (8)
customerAccountCreate
This field can contain one of these values:
Date
 -1: Guest account
 0: Opened during this transaction
If neither applies, enter the date in YYYYMMDD
format.
Recommended for Discover ProtectBuy.
billTo_ Date the cardholder last changed or reset Enroll (O) Integer (8)
customerAccount password on account.
PasswordChange
This field can contain one of these values:
Date
 -1: Guest account
 0: Changed during this transaction
If neither applies, enter the date in YYYYMMDD
format.
Recommended for Discover ProtectBuy.
billTo_email Customer’s email address, including the full Enroll (R) String (255)
domain name. Use the following format:
[email protected] (for example,
[email protected]).
billTo_firstName Customer’s first name.The value should be the Enroll (R) String (60)
same as the value that appears on the card.
billTo_ Indicates the bit depth of the color palette for Enroll (O) String (2)
httpBrowserColorDepth displaying images, in bits per pixel.
Example 24
For more information, see https://
en.wikipedia.org/wiki/Color_depth.
billTo_ Indicates the ability of the cardholder browser Enroll (O) String (5)
httpBrowserJavaEnabled to execute Java. The value is returned from the
navigator.javaEnabled property. This field can
contain one of these values:
 true
 false
billTo_ Indicates the ability of the cardholder browser Enroll (O) String (5)
httpBrowserJavaScript to execute JavaScript. This value is available
Enabled from the fingerprint details of the cardholder's
browser. This field can contain one of these
values:
 true
 false

Payer Authentication Using the Simple Order API | October 2019 153
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
billTo_ Indicates the browser language as defined in Enroll (O) String (8)
httpBrowserLanguage IETF BCP47.
Example en-US
For more information, see https://
en.wikipedia.org/wiki/IETF_language_tag.
billTo_ Total height of the cardholder's screen in pixels. Enroll (O) String (6)
httpBrowserScreenHeight
Example 864
billTo_ Total width of the cardholder's screen in pixels. Enroll (O) String (6)
httpBrowserScreenWidth
Example 1536
billTo_httpBrowserTime Time difference between UTC time and the Enroll (O) String (5)
Difference cardholder browser local time, in minutes.
Example 300
billTo_ipAddress Customer’s IP address, such as Enroll (O) String (45)
10.1.27.63, reported by your web server
via socket information.
billTo_lastName Customer’s last name. The value should be the Enroll (R) String (60)
same as the value that appears on the card.
billTo_passportCountry Issuing country for the cardholder’s passport. Enroll (O) Integer (3)
Recommended for Discover ProtectBuy.
billTo_passportNumber The cardholder’s passport number. Enroll (O) String (40)
Recommended for Discover ProtectBuy.
billTo_phoneNumber Telephone number of the customer. Enroll (O) String (15)
For countries other than US or CA, add the
country code at the beginning of the phone
number, if possible. Otherwise, the billing
country is used to determine the country code.
billTo_postalCode Postal code for the billing address. The postal Enroll (R) String (10)
code must consist of 5 to 9 digits.
When the billing country is the U.S., the 9-digit
postal code must follow this format:
[5 digits][dash][4 digits]
Example 12345-6789
When the billing country is Canada, the 6-digit
postal code must follow this format:
[alpha][numeric][alpha][space]
[numeric][alpha][numeric]
Example A1B 2C3
Required only if the billTo_country field is US
or CA.

Payer Authentication Using the Simple Order API | October 2019 154
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
billTo_state State or province of the customer. Required for Enroll (R) String (2)
U.S. and Canada. Use the two-character state,
province, or territory codes.
billTo_street1 First line of the billing street address as it Enroll (R) String (60)
appears on the credit card issuer’s records.
billTo_street2 Additional address information, for example: Enroll (O) String (60)
Attention: Accounts Payable
card_accountNumber Customer’s card number. Enroll (R) Integer (20)
Validate (O)
card_cardType Type of card. For more information, see Credit Enroll (R) String (3)
Card Services Using the Simple Order API
Validate (R)
(PDF | HTML). This field contain one of these
values:
 001: Visa
 002: Mastercard
 003: American Express
 004: Discover
 005: Diners Club
 007: JCB
 024: Maestro (UK Domestic)
 036: Cartes Bancaires
 042: Maestro (International)
card_expirationMonth Expiration month (MM) of the card. Required for Enroll (R) String (2)
the Validate service if card_accountNumber is
Validate (O)
included.
card_expirationYear Expiration year (YYYY) of the card. Required Enroll (R) String (4)
for the Validate service if card_
Validate (O)
accountNumber is included.
item_#_ Passenger's first name. Enroll (O) String (60)
passengerFirstName
See "Numbered Elements," page 150.
item_#_ Passenger's last name. Enroll (O) String (60)
passengerLastName
See "Numbered Elements," page 150.
item_#_ Brief description of item. Enroll (O) String (256)
productDescription
item_#_productName Name of the product. Enroll (O) String (255)
See "Numbered Elements," page 150.
item_#_productSKU Merchant’s product identifier code. Enroll (O) String (255)
See "Numbered Elements," page 150.

Payer Authentication Using the Simple Order API | October 2019 155
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
item_#_quantity Quantity of the product being purchased. The Enroll (O) Non-negative
default value is 1. integer (10)
See "Numbered Elements," page 150.
item_#_shipping Destination to which the item is shipped. Enroll (O) String (50)
DestinationTypes
Example Commercial, residential, store
item_#_unitPrice Per-item price of the product. This value cannot Enroll (R) String (15)
be negative. The amount will be truncated to
Validate (R)
the correct number of decimal places. You can
include a decimal point (.) in this field, but you
cannot include any other special characters.
Note The item_#_unitPrice field is optional if
the purchaseTotals_grandTotalAmount field is
used.
See "Numbered Elements," page 150.

Payer Authentication Using the Simple Order API | October 2019 156
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
merchantDefinedData_ Fields that you can use to store information. Enroll (O) String (255)
mddField_1 The value appears in the Case Management
to Details window in the Business Center. The first
merchantDefinedData_ four fields are the same fields that are used by
mddField_5 the Secure Data services. These fields can only
be used if you are referencing target API 1.75
or higher.
Important These fields override the old
merchant-defined data fields. For example, if
you use the obsolete field
merchantDefinedData_field5 and the new
field merchantDefinedData_mddField_5 in
the same request, the new field value
overwrites the value specified in the obsolete
field.
Warning Merchant-defined data fields are not
intended to and must not be used to capture
personally identifying information. Accordingly,
merchants are prohibited from capturing,
obtaining, and/or transmitting any personally
identifying information in or via the merchant-
defined data fields. Personally identifying
information includes, but is not limited to,
address, credit card number, social security
number, driver's license number, state-issued
identification number, passport number, and
card verification numbers (CVV, CVC2, CVV2,
CID, CVN). In the event CyberSource discovers
that a merchant is capturing and/or transmitting
personally identifying information via the
merchant-defined data fields, whether or not
intentionally, CyberSource will immediately
suspend the merchant's account, which will
result in a rejection of any and all transaction
requests submitted by the merchant after the
point of suspension.
merchantID Your CyberSource merchant ID. Enroll (R) String (30)
Validate (R)
merchantReference Merchant-generated order reference or tracking Enroll (R) String (50)
Code number.
Validate (R)
payerAuthEnrollService_ Number of purchases with this cardholder Enroll (O) Integer (4)
accountPurchases account during the previous six months.
Recommended for Discover ProtectBuy.

Payer Authentication Using the Simple Order API | October 2019 157
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
payerAuthEnrollService_ Issuers should be aware of the acquirer's Enroll (O) String (2)
acquirerCountry country code when the acquirer country differs
from the merchant country, and the acquirer is
in the EEA (European Economic Area).
payerAuthEnrollService_ You can send this override field to set the Enroll (O) Integer (2)
acsWindowSize challenge window size to display to the
cardholder. The Access Control Server (ACS)
replies with content that is formatted
appropriately for this window size to allow for
the best user experience. The sizes are width x
height in pixels of the window displayed in the
cardholder browser.
Possible values:
 01: 250x400
 02: 390x400
 03: 500x600
 04: 600x400
 05: Full page
payerAuthEnrollService_ Number of add card attempts in the last 24 Enroll (O) Integer (3)
addCardAttempts hours.
Recommended for Discover ProtectBuy.
payerAuthEnrollService_ Data that documents and supports a specific Enroll (O) String (2048)
alternateAuthentication authentication process.
Data
payerAuthEnrollService_ Date and time in UTC of the cardholder Enroll (O) Integer (12)
alternateAuthentication authentication.
Date
Format:
YYYYMMDDHHMM
payerAuthEnrollService_ Mechanism used by the cardholder to Enroll (O) Integer (2)
alternateAuthentication authenticate to the 3D Secure requestor.
Method
Possible values:
 01: No authentication occurred
 02: Login using merchant system
credentials
 03: Login using Federated ID
 04: Login using issuer credentials
 05: Login using third-party authenticator
 06: Login using FIDO Authenticator

Payer Authentication Using the Simple Order API | October 2019 158
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
payerAuthEnrollService_ Indicates the type of authentication request. Enroll (O) Integer (2)
authenticationIndicator
Possible values:
 01: Payment transaction
 02: Recurring transaction
 03: Installment transaction
 04: Add card
 05: Maintain card
 06: Cardholder verification as part of EMV
token ID&V (identity and verification)
payerAuthEnrollService_ Payer authentication transaction identifier Enroll (O) String (20)
authentication passed to link the check enrollment and
TransactionID validate authentication messages.
Note Required for Standard integration.
payerAuthEnrollService_ Possible values: Enroll (O) String (2)
challengeCode
 01: No preference
 02: No challenge request
 03: Challenge requested (3D Secure
requestor preference)
 04: Challenge requested (mandate)
 05: No challenge requested (transactional
risk analysis is already performed)
 06: No challenge requested (Data share
only)
 07: No challenge requested (strong
consumer authentication is already
performed)
 08: No challenge requested (utilize whitelist
exemption if no challenge required)
 09: Challenge requested (whitelist prompt
requested if challenge required)
Note This field will default to 01 on merchant
configuration and can be overridden by the
merchant. EMV 3D Secure version 2.1.0
supports values 01-04. Version 2.2.0 supports
values 01-09.
payerAuthEnrollService_ An alias that uniquely identifies the customer's Enroll (O) String (128)
customerCCAlias account and credit card on file.
Note This field is required if Tokenization is
enabled in the merchant profile settings.

Payer Authentication Using the Simple Order API | October 2019 159
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
payerAuthEnrollService_ Indicates that the card being used is the one Enroll (O) String (5)
defaultCard designated as the primary payment card for
purchase. This field can contain one of these
values:
 true
 false
Recommended for Discover ProtectBuy.
payerAuthEnrollService_ Indicates the channel used for the transaction. Enroll (O) String (10)
deviceChannel
Note Required for SDK integration.
Possible Values:
 SDK
 Browser
 3RI (3D Secure Integrator Request)
Note If you use the SDK integration, this field
is dynamically set to SDK. If you use the
JavaScript code, this field is dynamically set to
Browser. For merchant-initiated or 3RI
transactions, you must set the field to 3RI. If
you use this field in addition to JavaScript code,
you must set the field to Browser.
payerAuthEnrollService_ Indicates whether the merchant experienced Enroll (O) String (2)
fraudActivity suspicious activity (including previous fraud) on
the account. This field can contain one of these
values:
 01: No suspicious activity
 02: Suspicious activity observed
Recommended for Discover ProtectBuy.
payerAuthEnrollService_ The purchase amount total for prepaid gift Enroll (O) Integer (15)
giftCardAmount cards in major units
Example:
123.45 USD= 123
payerAuthEnrollService_ Total count of individual prepaid gift cards Enroll (O) Integer (2)
giftCardCount purchased.
payerAuthEnrollService_ Currency used for the gift card purchase. Use Enroll (O) Integer (3)
giftCardCurrency the standard ISO codes located in the Support
Center.

Payer Authentication Using the Simple Order API | October 2019 160
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
payerAuthEnrollService_ Value of the Accept header sent by the Enroll (O) String (255)
httpAccept customer’s web browser.
Note If the customer’s browser provides a
value, you must include it in your request.
payerAuthEnrollService_ The exact content of the HTTP accept header. Enroll (O) String (256)
httpUserAccept
payerAuthEnrollService_ Value of the User-Agent header sent by the Enroll (O) String (255)
httpUserAgent customer’s web browser.
Note If the customer’s browser provides a
value, you must include it in your request.
payerAuthEnrollService_ An integer value greater than 1 indicating the Enroll (O) Integer (4)
installmentTotalCount maximum number of permitted authorizations
for installment payments.
Note This value is required if the merchant
and cardholder have agreed to installment
payments.
payerAuthEnrollService_ Indicates whether the customer has opted in for Enroll (O) String (5)
marketingOptIn marketing offers. This field can contain one of
these values:
 true
 false
Recommended for Discover ProtectBuy.
payerAuthEnrollService_ Indicates origin of the marketing offer. Enroll (O) String (40)
marketingSource
Recommended for Discover ProtectBuy.
payerAuthEnrollService_ Merchant category code. Enroll (O) Integer (4)
MCC
Important Required only for Visa Secure
transactions in Brazil. Do not use this request
field for any other types of transactions.
payerAuthEnrollService_ Calculated by merchants according to Payment Enroll (O) Integer (2)
merchantFraudRate Service Directive 2 (PSD2) and Regulatory
Technical Standards (RTS). European
Economic Area (EEA) card fraud divided by all
EEA card volumes.
Possible Values:
 1: Represents fraud rate <=1
 2::Represents fraud rate >1 and <=6
 3: Represents fraud rate >6 and <=13
 4: Represents fraud rate >13 and <=25
 5: Represents fraud rate >25

Payer Authentication Using the Simple Order API | October 2019 161
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
payerAuthEnrollService_ Your company’s name as you want it to appear Enroll (O) String (25)
merchantName to the customer in the issuing bank’s
authentication form. This value overrides the
value specified by your merchant bank.
Required for Visa Secure travel.
payerAuthEnrollService_ Indicates whether the consumer is a new or Enroll (O) String (5)/
merchantNewCustomer existing customer with the merchant.
This field can contain one of these values:
 true
 false
payerAuthEnrollService_ Risk score provided by merchants. Used for Enroll (O) String (20)
merchantScore Cartes Bancaires transactions.
payerAuthEnrollService_ Address of your company’s web site, for Enroll (O) String (100)
merchantURL example, http://www.example.com.
This value overrides the value specified by your
merchant bank.
payerAuthEnrollService_ Category of the message for a specific use Enroll (O) String (2)
messageCategory case.
Possible values:
 01: PA (payment authentication)
 02: NPA (non-payment authentication)
 03-79: Reserved for EMVCo future use
(values invalid until defined by EMVCo)
 80-99: Reserved for DS (directory server)
use
payerAuthEnrollService_ Cardholder’s mobile phone number. Enroll (R) Integer (25)
mobilePhone
Used for Visa Secure transactions in Brazil.
payerAuthEnrollService_ Non-Payer Authentication Indicator. Enroll (O) Integer (2)
npaCode
Possible values:
 01: Add card
 02: Maintain card information
 03: Cardholder verification for EMV token
 04-80: Reserved for EMVCo
 80-90: Reserved for directory server

Payer Authentication Using the Simple Order API | October 2019 162
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
payerAuthEnrollService_ Specifies the Brazilian payment account type Enroll (O) String (10)
overridePaymentMethod used for the transaction. This field overrides
other payment types that might be specified in
the request.
Use one of the following values for this field:
 NA: Not applicable. Do not override other
payment types that are specified in the
request.
 CR: Credit card
 DB: Debit card
 VSAVR: Visa Vale Refeicao
 VSAVA: Visa Vale Alimentacao
Important Required only for Visa Secure
transactions in Brazil. Do not use this request
field for any other types of transactions.
payerAuthEnrollService_ Date the payment account was added to the Enroll (O) Integer (8)
paymentAccountDate cardholder account.
This field can contain one of these values:
 -1: Guest account
 0: Added during this transaction
If neither applies, enter the date in YYYYMMDD
format.
Recommended for Discover ProtectBuy.
payerAuthEnrollService_ Indicates whether cardholder is placing an Enroll (O) String (2)
preorder order with a future availability or release date.
This field can contain one of these values:
 01: Merchandise available
 02: Future availability
payerAuthEnrollService_ Expected date that a pre-ordered purchase will Enroll (O) Integer (8)
preorderDate be available.
Format:
YYYYMMDD
payerAuthEnrollService_ This field contains data that the ACS can use to Enroll (O) String (2048)
priorAuthenticationData verify the authentication process.

Payer Authentication Using the Simple Order API | October 2019 163
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
payerAuthEnrollService_ Method the cardholder used previously to Enroll (O) Integer (2)
priorAuthenticationMethod authenticate to the 3D Secure requestor.
Possible values:
 01: Frictionless authentication occurred by
ACS
 02: Cardholder challenge occurred by ACS
 03: AVS verified
 04: Other issuer methods
 05-79: Reserved for EMVCo future use
(values invalid until defined by EMVCo)
 80-99: Reserved for directory server use
payerAuthEnrollService_ This field contains the ACS transaction ID for a Enroll (O) String (36)
priorAuthentication prior authenticated transaction. For example,
ReferenceID the first recurring transaction that was
authenticated with the cardholder.
payerAuthEnrollService_ Date and time in UTC of the prior cardholder Enroll (O) Integer (12)
priorAuthenticationTime authentication.
Format:
YYYYMMDDHHMM

Payer Authentication Using the Simple Order API | October 2019 164
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
payerAuthEnrollService_ Specifies the product code, which designates Enroll (O) String (3)
productCode the type of transaction. Specify one of the
following values for this field:
 AIR: Airline purchase
Important Required for American Express
SafeKey (U.S.).
 ACC: Accommodation Rental
 ACF: Account funding
 CHA: Check acceptance
 DIG: Digital Goods
 DSP: Cash Dispensing
 GAS: Fuel
 GEN: General Retail
 LUX: Luxury Retail
 PAL: Prepaid activation and load
 PHY: Goods or services purchase
 QCT: Quasi-cash transaction
 REN: Car Rental
 RES: Restaurant
 SVC: Services
 TBD: Other
 TRA: Travel
Important Required for Visa Secure
transactions in Brazil. Do not use this request
field for any other types of transactions.
payerAuthEnrollService_ The date after which no further recurring Enroll (O) Integer (8)
recurringEndDate authorizations should be performed. Format:
YYYYMMDD.
Note This field is required for recurring
transactions.

Payer Authentication Using the Simple Order API | October 2019 165
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
payerAuthEnrollService_ Integer value indicating the minimum number of Enroll (O) Integer (3)
recurringFrequency days between recurring authorizations. A
frequency of monthly is indicated by the value
28. Multiple of 28 days will be used to indicate
months.
Example:
6 months= 168
Note This field is required for recurring
transactions.
payerAuthEnrollService_ Date of original purchase. Required for Enroll (O) String (17)
recurringOriginalPurchase recurring transactions.
Date
Format:
YYYYMMDDHHMMSS
Note If this field is empty, the current date is
used.
payerAuthEnrollService_ Reference ID that corresponds to the device Enroll (R) String (50)
referenceID fingerprinting data that was collected
previously.
Note Required for Hybrid integration.
payerAuthEnrollService_ Indicates the type of 3RI request (3D Secure Enroll (O) Integer (2)
requestorInitiated Integrator Request).
AuthenticationIndicator
Possible Values:
 01: Recurring transaction
 02: Installment transaction
 03: Add card
 04: Maintain card
 05: Account verification
 06: Split/delayed shipment
 07: Top-up
 08: Mail Order
 09: Telephone Order
 10: Whitelist status check
 11: Other payment

Payer Authentication Using the Simple Order API | October 2019 166
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
payerAuthEnrollService_ Indicates whether the cardholder is reordering Enroll (O) String (2)
reorder previously purchased merchandise.
This field can contain one of these values:
 01: First time ordered
 02: Reordered
payerAuthEnrollService_ Whether to include payerAuthEnrollService in Enroll (R) String (5)
run your request. The field has one of these values:
 true: Include the service in your request.
 false (default): Do not include the service
in your request.
payerAuthEnrollService_ This field indicates the maximum amount of Enroll (O) String (1)
sdkMaxTimeout time for all 3D Secure 2.x messages to be
communicated between all components (in
minutes).
Possible Values:
 Greater than or equal to 05 (05 is the
minimum timeout to set)
 Default is set to 15
Note This field is a required for 3D Secure 2.x.
If you do not send a value in this field, it defaults
to 15.
payerAuthEnrollService_ Indicates that dedicated payment processes Enroll (O) String (1)
secureCorporatePayment and procedures were used. Potential secure
Indicator corporate payment exemption applies.
Possible Values:
 0
 1
payerAuthEnrollService_ Date when the shipping address for this Enroll (O) Integer (8)
shipAddressUsageDate transaction was first used.
This field can contain one of these values:
 -1: Guest account
 0: First used during this transaction
If neither applies, enter the date in YYYYMMDD
format.
Recommended for Discover ProtectBuy.
payerAuthEnrollService_ Total number of articles or items in the order as Enroll (O) Integer (2)
totalOffersCount a numeric decimal count.
Possible values: 00-99

Payer Authentication Using the Simple Order API | October 2019 167
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
payerAuthEnrollService_ Number of transaction (successful or Enroll (O) Integer (3)
transactionCountDay abandoned) for this cardholder account within
the last 24 hours.
Recommended for Discover ProtectBuy.
payerAuthEnrollService_ Number of transactions (successful and Enroll (O) Integer (3)
transactionCountYear abandoned) for this cardholder account within
the last year.
Recommended for Discover ProtectBuy.
payerAuthEnrollService_ Transaction mode identifier. Identifies the Enroll (R) String (1)
transactionMode channel from which the transaction originates.
Possible values:
 M: MOTO (Mail Order Telephone Order)
 R: Retail
 S: eCommerce
 P: Mobile Device
 T: Tablet
payerAuthEnrollService_ Enables the communication of trusted Enroll (O) String (1)
whiteListStatus beneficiary and whitelist status among the
ACS, the directory server, and the 3D Secure
requestor.
Possible Values:
 Y: 3D Secure requestor is whitelisted by
cardholder
 N: 3D Secure requestor is not whitelisted by
cardholder
payerAuthValidateService Payer authentication transaction identifier Validate (O) String (20)
_authentication passed to link the check enrollment and
TransactionID validate authentication messages.
Note Required for Hybrid integration.
payerAuthValidate Payer authentication result (PARes) message Validate (O) String (no limit,
Service_signedPARes returned by the card-issuing bank. If you need may be very
to show proof of enrollment checking, you may large)
need to decrypt and parse the string for the
information required by the payment card
company. For more information, see "Storing
Payer Authentication Data," page 207.
Note The field is in Base64. You must remove
all carriage returns and line feeds before adding
the PARes to the request.

Payer Authentication Using the Simple Order API | October 2019 168
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
payerAuthValidate Whether to include payerAuthValidateService Validate (R) String (5)
Service_run in your request. The field can contain one of
these values:
 true: Include the service in your request.
 false (default): Do not include the service
in your request.
purchaseTotals_currency Currency used for the order. Use the standard Enroll (R) String (5)
ISO codes located in the Support Center.
Validate (R)
purchaseTotals_ Grand total for the order. In your request, you Enroll (R) String (15)
grandTotalAmount must include either this field or item_#_
Validate (R)
unitPrice. For more information, see Credit
Card Services Using the Simple Order API
(PDF | HTML).
Note The purchaseTotals_
grandTotalAmount field is optional if you use
the item_#_unitPrice field.
shipTo_city City of the shipping address. Enroll (O) String (50)

Required if any shipping address information is

included.
Required for American Express SafeKey (U.S.).
shipTo_country Country of the shipping address. Use the two- Enroll (O) String (2)
character ISO Standard Country Codes.
Required for American Express SafeKey (U.S.).
shipTo_destinationCode Indicates destination chosen for the Enroll (O) Integer (2)
transaction.
Possible values:
 01: Ship to cardholder billing address
 02: Ship to another verified address on file
with merchant
 03: Ship to address that is different than
billing address
 04: Ship to store (store address should be
populated on request)
 05: Digital goods
 06: Travel and event tickets, not shipped
 07: Other
shipTo_destinationTypes Shipping destination. Enroll (O) String (25)
Example Commercial, residential, store

Payer Authentication Using the Simple Order API | October 2019 169
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
shipTo_firstName First name of the recipient. Enroll (O) String (60)

shipTo_lastName Last name of the recipient. Enroll (O) String (60)

shipTo_phoneNumber Phone number for the shipping address. Enroll (O) String (15)
For information on formatting, see billTo_
phoneNumber.
shipTo_postalCode Postal code for the shipping address. The Enroll (O) String (10)
postal code must consist of 5 to 9 digits.
When the shipping country is the U.S., the 9-
digit postal code must follow this format:
[5 digits][dash][4 digits]
Example 12345-6789
When the shipping country is Canada, the 6-
digit postal code must follow this format:
[alpha][numeric][alpha][space]
[numeric][alpha][numeric]
Example A1B 2C3
Required if the shipTo_country field value is
US or CA.
Required for American Express SafeKey (U.S.).
shipTo_shippingMethod Shipping method for the product. Possible Enroll (O) String (10)
values:
 lowcost: Lowest-cost service
 sameday: Courier or same-day service
 oneday: Next-day or overnight service
 twoday: Two-day service
 threeday: Three-day service
 pickup: Store pick-up
 other: Other shipping method
 none: No shipping method because
product is a service or subscription
Required for American Express SafeKey (U.S.).
shipTo_state State or province of the shipping address. Use Enroll (O) String (2)
the State, Province, and Territory Codes for the
United States and Canada.
Required if shipTo_country value is CA or US.
Required for American Express SafeKey (U.S.).

Payer Authentication Using the Simple Order API | October 2019 170
Appendix A API Fields

Table 17 Request Fields (Continued)

Field Name Description Required/ Type &

Optional Length
shipTo_street1 First line of the shipping address. Enroll (O) String (60)
Required if any shipping address information is
included.
Required for American Express SafeKey (U.S.).
shipTo_street2 Second line of the shipping address. Enroll (O) String (60)
Required for American Express SafeKey (U.S.).

Payer Authentication Using the Simple Order API | October 2019 171
Appendix A API Fields

Reply Fields
Table 18 Reply Fields

Field Name Description Returned By Type &

Length
card_bin Six-digit card issuer bank identification number. Enroll String (6)
Validate
card_cardTypeName The card brand name associated with the Enroll String
cardholder’s card number. (25)
Validate
decision Summarizes the result of the overall request. Enroll String
The field can contain one of these values: (255)
Validate
 ACCEPT
 ERROR
 REJECT
invalidField_0 through Fields in the request that contained invalid Enroll String
invalidField_N data. (255)
Validate
merchantReferenceCode Your order reference or tracking number. Enroll String
(255)
Validate
missingField_0 through Required fields that were missing from the Enroll String
missingField_N request. (255)
Validate

Payer Authentication Using the Simple Order API | October 2019 172
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthEnrollReply_ Identifies the UI type that the ACS will use to Enroll String
acsRenderingType complete the challenge. (see
descrip-
Note Available only for mobile application
tion)
transactions using the Cardinal Mobile SDK.
This field is a JSON object that comprises the
following two fields, each 2 characters in
length.
 ACS Interface
Field Name: acsInterface
This is the ACS interface the challenge
presents to the cardholder.
Possible values:
 01: Native UI
 02: HTML UI
 ACS UI Template
Field Name: acsUiTemplate
Identifies the UI template format that the
ACS first presents to the consumer.
Possible values:
 01: Text
 02: Single select
 03: Multi select
 04: OOB (Out of Band)
 05: HTML other
Valid values for each interface:
 Native UI: 01-04
 HTML UI: 01-05
HTML other is valid only when combined with
HTML UI. If used with Native UI, it results in
error=203.
JSON Object Example:
{
"acsRenderingType":{
"acsInterface";"02",
"acsUiTemplate":03" }
}
payerAuthEnrollReply_ Unique transaction identifier assigned by the Enroll String
acsTransactionID ACS to identify a single transaction. (36)

Payer Authentication Using the Simple Order API | October 2019 173
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthEnrollReply_ URL for the card-issuing bank’s authentication Enroll String
acsURL form that you receive when the card is enrolled. (no
The field length can be very large. length
limit)
payerAuthEnrollReply_ Indicates what displays to the customer during Enroll String
authenticationPath the authentication process. This field can (255)
contain one of these values:
 ADS: (Card not enrolled) customer prompted
to activate the card during the checkout
process.
 ATTEMPTS: (Attempts processing)
Processing... briefly displays before the
checkout process is completed.
 ENROLLED: (Card enrolled) the card
issuer’s authentication window displays.
 UNKNOWN: Card enrollment status cannot
be determined.
 NOREDIRECT: (Card not enrolled,
authentication unavailable, or error
occurred) nothing displays to the customer.
The following values can be returned if you are
using rules-based payer authentication. See
"Rules-Based Payer Authentication," page 224:
 RIBA: The card-issuing bank supports risk-
based authentication, but whether the
cardholder is likely to be challenged cannot
be determined.
 RIBA_PASS: The card-issuing bank
supports risk-based authentication and it is
likely that the cardholder will not be
challenged to provide credentials, also
known as silent authentication.

Payer Authentication Using the Simple Order API | October 2019 174
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthEnrollReply_ Raw authentication data that comes from the Enroll String w/
authenticationResult card-issuing bank. Primary authentication field numbers
that indicates if authentication was successful only
and if liability shift occurred. You should (255)
examine first the result of this field. This field
contains one of these values:
 -1: Invalid PARes.
 0: Successful validation.
 1: Cardholder is not participating, but the
attempt to authenticate was recorded.
 6: Issuer unable to perform authentication.
 9: Cardholder did not complete
authentication.
payerAuthEnrollReply_ Message that explains the content of Enroll String
authenticationStatus payerAuthEnrollReply_ (255)
Message authenticationResult.
payerAuthEnrollReply_ Provides additional information about the Enroll Integer
authenticationStatus PARes status value. (2)
Reason
payerAuthEnrollReply_ Payer authentication transaction identifier Enroll String
authentication passed to link the check enrollment and (20)
TransactionID validate authentication messages.
payerAuthEnrollReply_ Indicates the type of authentication that is used Enroll Integer
authenticationType to challenge the card holder. (2)
Possible Values:
 01: Static
 02: Dynamic
 03: OOB (Out of Band)
Note EMV 3D Secure version 2.1.0 supports
values 01-03. Version 2.2.0 supports values
01-03.
payerAuthEnrollReply_ The Base64-encoded JSON Payload of Cartes Enroll String
authorizationPayload Bancaires Authorization Values returned in the (255)
challenge flow.
payerAuthEnrollReply_ Text provided by the AC or issuer or both to the Enroll String
cardholderMessage cardholder during a frictionless or decoupled (128)
transaction. The issuer can provide information
to the cardholder. For example, “Additional
authentication is needed for this transaction.
Please contact (Issuer Name) at xxx-xxx-
xxxx.”. The issuing bank can choose to support
this value.

Payer Authentication Using the Simple Order API | October 2019 175
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthEnrollReply_ Unique identifier generated by the card-issuing Enroll String
cavv bank after the customer is authenticated. The (255)
value is in Base64. When you request the card
authorization service, CyberSource
automatically converts the value, not the field
name, to the format required by your payment
processor.
Note This field is generated only for Visa
Secure, American Express SafeKey, JCB,
Diners Club, and Discover transactions.
payerAuthEnrollReply_ Field returned when payerAuthEnrollReply_ Enroll Integer
cavvAlgorithm paresStatus contains the values Y (successful (1)
authentication) or A (attempted authentication).
This field contains one of these values:
 2: Visa, American Express, JCB, Diners
Club, and Discover
 3: Mastercard and Maestro
Note This field only applies if you use the Atos
processor. If you use Atos, send the value of
this field in the ccAuthService_
cavvAlgorithm request field of the
authorization service.
payerAuthEnrollReply_ Indicates why the transaction was canceled. Enroll Integer
challengeCancelCode (2)
Possible Values:
 01: Cardholder selected Cancel
 02: Reserved for future EMVCo use (values
invalid until defined by EMVCo).
 03: Transaction timed out—Decoupled
Authentication
 04: Transaction timed out at ACS—other
timeouts
 05: Transaction timed out at ACS—First
CReq not received by ACS
 06: Transaction Error
 07: Unknown
 08: Transaction timed out at SDK

Payer Authentication Using the Simple Order API | October 2019 176
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthEnrollReply_ Indicates whether a challenge is required in Enroll String (1)
challengeRequired order to complete authentication.
Note Regional mandates might determine
that a challenge is required.
Possible values:
 Y: Challenge required
 N: Challenge not required
Note Used by the Hybrid integration.
payerAuthEnrollReply_ Commerce indicator for cards not enrolled. This Enroll String
commerceIndicator field contains one of these values: (255)
 internet: Card not enrolled, or card type
not supported by payer authentication. No
liability shift.
 js_attempted: JCB card not enrolled,
but attempt to authenticate is recorded.
Liability shift.
 js_failure: You receive this result if
JCB’s directory service is not available. No
liability shift.
 spa: Mastercard card not enrolled. No
liability shift.
 vbv_attempted: Visa card not enrolled,
but attempt to authenticate is recorded.
Liability shift.
 vbv_failure: For the payment processors
Barclays, Streamline, AIBMS, or FDC
Germany, you receive this result if Visa’s
directory service is not available. No liability
shift.
payerAuthEnrollReply_ The directory server error code indicating a Enroll Integer
directoryServerErrorCode problem with the transaction. (3)
payerAuthEnrollReply_ Directory server text and additional detail about Enroll String
directoryServerError the error for the transaction. (4096)
Description
payerAuthEnrollReply_ The directory server transaction ID is Enroll String
directoryServer generated by the directory server during (36)
TransactionID authentication and returned with the
authentication results. Your card brand might
require you to send this field in the
authorization service request.

Payer Authentication Using the Simple Order API | October 2019 177
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthEnrollReply_eci Note This field applies only to non U.S-issued Enroll String
cards. (255)

Numeric electronic commerce indicator (ECI)

returned only for Visa, American Express, JCB,
Diners Club, and Discover transactions when
the card is not enrolled.
If you are not using the CyberSource payment
services, you must send this value to your
payment processor in the subsequent request
for card authorization. This field contains one of
these values:
 06: The card can be enrolled. Liability shift.
 07: The card cannot be enrolled. No liability
shift.
payerAuthEnrollReply_ ECI value that can be returned for Visa, Enroll String
eciRaw Mastercard, American Express, JCB, Diners (255)
Club, and Discover. The field is absent when
authentication fails. If your payment processor
is Streamline, you must pass the value of this
field instead the value of
payerAuthEnrollReply_eci or
payerAuthEnrollReply_
ucafCollectionIndicator.
This field can contain one of these values:
 01: Authentication attempted (Mastercard)
 02: Successful authentication (Mastercard)
 05: Successful authentication (Visa,
American Express, JCB, Diners Club, and
Discover)
 06: Authentication attempted (Visa,
American Express, JCB, Diners Club, and
Discover)
payerAuthEnrollReply_ The type of 3D Secure transaction flow that Enroll String (2)
effectiveAuthentication occurred. It can be one of the following:
Type
 CH: Challenge
 FR: Frictionless
 FD: Frictionless with delegation, (challenge
not generated by the issuer but by the
scheme on behalf of the issuer).
payerAuthEnrollReply_ Indicates whether a valid Interactive Voice Enroll String (5)
ivrEnabledMessage Response (IVR) transaction was detected.

Payer Authentication Using the Simple Order API | October 2019 178
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthEnrollReply_ Encryption key to be used in the event the ACS Enroll String
ivrEncryptionKey requires encryption of the credential field. (16)
payerAuthEnrollReply_ Indicates whether the ACS requires the Enroll String (5)
ivrEncryptionMandatory credential to be encrypted.
payerAuthEnrollReply_ An indicator from the ACS to inform the type of Enroll String
ivrEncryptionType encryption that should be used in the event the (20)
ACS requires encryption of the credential field.
payerAuthEnrollReply_ An ACS-provided label that can be presented Enroll String
ivrLabel to the cardholder. Recommended use with an (20)
application.
payerAuthEnrollReply_ An ACS-provided string that can be presented Enroll String
ivrPrompt to the cardholder. Recommended use with an (80)
application.
payerAuthEnrollReply_ An ACS-provided message that can provide Enroll String
ivrStatusMessage additional information. (80)
payerAuthEnrollReply_ The global score calculated by the Cartes Enroll Integer
networkScore Bancaires scoring platform and returned to the (2)
merchant.
payerAuthEnrollReply_ Payer authentication request (PAReq) Enroll String
paReq message that you need to forward to the ACS. (No
The field length can be very large. The value is length
in Base64. limit)
payerAuthEnrollReply_ Raw result of the authentication check. This Enroll String
paresStatus field can contain one of these values: (255)
 A: Proof of authentication attempt was
generated.
 B: Bypassed authentication.
 N: Customer failed or canceled
authentication. Transaction denied.
 R: Authentication rejected (used for 3D
Secure 2.x transactions only)
 U: Authentication not completed regardless
of the reason.
 Y: Customer was successfully authenticated.
Note This field only applies to the Asia, Middle
East, and Africa Gateway. If you are configured
for this processor, you must send the value of
this field in your authorization request.

Payer Authentication Using the Simple Order API | October 2019 179
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthEnrollReply_ Date and time of the enrollment check Enroll String
proofXML combined with the VEReq and VERes (no
elements. If you ever need to show proof of length
enrollment checking, you will need to parse the limit)
string for the information required by the
payment card company. For more information,
see "Storing Payer Authentication Data,"
page 207. The value can be very large.
 For cards issued in the U.S. or Canada, Visa
may require this data for specific merchant
category codes.
 For cards not issued in the U.S. or Canada,
your bank may require this data as proof of
enrollment checking for any payer
authentication transaction that you re-
present because of a chargeback.
payerAuthEnrollReply_ Encrypted version of the card number used in Enroll String
proxyPAN the payer authentication request message. (255)
payerAuthEnrollReply_ Numeric value corresponding to the result of Enroll Integer
reasonCode the Enrollment Check service request. For a list (5)
of possible values, see Appendix B, "Reason
Codes," on page 191.
payerAuthEnrollReply_ SDK unique transaction identifier that is Enroll String
sdkTransactionID generated on each new transaction. (36)
payerAuthEnrollReply_ This field contains the 3D Secure version that Enroll String
specificationVersion was used to process the transaction. For (20)
example, 1.0.2 or 2.0.0.
payerAuthEnrollReply_ The fully qualified URL that the merchant uses Enroll String
stepUpUrl to post a form to the cardholder in order to (2048)
complete the Consumer Authentication
transaction for the Cardinal Cruise Direct
Connection API integration.
Note Used by the Cardinal Cruise Direct
Connection API integration.
payerAuthEnrollReply_ Unique transaction identifier assigned by the Enroll String
threeDSServer 3D Secure Server to identify a single (36)
TransactionID transaction.
payerAuthEnrollReply_ AAV is a unique identifier generated by the Enroll String
ucafAuthenticationData card-issuing bank after the customer is (255)
authenticated. The value is in Base64. Include
the data in the card authorization request.
Note This field is returned for only Mastercard
Identity Check transactions.

Payer Authentication Using the Simple Order API | October 2019 180
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthEnrollReply_ Indicates that authentication is not required Enroll String
ucafCollectionIndicator because the customer is not enrolled. Add the (255)
value of this field to the authorization field
ucaf_collectionIndicator. This field can
contain these values: 0, 1.
Note This field is returned for only Mastercard
Identity Check transactions.
payerAuthEnrollReply_ Result of the enrollment check. This field can Enroll String
veresEnrolled contain one of these values: (255)
 Y: Card enrolled; you must authenticate.
Liability shift.
 N: Card not enrolled; proceed with
authorization. Liability shift.
 U: Unable to authenticate regardless of the
reason. No liability shift.
Note This field only applies to the Asia, Middle
East, and Africa Gateway. If you are configured
for this processor, you must send the value of
this field in your authorization request.
The following value can be returned if you are
using rules-based Payer Authentication. See
"Rules-Based Payer Authentication," page 224:
 B: Indicates that authentication was
bypassed.
payerAuthEnrollReply_ Enables the communication of trusted Enroll String (1)
whiteListStatus beneficiary and whitelist status among the
ACS, the directory server, and the 3D Secure
requestor.
Possible Values:
 Y: 3D Secure requestor is whitelisted by
cardholder
 N: 3D Secure requestor is not whitelisted by
cardholder
payerAuthEnrollReply_ This field is populated by the system setting Enroll Integer
whiteListStatusSource Whitelist Status. (2)
Possible Values:
 01: 3D Secure Server
 02: Directory server
 03: ACS

Payer Authentication Using the Simple Order API | October 2019 181
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthEnrollReply_xid Transaction identifier generated by Enroll String
CyberSource for successful enrollment checks. (255)
Use this value to match an outgoing PAReq
with an incoming PARes. If your payment
processor is Barclays, CyberSource forwards
the XID with your card authorization service
request. The value is in Base64.

Payer Authentication Using the Simple Order API | October 2019 182
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthValidateReply_ Identifies the UI type that the ACS will use to String
acsRenderingType complete the challenge. (see
descrip-
Note Available only for mobile application
tion)
transactions using the Cardinal Mobile SDK.
This field is a JSON object that comprises the
following two fields, each 2 characters in
length.
 ACS Interface
Field Name: acsInterface
This is the ACS interface the challenge
presents to the cardholder.
Possible values:
 01: Native UI
 02: HTML UI
 ACS UI Template
Field Name: acsUiTemplate
Identifies the UI template format that the
ACS first presents to the consumer.
Possible values:
 01: Text
 02: Single select
 03: Multi select
 04: OOB (Out of Band)
 05: HTML other
Valid values for each interface:
 Native UI: 01-04
 HTML UI: 01-05
HTML other is valid only when combined with
HTML UI. If used with Native UI, it results in
error=203.
JSON Object Example:
{
"acsRenderingType":{
"acsInterface";"02",
"acsUiTemplate":03" }
}
payerAuthValidateReply_ Unique transaction identifier assigned by the String
acsTransactionID ACS to identify a single transaction. (36)

Payer Authentication Using the Simple Order API | October 2019 183
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthValidateReply_ Raw authentication data that comes from the Validate String w/
authenticationResult card-issuing bank. Primary authentication field numbers
that indicates if authentication was successful only
and if liability shift occurred. You should (255)
examine first the result of this field. This field
contains one of these values:
 -1: Invalid PARes.
 0: Successful validation.
 1: Cardholder is not participating, but the
attempt to authenticate was recorded.
 6: Issuer unable to perform authentication.
 9: Cardholder did not complete
authentication.
payerAuthValidateReply_ Message that explains the content of Validate String
authenticationStatus payerAuthValidateReply_ (255)
Message authenticationResult.
payerAuthValidateReply_ Provides additional information about the Validate Integer
authenticationStatus PARes status value. (2)
Reason
payerAuthValidateReply_ Indicates the type of authentication that is used Validate Integer
authenticationType to challenge the card holder. (2)
Possible Values:
 01: Static
 02: Dynamic
 03: OOB (Out of Band)
Note EMV 3D Secure version 2.1.0 supports
values 01-03. Version 2.2.0 supports values
01-03.
payerAuthValidateReply_ The Base64-encoded JSON Payload of Cartes Validate String
authorizationPayload Bancaires Authorization Values returned in the (255)
challenge flow.
payerAuthValidateReply_ Unique identifier generated by the card-issuing Validate String
cavv bank after the customer is authenticated. The (255)
value is in Base64. When you request the card
authorization service, CyberSource
automatically converts the value, not the field
name, to the format required by your payment
processor.
Note This field is generated only for Visa
Secure, American Express SafeKey, JCB,
Diners Club, and Discover transactions.

Payer Authentication Using the Simple Order API | October 2019 184
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthValidateReply_ Field returned when Validate Integer
cavvAlgorithm payerAuthValidateReply_paresStatus (1)
contains the values Y (successful
authentication) or A (attempted authentication).
This field contains one of these values:
 2: Visa, American Express, JCB, Diners
Club, and Discover
 3: Mastercard and Maestro
Note This field only applies if you use the Atos
processor. If you use Atos, send the value of
this field in the ccAuthService_
cavvAlgorithm request field of the
authorization service.
payerAuthValidateReply_ Indicates why the transaction was canceled. Validate Integer
challengeCancelCode (2)
Possible Values:
 01: Cardholder selected Cancel
 02: Reserved for future EMVCo use (values
invalid until defined by EMVCo).
 03: Transaction timed out—Decoupled
Authentication
 04: Transaction timed out at ACS—other
timeouts
 05: Transaction timed out at ACS—First
CReq not received by ACS
 06: Transaction Error
 07: Unknown
 08: Transaction timed out at SDK

Payer Authentication Using the Simple Order API | October 2019 185
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthValidateReply_ Indicator used to differentiate different types of Validate String
commerceIndicator transactions. The authentication failed if this (255)
field is not returned. The value of this field is
passed automatically to the authorization
service if you request the services together.
This field contains one of these values:
 aesk: American Express SafeKey
authentication verified successfully.
 aesk_attempted: Card not enrolled in
American Express SafeKey, but the attempt
to authenticate was recorded.
 dipb: Discover ProtectBuy authentication
verified successfully.
 dipb_attempted: Card not enrolled in
Discover ProtectBuy, but the attempt to
authenticate was recorded.
 internet: Authentication failed.
 js: J/Secure authentication verified
successfully.
 js_attempted: Card not enrolled in J/
Secure, but the attempt to authenticate was
recorded.
 moto: Mail or telephone order.
 pb_attempted: Card not enrolled in
Diners Club ProtectBuy, but the attempt to
authenticate was recorded.
 recurring: Recurring transaction.
 spa: Mastercard Identity Check
authentication verified successfully.
 spa_failure: Mastercard Identity Check
failed authentication.
 vbv: Visa Secure authentication verified
successfully.
 vbv_attempted: Card not enrolled in
Visa Secure, but the attempt to authenticate
was recorded.
 vbv_failure: Visa Secure authentication
unavailable.
Note For Visa, if the payment processor is
Streamline, Barclays, AIBMS, or FDC
Germany, you receive vbv_failure instead
of internet when
payerAuthValidateReply_ eci is 07.
payerAuthValidateReply_ The directory server error code indicating a Validate Integer
directoryServerErrorCode problem with the transaction. (3)

Payer Authentication Using the Simple Order API | October 2019 186
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthValidateReply_ Directory server text and additional detail about Validate String
directoryServerError the error for the transaction. (4096)
Description
payerAuthValidateReply_ The Directory server transaction ID is Validate String
directoryServer generated by the directory server during (36)
TransactionID authentication and returned with the
authentication results. Your card brand might
require you to send this field in the
authorization service request.
payerAuthValidateReply_ Numeric electronic commerce indicator (ECI) Validate String
eci returned only for Visa, American Express, JCB, (255)
Diners Club, and Discover transactions. You
must send this value to your payment
processor in the subsequent request for card
authorization. This field contains one of these
values:
 05: Successful authentication
 06: Authentication attempted
 07: Failed authentication (No response from
the merchant because of a problem.)
payerAuthValidateReply_ ECI value that can be returned for Visa, Validate String
eciRaw Mastercard, American Express, JCB, Diners (255)
Club, and Discover. The field is absent when
authentication fails. If your payment processor
is Streamline, you must pass the value of this
field instead the value of
payerAuthValidateReply_eci or
payerAuthValidateReply_
ucafCollectionIndicator.
This field can contain one of these values:
 01: Authentication attempted (Mastercard)
 02: Successful authentication (Mastercard)
 05: Successful authentication (Visa,
American Express, JCB, Diners Club, and
Discover)
 06: Authentication attempted (Visa,
American Express, JCB, Diners Club, and
Discover)

Payer Authentication Using the Simple Order API | October 2019 187
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthValidateReply_ The type of 3D Secure transaction flow that Validate String (2)
effectiveAuthentication occurred. It can be one of the following:
Type
 CH: Challenge
 FR: Frictionless
 FD: Frictionless with delegation, (challenge
not generated by the issuer but by the
scheme on behalf of the issuer).
payerAuthValidateReply_ Indicates the number of authentication cycles Validate Integer
interactionCounter that the cardholder attempted. It is tracked by (2)
the issuing bank’s ACS.
Example When the customer receives the
challenge window, enters their one-time
password, and clicks submit, the interaction
counter equals 1. When the customer receives
the challenge window, receives the bank
message asking if they want the one-time
password sent to their phone or email, and they
choose before going to the next screen to enter
their one-time password, the interaction count
equals 2. One count is to choose how to have
their one-time password delivered. The second
count is for entering the one-time password
and clicking Submit.
payerAuthValidateReply_ Raw result of the authentication check. This Validate String
paresStatus field can contain one of these values: (255)
 A: Proof of authentication attempt was
generated.
 N: Customer failed or canceled
authentication. Transaction denied.
 U: Authentication not completed regardless
of the reason.
 Y: Customer was successfully authenticated.
Note This field applies only to the Asia, Middle
East, and Africa Gateway. If your system is
configured for this processor, you must send
the value of this field in your authorization
request.
payerAuthValidateReply_ Numeric value corresponding to the result of Validate Integer
reasonCode the validation request. For a list of possible (5)
values, see Appendix B, "Reason Codes," on
page 191.
payerAuthValidateReply_ SDK unique transaction identifier that is Validate String
sdkTransactionID generated on each new transaction. (36)

Payer Authentication Using the Simple Order API | October 2019 188
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthValidateReply_ This field contains the 3D Secure version that Validate String
specificationVersion was used to process the transaction. For (20)
example, 1.0.2 or 2.0.0.
payerAuthValidateReply_ Unique transaction identifier assigned by the Validate String
threeDSServer 3D Secure Server to identify a single (36)
TransactionID transaction.
payerAuthValidateReply_ AAV is a unique identifier generated by the Validate String
ucafAuthenticationData card-issuing bank after the customer is (255)
authenticated. The value is in Base64. Include
the data in the card authorization request.
Note This field is returned for only Mastercard
Identity Check transactions.
payerAuthValidateReply_ Numeric electronic commerce indicator (ECI). Validate String
ucafCollectionIndicator The field is absent when authentication fails. (255)
You must send this value to your payment
processor in the request for card authorization.
This field contain one of these values:
 0: UCAF collection is not supported at your
web site. Customer authentication was not
completed.
 1: UCAF collection is supported at your web
site, but UCAF was not populated. Customer
authentication was not completed.
 2: UCAF collection is supported at your web
site, and UCAF was populated. Customer
completed authentication.
Note This field is returned for only Mastercard
Identity Check transactions.
payerAuthValidateReply_ Enables the communication of trusted Validate String (1)
whiteListStatus beneficiary and whitelist status among the
ACS, the directory server, and the 3D Secure
requestor.
Possible Values:
 Y: 3D Secure requestor is whitelisted by
cardholder
 N: 3D Secure requestor is not whitelisted by
cardholder

Payer Authentication Using the Simple Order API | October 2019 189
Appendix A API Fields

Table 18 Reply Fields (Continued)

Field Name Description Returned By Type &

Length
payerAuthValidateReply_ This field is populated by the system setting Validate Integer
whiteListStatusSource Whitelist Status. (2)
Possible Values:
 01: 3D Secure Server
 02: Directory server
 03: ACS
payerAuthValidateReply_ Transaction identifier generated by Validate String
xid CyberSource for validation checks. Use this (255)
value, which is in Base64, to match the PAReq
with the PARes. CyberSource forwards the XID
with the card authorization service to these
payment processors:
 Barclays
 Streamline when the commerce indicator is
spa
purchaseTotals_currency Currency used for the order. Use the standard Enroll String
ISO codes located in the Support Center. (255)
Validate
reasonCode Numeric value corresponding to the result of Enroll Integer
the overall request. See Appendix B, "Reason (5)
Validate
Codes," on page 191 for a list of possible
values.
requestID Identifier for the request. Enroll String
(255)
Validate
requestToken Identifier for the request generated by Enroll String
CyberSource. (256)
Validate
Request token data created by CyberSource
for each reply. The field is an encoded string
that contains no confidential information such
as an account or card verification number. The
string can contain a maximum of 256
characters.

Payer Authentication Using the Simple Order API | October 2019 190
APPENDIX
Reason Codes
B

The following table lists the reason codes that are returned with the reply. CyberSource
reserves the right to add new reason codes at any time. If your error handler receives a
reason code that it does not recognize, it should use the decision field to determine the
result.

Table 19 Reason Codes

Reason Code Description

100 Successful transaction.
101 The request is missing one or more required fields.
Possible action: See the reply fields missingField_0 through missingField_N for
the missing fields. Resend the request with the complete information.
102 One or more fields in the request contains invalid data.
Possible action: See the reply fields invalidField_0 through invalidField_N for
the invalid fields. Resend the request with the correct information.
150 Error: General system failure.
Possible action: Wait a few minutes and resend the request.
151 Error: The request was received, but a server time-out occurred. This error does
not include time-outs between the client and the server.
Possible action: Wait a few minutes and resend the request.
152 Error: The request was received, but a service time-out occurred.
Possible action: Wait a few minutes and resend the request.
234 A problem exists with your CyberSource merchant configuration.
Possible action: Do not resend the request. Contact Customer Support to correct
the configuration problem.
475 The customer is enrolled in payer authentication. Authenticate the cardholder
before continuing with the transaction.
476 The customer cannot be authenticated.
Possible action: Review the customer’s order.

Payer Authentication Using the Simple Order API | October 2019 191
APPENDIX
Request and Reply
Examples
C

This appendix contains examples for the check enrollment service and the validate
authentication service. All examples are in name-value pair format.

These examples contain only the fields essential to the demonstration. Do not
prepare your implementation according to the fields shown in these examples.
Warning They are provided for your information only.

Standard Integration Examples

The following is an example of a request for the check enrollment service:

Check Enrollment Request Example

Example 22 Check Enrollment Request
payerAuthEnrollService_run=true
merchantID=patest
merchantReferenceCode=23AEE8CB6B62EE2AF07
item_0_unitPrice=19.99
purchaseTotals_currency=USD
card_expirationMonth=01
card_expirationYear=2020
card_accountNumber=xxxxxxxxxxxxxxxx
card_cardType=001
payerAuthEnrollService_authenticationTransactionID=Fl8d1UW9VwTyawKTdex0

Payer Authentication Using the Simple Order API | October 2019 192
Appendix C Request and Reply Examples

Check Enrollment Reply Example

Example 23 Transaction Reply for Visa Card with Visa Secure

requestID=0340290070000167905080
merchantReferenceCode=23AEE8CB6B62EE2AF07
purchaseTotals_currency=USD
decision=ACCEPT
reasonCode=100
payerAuthEnrollReply_reasonCode=100
payerAuthEnrollReply_authenticationResult=0
payerAuthEnrollReply_authenticationStatusMessage=Success
payerAuthEnrollReply_authenticationTransactionID=Fl8d1UW9VwTyawKTdex0
payerAuthEnrollReply_cavv=Y2FyZGluYWxjb21tZXJjZWF1dGg=
payerAuthEnrollReply_commerceIndicator=vbv
payerAuthEnrollReply_eci=5
payerAuthEnrollReply_eciRaw=05
payerAuthEnrollReply_paresStatus=Y
payerAuthEnrollReply_reasonCode=100
payerAuthEnrollReply_specificationVersion=2.0.1
payerAuthEnrollReply_veresEnrolled=Y

Payer Authentication Using the Simple Order API | October 2019 193
Appendix C Request and Reply Examples

Hybrid Integration Examples

Check Enrollment Request Example

Example 24 Check Enrollment

payerAuthEnrollService_run=true
merchantID=patest
merchantReferenceCode=23AEE8CB6B62EE2AF07
item_0_unitPrice=19.99
purchaseTotals_currency=USD
card_expirationMonth=01
card_expirationYear=2020
card_accountNumber=xxxxxxxxxxxxxxxx
card_cardType=001
...
<Other 2.0 optional fields>
referenceID=CybsTester-778d0f67

Payer Authentication Using the Simple Order API | October 2019 194
Appendix C Request and Reply Examples

Check Enrollment Reply Example

Example 25 Transaction Reply for Mastercard with Identity Check

requestID=0340290070000167905080
merchantReferenceCode=23AEE8CB6B62EE2AF07
purchaseTotals_currency=USD
decision=REJECT
reasonCode=475
payerAuthEnrollReply_reasonCode=475
payerAuthEnrollReply_acsURL=https://www.example.com
payerAuthEnrollReply_authenticationTransactionID=x0Jpbq2uIT7o0tQqwd60
payerAuthEnrollReply_paReq=value in base64:
eJxVUuFygjAMfhXPw9Tkv9g6...
payerAuthEnrollReply_specificationVersion=2.0.1
payerAuthEnrollReply_veresEnrolled=Y
request_
token=AhjzbwSTHCfKtXsaE6elEQJP+BFNcZtIHTiD9au3tjijj5Uar+AuAAAAkAY5

Payer Authentication Using the Simple Order API | October 2019 195
Appendix C Request and Reply Examples

Validate Authentication Request Example

Example 26 Validate Authentication Request

payerAuthValidateService_run=true
merchantID=patest
merchantReferenceCode=23AEE8CB6B62EE2AF07
item_0_unitPrice=19.99
purchaseTotals_currency=USD
card_expirationMonth=01
card_expirationYear=2020
card_accountNumber=xxxxxxxxxxxxxxxx
card_cardType=001
payerAuthValidateService_authenticationTransactionID=
UhGFMeW6IPZbgt9diHK0
referenceID=CybsTester-cc719e84

Payer Authentication Using the Simple Order API | October 2019 196
Appendix C Request and Reply Examples

Validate Authentication Reply Example

Example 27 Transaction Reply for Mastercard with Identity Check

requestID=0340290070000167905080
merchantReferenceCode=23AEE8CB6B62EE2AF07
purchaseTotals_currency=USD
decision=ACCEPT
reasonCode=100
payerAuthValidateReply_reasonCode=100
payerAuthValidateReply_authenticationResult=0
payerAuthValidateReply_authenticationStatusMessage=Success
payerAuthValidateReply_cavv=Y2FyZGluYWxjb21tZXJjZWF1dGg=
payerAuthValidateReply_commerceIndicator=vbv
payerAuthValidateReply_eci=5
payerAuthValidateReply_eciRaw=05
payerAuthValidateReply_paresStatus=Y
payerAuthValidateReply_reasonCode=100
payerAuthValidateReply_specificationVersion=2.0.1
request_
token=AhjzbwSTHCfKtXsaE6elEQJP+BFNcZtIHTiD9au3tjijj5Uar+AuAAAAkAY5

Payer Authentication Using the Simple Order API | October 2019 197
APPENDIX
Web Site Modification
Reference
D

This appendix contains information about modifying your web site to integrate
CyberSource Payer Authentication services into your checkout process. It also provides
links to payment card company web sites where you can download the appropriate logos.

Web Site Modification Checklist

1 Modify web page buttons:

 Order submission button: disable the final “buy” button until the customer completes
all payment and authentication requirements.

 Browser back button: account for unexpected customer behavior. Use session checks
throughout the authentication process to prevent authenticating transactions twice.
Avoid confusing messages, such as warnings about expired pages.

2 Add appropriate logos:

 Make sure you have downloaded the appropriate logos of the cards that you support
and place these logos next to the card information entry fields on your checkout
pages. For more information about obtaining logos and using them, see "3D Secure
Services Logos," page 199.

3 Add informational message:

 Add a message next to the final “buy” button and the card logo to inform your
customers that they may be prompted to provide their authentication password or to
sign up for the authentication program specific to their card. For examples of
messages you can use, see "Informational Message Examples," page 200.

Payer Authentication Using the Simple Order API | October 2019 198
Appendix D Web Site Modification Reference

3D Secure Services Logos

The following table contains links to payment card company web sites from which you can
download logos and information about how to incorporate them into your online checkout
process.

Table 20 3D Secure Services Logos Download Location

3D Secure Service Download Location

Visa Secure http://usa.visa.com/merchants/grow-your-business/payment-technologies/verified-by-
visa.jsp
This web site contains information about Visa Secure and links to logos for download.
The page also contains links to a best practice guide for implementing Visa Secure and a
link to a Merchant Toolkit. See the list of links at the right margin of the web page to
download these files.
Mastercard Identity http://www.mastercard.us/merchants/securecode.html
Check and Maestro
This web site contains information about Identity Check, links to logos for download, and
information about integrating the Identity Check information into your web site checkout
page.
For information about Maestro logos, go to:
http://www.mastercardbrandcenter.com/us/howtouse/bms_mae.shtml
American Express https://network.americanexpress.com/uk/en/safekey/
SafeKey
This web site contains information about SafeKey and links to logos for download.
JCB J/Secure http://partner.jcbcard.com/security/jsecure/logo.html
This web site contains information about J/Secure and links to logos for download.
Diners Club http://www.dinersclubprotect-buy.net/Public/MerchantTools.aspx
ProtectBuy
This web site contains information about Diners Club ProtectBuy and links to logos for
download.
Discover ProtectBuy https://www.discovernetwork.com/en-us/business-resources/free-signage-logos
This web site contains information about Discover ProtectBuy and links to logos for
download.

Payer Authentication Using the Simple Order API | October 2019 199
Appendix D Web Site Modification Reference

Informational Message Examples

Add a brief message adjacent to your final buy button on your checkout page to inform
customers that they may be prompted to provide their authentication password or to enroll
in the authentication program for their card.

The following examples may be used, but consult your specific card authentication
program to make sure you conform to their messaging requirements.

Example 28

To help prevent unauthorized use of <card_type> cards online, <your_business_name>

participates in <card_authentication_program>.

When you submit your order, you may receive a <card_authentication_program>

message from your <card_type> card issuer. If your card or issuer does not participate in
the program, you will be returned to our secure checkout to complete your order. Please
wait while the transaction is processed. Do not click the Back button or close the browser
window.

Example 29

Your card may be eligible for enrollment or is enrolled in the Visa Secure, Mastercard,
Maestro, American Express SafeKey, JCB J/Secure, Diners Club ProtectBuy, or Discover
ProtectBuy programs. After you submit your order, your card issuer may prompt you for
your password before you complete your purchase.

Payer Authentication Using the Simple Order API | October 2019 200
APPENDIX
Payer Authentication
Transaction Details in the
E
Business Center
This appendix describes how to search the Business Center for details of transactions that
are screened by CyberSource Payer Authentication. Transaction data is stored for 12
months so that you can send it to payment card companies if necessary.

Searching for Payer Authentication Details

Payer authentication data that is returned in API reply fields can be searched by using
Transaction Search in the Business Center.

With other services, green means that the service request was successful, red means that
it failed, and black means that the service request was not run. However, you need to
interpret the result of the enrollment check differently:

 If the card is enrolled, the application result is shown in red, which indicates that you
need to authenticate the user before you can request card authorization.

 If the card is not enrolled, the application result is shown in green because you do not
need to authenticate the user. You can authorize the card immediately.

Enrolled Card
When a card is enrolled, the process consists of two steps: after you check for enrollment,
you need to authenticate the customer.

Enrollment Check
For the enrollment check for an enrolled card, payer authentication data is located in the
Transaction Search Details window in the following sections:

 Request Information section: The enrollment check service is shown in red because
the card is enrolled. You receive the corresponding reply information. If the card
authorization service had been requested at the same time, it would not have been
run and would appear in black.

You can obtain additional information about related orders by clicking the links on the
right (Event Search and Details).

Payer Authentication Using the Simple Order API | October 2019 201
Appendix E Payer Authentication Transaction Details in the Business Center

 Order Information section: When authentication is required, save the XID for use later.
You do not receive an ECI or AAV_CAVV because the authentication is not complete.

You need to authenticate the user by requesting the validation service.

Events Related to Payer Authentication

When the XID value is available, you also have the option to search for other parts of the
transaction with the By Payer Authentication History under Similar Searches link.

You can use the link to find the details page that shows the associated card validation and
authorization results. On the results page:

 The most recent event is the successful authentication. If you click the request ID, the
authentication details page opens. If the event also returned an XID value, the By
Payer Authentication History link is present. If you click it, you return to the results
page.

 The older event is the enrollment check.

If the card authorization service had been requested at the same time as payer
authentication, authorization would not have run with the enrollment check but with the
validate authentication request. On the results page:

 The most recent event is the combined successful customer authentication and card
authorization. If you click the request ID, the details page opens.

 The older event is the enrollment check in red because the card is enrolled.

Payer Authentication Details

You also can search for the payer authentication data with the View Payer Authentication
Details link located under Extended Views. If you click Export to XML File, the XML code is
returned as shown in Example 30. CyberSource stores payer authentication information
for 12 months after the transaction. For more information about this XML report, see
"Payer Authentication Detail Report," page 212.

Payer Authentication Using the Simple Order API | October 2019 202
Appendix E Payer Authentication Transaction Details in the Business Center

Example 30 Transaction Detail XML Export

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE Result SYSTEM "https://ebc.cybersource.com/ebc/reports/dtd/
payerauthdetails.dtd">
<Result>
<PayerAuthDetail>
<RequestID>1889453160000167904548</RequestID>
<MerchantID>example</MerchantID>
<TransactionDate>Sep 04 2007 03:35:16 PM</TransactionDate>
<TransactionType>ics_pa_enroll</TransactionType>
<ProofXML>
<Date>20070904 15:30:21</Date>
<DSURL>https:123.456.789.01:234</DSURL>
<PAN>XXXXXXXXXXXX1007</PAN>
<AcqBIN>1234567</AcqBIN>
<MerID>00032805455400000</MerID>
<Password>XXXXXXXX</Password>
<Enrolled>Y</Enrolled>
</ProofXML>
<VEReq>
<PAN>XXXXXXXXXXXX1007</PAN>
<AcqBIN>1234567</AcqBIN>
<MerID>special_id</MerID>
</VEReq>
<VERes>
<Enrolled>Y</Enrolled>
<AcctID>G7XnvRUvB6jKH5/KxVBwYnx6cyw=</AcctID>
<URL>https://www.example_url.com</URL>
</VERes>
<PAReq>
<AcqBIN>1234567</AcqBIN>
<MerID>00032805455400000</MerID>
<Name>Example_Merchant</Name>
<Country>US</Country>
<URL>http://www.example_merchant.com</URL>
<XID>a/Q7zFs2EdyKlZjve2/X4gEAAAc=</XID>
<Date>Sep 04 2007 03:30:21 PM</Date>
<PurchaseAmount>1.00 USD</PurchaseAmount>
<AcctID>G7XnvRUvB6jKH5/KxVBwYnx6cyw=</AcctID>
<Expiry>0905</Expiry>
</PAReq>
</PayerAuthDetail>
</Result>

Payer Authentication Using the Simple Order API | October 2019 203
Appendix E Payer Authentication Transaction Details in the Business Center

Authentication Validation
For a transaction in which the validation and the card authorization services were
processed successfully, payer authentication data is located in the Transaction Search
Details window in the following sections:

 Request Information section: The validation service succeeded. You receive the
reason code 100, and the corresponding reply message. The necessary payer
authentication information was passed to the card authorization service, which was
processed successfully. Both services are shown in green.

 Order Information section: You received a value for all three parameters because the
validation was successful. You may not receive an ECI value when a system error
prevents the card issuer from performing the validation or when the cardholder does
not complete the process.

Card Not Enrolled

When the card is not enrolled, the enrollment check service result is shown in green, and
the card authorization request (if requested at the same time) proceeds normally.

Payer Authentication Details

You can also search for the payer authentication data by using the View Payer
Authentication Details link located under Extended Views. If you click Export to XML File,
the XML code is returned as shown in Example 31. CyberSource stores payer
authentication information for 12 months after the transaction. For more information on
this XML report, see "Payer Authentication Detail Report," page 212.

Payer Authentication Using the Simple Order API | October 2019 204
Appendix E Payer Authentication Transaction Details in the Business Center

Example 31 Transaction Detail XML Export

<?xml version="1.0" encoding="utf-8"?>

Payer Authentication Using the Simple Order API | October 2019 205
Appendix E Payer Authentication Transaction Details in the Business Center

Transaction Details
For a transaction in which the card is not enrolled, payer authentication data is located in
the Transaction Search Details window in the following sections:

 Request Information section: the service is shown in green. You can obtain additional
information about related orders by clicking the link on the right.

 Order Information section: the detailed information for the authorization service:

 The ECI value is 1: authentication is not required because the customer’s

Mastercard card is not enrolled.

 The AAV/CAVV area is empty because you receive a value only if the customer is
authenticated.

 The XID area is empty because the card in not enrolled.

Payer Authentication Search

Search for transactions that used the payer authentication and card authorization
services. When searching for transactions, consider the following:

 Search options:

 Use the XID as search parameter to find both parts of a transaction processed
with an enrolled card. When using the XID as search option, make sure to keep
the = sign at the end of the string.

 The list of applications is simplified to facilitate searching for the relevant service
requests.

 Payer authentication information is available for 12 months after the transaction

date.

 Search results: the results options include the XID and the customer’s account
number (PAN). Use the XID to find all parts of the transaction.

 Payer authentication details: all transaction details are discussed under "Searching for
Payer Authentication Details," page 201.

Payer Authentication Using the Simple Order API | October 2019 206
Appendix E Payer Authentication Transaction Details in the Business Center

Storing Payer Authentication Data

Payment card companies allow a certain number of days between the payer
authentication and the authorization requests. If you settle transactions older than the pre-
determined number of days, payment card companies may require that you send them the
AAV, CAVV, or the XID if a chargeback occurs. The requirements depend on the card type
and the region. For more information, see your agreement with your payment card
company. After your transactions are settled, you can also use this data to update the
statistics of your business.

You may be required to show the values that you receive in the PARes, the proof XML,
and the PAReq fields as proof of enrollment checking for any payer authentication
transaction that you present again because of a chargeback. Your account provider may
require that you provide all data in human-readable format, so make sure that you can
decode the PAReq and PARes. For enrollment reply examples, see Appendix C, "Request
and Reply Examples," on page 192. The replies are similar for all card types.

Payment card companies have implemented the 3D Secure protocol in different ways
throughout the world. CyberSource recommends that you contact your merchant account
provider to find out what is required. For more information on decrypting and providing the
PARes contact your account manager.

Payer Authentication Using the Simple Order API | October 2019 207
APPENDIX
Payer Authentication
Reports
F

This chapter describes the reports that you can download from the Business Center. All
reports on the production servers are retained for 16 months but the transaction history is
only kept in the database for six months. All reports on the test servers are deleted after
two weeks. Only transactions that were processed are reported. Those that resulted in
system error or time-out are not. For more information about API replies and their
meanings, see Appendix A, "API Fields," on page 149.

To obtain the reports, you must file a support ticket in the Support Center.

Note

Payer Authentication Summary Report

This daily, weekly, and monthly summary report indicates the performance of the
enrollment and validation services as a number of transactions and a total amount for
groups of transactions. The report provides this information for each currency and type of
card that you support. You can use this information to estimate how your transactions are
screened by payer authentication: successful, attempted, and incomplete authentication.
The cards reported are Visa, Mastercard, Maestro, American Express, JCB, Diners Club,
and Discover. This daily report is generally available by 7:00 am EST. Data in this report
remains available for six months.

Payer Authentication Using the Simple Order API | October 2019 208
Appendix F Payer Authentication Reports

Downloading the Report

To view a report in the New Business Center, follow these steps:

Step 1 In the left navigation panel, click the Reports icon.

Step 2 Under Transaction Reports, click Payer Auth Summary. The Payer Auth Summary
Report page appears.

Step 3 In the search toolbar, select Date Range you want to include in the report. Account level
users must select a merchant as well.

Step 4 Based on the Date Range selected, choose the specific day, week, or month you want to
review.

Only months which have already occurred in the current year display in the Month list – to
view all months of a previous year, select the year first, then choose the desired month.

To view results from the period prior to or following the selected period, click Previous or
Next below the search toolbar.

Matching the Report to the Transaction Search

Results
The figure below shows the search results that contain the transactions that appear in the
above report. For more information on search results, see "Searching for Payer
Authentication Details," page 201.

Figure 3 Payer Authentication Report Details

Payer Authentication Using the Simple Order API | October 2019 209
Appendix F Payer Authentication Reports

Interpreting the Report

A report heading shows the title, the ID of the user who downloaded the report, the
merchant ID, and the date or date range of the report. The report is organized by card
type. In each section, currencies are reported alphabetically. For each currency, you
receive a summary of your payer authentication validation results displayed as total
amount and number of transactions.

Table 21 Payer Authentication Report Interpretation

Card Type Interpretation Protected? Reported

Commerce Indicator ECI
Visa, No authentication No Internet 7
American
Recorded attempt to authenticate Yes VbV, Aesk, or JS 6
Express, and
Attempted
JCB
Successful authentication Yes VbV, JS, or Aesk 5
Mastercard No authentication No Internet2 71
and Maestro
Recorded attempt to authenticate Yes SPA 1
Successful authentication Yes SPA 2
Diners Club No authentication No Internet 7
and Discover
Recorded attempt to authenticate Yes PB or DIPB Attempted 6
Successful authentication Yes PB or DIPB 5
1 Although the report heading is 7, you receive a collection indicator value of 1, or the reply field is empty.
2 Although the report heading is Internet, you receive spa_failure in the commerce indicator reply field.

Transactions are divided into two groups: those for which you are protected and those for
which you are not:

 For Visa, American Express, JCB, Diners Club, and Discover: liability shift for VbV
and VbV attempted

 For Mastercard and Maestro: liability shift only for SPA

 For all other results: no liability shift

Payer Authentication Using the Simple Order API | October 2019 210
Appendix F Payer Authentication Reports

Comparing Payer Authentication and Payment

Reports
There may be differences between the Payer Authentication report and the payment
reports because an authenticated transaction may not be authorized.

The values (amounts and counts) in the Payer Authentication report may not match
exactly your other sources of reconciliation because this report shows the transactions
that were validated by payer authentication, not necessarily the transactions that were
authorized. There are more likely to be reconciliation discrepancies if you process your
authorizations outside of CyberSource.

Example 32 Payer Authentication Reports Compared to Payment Reports

For 10,000 orders, you may receive the following results:

 9900 successful enrollment checks (Payer Authentication report)
 9800 successful authentication checks (Payer Authentication report)
 9500 successful authorization checks (Payment report)

The amounts and numbers can be higher in the Payer Authentication report than in the
payment reports. In this example, it shows the results of the first two numbers in the Payer
Authentication report and the last one in the payment reports.

To reconcile your reports more easily when using payer authentication, we recommend
that you attempt to authenticate the same amount that you want to authorize.

Payer Authentication Using the Simple Order API | October 2019 211
Appendix F Payer Authentication Reports

Payer Authentication Detail Report

This section describes the XML report that you download when you click the Export to
XML feature in the Payer Authentication details page of the Business Center. The data in
this report remains available for 12 months. You can obtain the DTD in the
Reports > DTDs section of the Business Center.

File Name
The file that you download is named according to this format:
<MerchantID>-<RequestID>-<TransactionType>.xml

Example 33

example_merchant-1884340770000167904548-ics_pa_enroll.xml

Date and Time

In the report, the date and time are shown in this format:
YYYY-MM-DDTHH:MM:SS[+ | -]HH:MM:

 YYYY-MM-DD is the year, month, and day.

 THH:MM:SS is the time (hours, minutes, and seconds). The T separates the date and
the time.

 [+ | -]HH:MM is the time zone’s offset from Greenwich Mean Time (GMT), with HH
representing hours and MM representing minutes. The number is prefixed by either a
plus (+) or minus (-) to indicate whether the offset adds to or subtracts from GMT. For
example, the offset for Pacific Daylight Time (PDT) is -07:00.

Example 34

2016-07-31T16:31:18-07:00 equals July 31, 2016, at 16:31:18 (4:31:18 p.m. PDT)

Payer Authentication Using the Simple Order API | October 2019 212
Appendix F Payer Authentication Reports

Report

<Result>
The <Result> element is the root element of the report.
<Result>
(PayerAuthDetail+)
</Result>

Table 22 Child Elements of <Report>

Element Name Description

<PayerAuthDetail> Contains the transaction in the report. For a list of child elements, see
<PayerAuthDetail>.

Example <Report> Element

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE Report SYSTEM "https://ebctest.cybersource.com/ebctest/reports/dtd/
payerauthdetails.dtd">
<Result>
<PayerAuthDetail>
...
</PayerAuthDetail>
</Result>

<PayerAuthDetail>
The <PayerAuthDetail> element contains information about a single transaction.
<PayerAuthDetail>
(RequestID)
(MerchantID)
(TransactionDate)
(TransactionType)
(ProofXML)?
(VEReq)?
(VERes)?
(PAReq)?
(PARes)?
(AuthInfo)?
</PayerAuthDetail>

Payer Authentication Using the Simple Order API | October 2019 213
Appendix F Payer Authentication Reports

Table 23 Child Elements of <PayerAuthDetail>

Element Name Description Type &

Length
<RequestID> Unique identifier generated by CyberSource for the transaction. Numeric (26)
This field corresponds to the requestID API field.
<MerchantID> CyberSource merchant ID used for the transaction. String (30)

<TransactionDate> Date on which the transaction was processed. DateTime

(25)
<TransactionType> CyberSource service requested in SCMP format. This field can String (20)
contain one of the following values:
 ics_auth: Card authorization service
 ics_pa_enroll: Payer Authentication Enrollment Check
 ics_pa_validate: Payer Authentication Validation
<ProofXML> Data that includes the date and time of the enrollment check and String (1024)
the VEReq and VERes elements. This field corresponds to the
payerAuthEnrollReply_proofXML API field.
<VEReq> Verify Enrollment Request (VEReq) sent by the merchant’s
server to the directory server and by the directory server to the
ACS to determine whether authentication is available for the
customer’s card number. For a list of child elements, see
"<VEReq>," page 216.
<VERes> Verify Enrollment Response (VERes) sent by the directory server.
For a list of child elements, see "<VERes>," page 217.
<PAReq> Payer Authentication Request message that you send to the ACS
through the payment card company. Corresponds to the
payerAuthEnrollReply_paReq API field.
For a list of child elements, see "<PAReq>," page 218.
<PARes> Payer Authentication Response message sent by the ACS. For a
list of child elements, see "<PARes>," page 219.
<AuthInfo> Address and card verification data. For a list of child elements,
see "<AuthInfo>," page 221.

Payer Authentication Using the Simple Order API | October 2019 214
Appendix F Payer Authentication Reports

Example <PayerAuthDetail> Element

<PayerAuthDetail>
<RequestID>0004223530000167905139</RequestID>
<MerchantID>example_merchant</MerchantID>
<TransactionDate>2007-07-25T18:23:22-07:00</TransactionDate>
<TransactionType>ics_pa_enroll</TransactionType>
<ProofXML>
...
</ProofXML>
<VEReq>
...
</VEReq>
<VERes>
...
</VERes>
<PAReq>
...
</PAReq>
<PARes>
...
</PARes>
</PayerAuthDetail>

<ProofXML>
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
payerAuthEnrollReply_proofXML API field.

<ProofXML>
(Date)
(DSURL)
(PAN)
(AcqBIN)
(MerID)
(Password)
(Enrolled)
</ProofXML>

Table 24 Child Elements of <ProofXML>

Element Name Description Type & Length

<Date> Date when the proof XML is generated. DateTime (25)
Note 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.
<DSURL> URL for the directory server where the proof XML originated. String (50)

Payer Authentication Using the Simple Order API | October 2019 215
Appendix F Payer Authentication Reports

Table 24 Child Elements of <ProofXML> (Continued)

Element Name Description Type & Length

<PAN> Customer’s masked account number. This element corresponds to the String (19)
payerAuthEnrollReply_proxyPAN API field.
<AcqBIN> First six digits of the acquiring bank’s identification number. Numeric (6)

<MerID> Identifier provided by your acquirer; used to log into the ACS URL. String (24)

<Password> Merchant's masked authentication password to the ACS; provided by String (8)
your acquirer. Applies only to cards issued outside the U.S.
<Enrolled> Result of the enrollment check. This field can contain one of these String (1)
values:
 Y: Authentication available.
 N: Cardholder not participating.
 U: Unable to authenticate regardless of the reason.

Example <ProofXML> Element

<ProofXML>
<Date>20070725 11:18:51</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>
The <VEReq> element contains the enrollment check request data.
<VEReq>
(PAN)
(AcqBIN)
(MerID)
</VEReq>

Table 25 Child Elements of <VEReq>

Element Name Description Type & Length

<MerID> Identifier provided by your acquirer; used to log in to the ACS URL. String (24)

Payer Authentication Using the Simple Order API | October 2019 216
Appendix F Payer Authentication Reports

Example <VEReq> Element

<VEReq>
<PAN>XXXXXXXXXXXX0771</PAN>
<AcqBIN>123456</AcqBIN>
<MerID>example</MerID>
</VEReq>

<VERes>
The <VERes> element contains the enrollment check reply data.
<VERes>
(Enrolled)
(AcctID)
(URL)
</VERes>

Table 26 Child Elements of <VERes>

Element Name Description Type & Length

<Enrolled> Result of the enrollment check. This field can contain one of these String (1)
values:
 Y: Authentication available.
 N: Cardholder not participating.
 U: Unable to authenticate regardless of the reason.
<AcctID> Masked string used by the ACS. String (28)

<URL> URL of Access Control Server where to send the PAReq. This element String (1000)
corresponds to the payerAuthEnrollReply_acsURL API field.

Example <VERes> Element

<VERes>
<Enrolled>Y</Enrolled>
<AcctID>NDAxMjAwMTAxMTAwMDc3MQ==</AcctID>
<URL>https://www.example_url.com</URL>
</VERes>

Payer Authentication Using the Simple Order API | October 2019 217
Appendix F Payer Authentication Reports

<PAReq>
The <PAReq> element contains the payer authentication request message. This element
corresponds to the payerAuthEnrollReply_paReq API field.
<PAReq>
(AcqBIN)
(MerID)
(Name)
(Country)
(URL)
(XID)
(Date)
(PurchaseAmount)
(AcctID)
(Expiry)
</PAReq>

Table 27 Child Elements of <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 web site. String

<XID> Unique transaction identifier generated by CyberSource for each String (28)
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 reply. To find all
requests related to a transaction, you can also search transactions for a
specific XID.
<Date> Date and time of request. DateTime (25)
Note 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.
<Purchase Authorization amount and currency for the transaction. This element Amount (15)
Amount> corresponds to the totals of the offer lines or from the following fields:
 ccAuthReply_amount (see Credit Card Services Using the Simple
Order API [PDF | HTML]) or purchaseTotals_grandTotalAmount
from external data.
<AcctID> Masked string used by the ACS. String (28)

<Expiry> Expiration month and year of the customer’s card. Number (4)

Payer Authentication Using the Simple Order API | October 2019 218
Appendix F Payer Authentication Reports

Example <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>2007-07-25T18:18:51-07:00</Date>
<PurchaseAmount>1.00 USD</PurchaseAmount>
<AcctID>NDAxMjAwMTAxMTAwMDc3MQ==</AcctID>
<Expiry>0811</Expiry>
</PAReq>

<PARes>
The <PARes> element contains the payer authentication reply message.
<PARes>
(AcqBIN)
(MerID)
(XID)
(Date)
(PurchaseAmount)
(PAN)
(AuthDate)
(Status)
(CAVV)
(ECI)
</PARes>

Table 28 Child Elements of <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 String (24)
URL.
<XID> XID value returned in the customer authentication reply. This String (28)
element corresponds to the payerAuthEnrollReply_xid and
payerAuthValidateReply_xid API fields.
<Date> Date and time of request. DateTime (25)
Note 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.

Payer Authentication Using the Simple Order API | October 2019 219
Appendix F Payer Authentication Reports

Table 28 Child Elements of <PARes> (Continued)

Element Name Description Type & Length

<PurchaseAmount> Authorization amount and currency for the transaction. This Amount (15)
element corresponds to the totals of the offer lines or from the
following fields:
 ccAuthReply_amount (see Credit Card Services Using the
Simple Order API [PDF | HTML]) or purchaseTotals_
grandTotalAmount from external data
<PAN> Customer’s masked account number. This element corresponds String (19)
to the payerAuthEnrollReply_proxyPAN API field.
<AuthDate> Date and time of request. DateTime (25)
Note 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.
<Status> Result of the authentication check. This field can contain one of String (1)
these values:
 Y: Customer was successfully authenticated.
 N: Customer failed or cancelled authentication. Transaction
denied.
 U: Authenticate not completed regardless of the reason.
 A: Proof of authentication attempt was generated.
<CAVV> CAVV (Visa, American Express, JCB, Diners Club, and Discover String (50)
cards = * below) or AAV (Mastercard, and Maestro cards = **
below) returned in the customer authentication reply. This element
corresponds to the payerAuthValidateReply_cavv (*) and
payerAuthValidateReply_ucafAuthenticationData (**) API
fields.
<ECI> Electronic commerce indicator returned in the customer Numeric (1)
authentication reply. This element corresponds to the
payerAuthValidateReply_eci (*) and payerAuthValidateReply_
ucafCollectionIndicator (**) API fields.

Payer Authentication Using the Simple Order API | October 2019 220
Appendix F Payer Authentication Reports

Example <Card> Element

<PARes>
<AcqBIN>123456</AcqBIN>
<MerID>4444444</MerID>
<XID>Xe5DcjrqEdyC37MOPfIzMwAHBwE=</XID>
<Date>2007-07-25T20:05:18-07:00</Date>
<PurchaseAmount>1002.00 USD</PurchaseAmount>
<PAN>0000000000000771</PAN>
<AuthDate>2007-07-25T20:05:18-07:00</AuthDate>
<Status>Y</Status>
<CAVV>AAAAAAAAAAAAAAAAAAAAAAAAAAA=</CAVV>
<ECI>5</ECI>
</PARes>

<AuthInfo>
The <AuthInfo> element contains address and card verification information.
<AuthInfo>
(AVSResult)
(CVVResult)
</AuthInfo>

Table 29 Child Elements of <AuthInfo>

Element Name Description Type & Length

<AVSResult> Optional results of the address verification test. String (1)
See ccAuthReply_avsCode or afsService_avsCode (if from
external data) in Credit Card Services Using the Simple Order API
(PDF | HTML).
<CVVResult> Optional results of the card verification number test. String (1)
See ccAuthReply_cvvCode or afsService_cvCode (if from
external data) in Credit Card Services Using the Simple Order API
(PDF | HTML).

Example <AuthInfo> Element

Payer Authentication Using the Simple Order API | October 2019 221
Appendix F Payer Authentication Reports

Examples
These examples show a complete transaction: the failed enrollment check (enrolled card)
and the subsequent successful authentication.

Failed Enrollment Check

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE Result SYSTEM "https://ebc.cybersource.com/ebc/reports/dtd/
payerauthdetails.dtd">
<Result>
<PayerAuthDetail>
<RequestID>1895549430000167904548</RequestID>
<MerchantID>sample_merchant_id</MerchantID>
<TransactionDate>Sep 11 2007 04:55:44 PM</TransactionDate>
<TransactionType>ics_pa_enroll</TransactionType>
<ProofXML>
<Date>20070911 16:51:00</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>Sep 11 2007 04:51:00 PM</Date>
<PurchaseAmount>1.00 USD</PurchaseAmount>
<AcctID>NDAxMjAwMTAxMTAwMDc3MQ==</AcctID>
<Expiry>0811</Expiry>
</PAReq>
</PayerAuthDetail>
</Result>

Payer Authentication Using the Simple Order API | October 2019 222
Appendix F Payer Authentication Reports

Successful Authentication

<?xml version="1.0" encoding="utf-8"?>

Payer Authentication Using the Simple Order API | October 2019 223
APPENDIX
Rules-Based Payer
Authentication
G

Rules-based payer authentication enables you to specify rules that define how
transactions are authenticated by a 3D Secure card authentication program. For example,
you can decide to turn off active authentication for transactions that would otherwise
require customer interaction to avoid degrading the customer experience. However, you
may decide to authenticate customers from card-issuing banks that use risk-based
authentication because the authentication is performed without customer interaction.

To enable your account for rules-based payer authentication, contact your CyberSource
sales representative.

Depending on the card type and country, active mandates supersede

rules-based payer authentication and revert to traditional 3D Secure.
Note

Available Rules
By default, when payer authentication is enabled on your account, authentication is
attempted on all transactions.

For transaction types that are not bypassed, you may be required to complete
authentication.

You can enable one or more of the following authentication transaction types. Any
transaction types that are set to bypass authentication return the reason code 100. If you
receive reason code 475 from the enrollment check, you must complete validation even if
no customer participation is needed.

Payer Authentication Using the Simple Order API | October 2019 224
Appendix G Rules-Based Payer Authentication

Table 30 Rules-Based Payer Authentication Types

Authentication Type Description Test Case Example

Active Authentication Customer is prompted to authenticate. Test Case 1: Visa Secure
Card Enrolled: Successful Authentication
Attempts Processing Customer is prompted to enroll in a 3D Test Case 3: Visa Secure
Secure card authentication program. Card Enrolled: Attempts Processing
This transaction type provides full 3D
Secure benefits.
Non-Participating Bank Card-issuing bank does not participate Test Case 9: Visa Secure
in a 3D Secure program. When Card Not Enrolled
enrollment is checked, this transaction
type provides full 3D Secure benefits,
including fraud chargeback liability shift
for customer “I didn’t do it” transactions
and interchange reduction of 5-59 basis
points.
Passive Authentication Customer is not prompted to Test Case 12: Visa Secure
authenticate. This transaction type Enrollment RIBA_PASS
provides full 3D Secure benefits when
passive authentication is completed.
Risk-Based Bank Card-issuing bank uses risk-based Test Case 14: Visa Secure
authentication. The likely outcome is that Enrollment RIBA
the customer is not challenged to enter
credentials. Most authentications
proceed without customer interaction.
This transaction type provides full 3D
Secure benefits.

API Replies
By default, API replies that are specifically associated with rules-based payer
authentication are turned off. Contact CyberSource Customer Support to
Note enable these API replies when rules are triggered.

Bypassed Authentication Transactions

When card authentication is bypassed as a result of your rules-based payer authentication
configuration, you can receive the following value for enrollment checks:

 payerAuthEnrollReply_veresEnrolled = B (indicates that authentication was

bypassed)

Payer Authentication Using the Simple Order API | October 2019 225
Appendix G Rules-Based Payer Authentication

Risk-Based Bank Transactions

When a transaction involves a card-issuing bank that supports risk-based authentication,
you may receive the following authentication path replies, depending on whether the card-
issuing bank deems the transaction risky:

 payerAuthEnrollReply_authenticationPath

 = RIBA
The card-issuing bank supports risk-based authentication, but whether the
cardholder is likely to be challenged cannot be determined.

 = RIBA_PASS
The card-issuing bank supports risk-based authentication, and it is likely that the
cardholder will not be challenged to provide credentials; also known as silent
authentication.

Payer Authentication Using the Simple Order API | October 2019 226
GLOSSARY
Glossary

AB C D E F G H I J K L M N O P Q R S T U V W X Y Z

Numerics

3D Secure Security protocol for online credit card and debit card transactions used by Visa
Secure, Mastercard Identity Check, American Express SafeKey, JCB J⁄Secure,
Diners Club ProtectBuy, and Discover ProtectBuy.

AAV Account Authentication Value. Unique 32-character transaction token for a 3D

Secure transaction. For Mastercard Identity Check, the AAV is named the UCAF.
For Visa Secure, the AAV is named the CAVV.

acquirer The financial institution that accepts payments for products or services on behalf
of a merchant. Also referred to as “acquiring bank.” This bank accepts or acquires
transactions that involve a credit card issued by a bank other than itself.

acquirer BIN A 6-digit number that uniquely identifies the acquiring bank. There is a different
acquirer BIN for Mastercard (starts with 5) and Visa (starts with 4) for every
participating acquirer.

acquiring Processor that provides credit card processing, settlement, and services to
processor merchant banks.

ACS Access Control Server. The card-issuing bank’s host for the payer authentication
data.

ACS URL The URL of the Access Control Server of the card-issuing bank that is returned in
the reply to the request to check enrollment. This is where you must send the
PAReq so that the customer can be authenticated.

ADS Activation During Shopping. The card issuer’s ability to ask the cardholder to
enroll in the card authentication service when the merchant posts to the ACS URL

Payer Authentication Using the Simple Order API | October 2019 227
Glossary

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

A (Continued)

American Express A globally issued card type that starts with 3 and which is identified as card type
003 by CyberSource. These cards participate in a card authentication service
(SafeKey) provided by 3D Secure.

API Application Programming Interface. A specification that can be used by software

components to communicate with each other.

authentication Raw data sent by the card issuer that indicates the status of authentication. It is
result not required to pass this data into the authorization.

authorization A request sent to the card issuing bank that ensures a cardholder has the funds
available on their credit card for a specific purchase. A positive authorization
causes an authorization code to be generated and the funds to be held. Following
a payer authentication request, the authorization must contain payer
authentication-specific fields containing card enrollment details. If these fields are
not passed correctly to the bank, it can invalidate the liability shift provided by card
authentication. Systemic failure can result in payment card company fines.

Base64 Standard encoding method for data transfer over the Internet.

BIN Bank Identification Number. The 6-digit number at the beginning of the card that
identifies the card issuer.

CAVV Cardholder Authentication Verification Value. A Base64-encoded string sent back

with Visa Secure-enrolled cards that specifically identifies the transaction with the
issuing bank and Visa. Standard for collecting and sending AAV data for Visa
Secure transactions. See AAV.

CAVV algorithm A one-digit reply passed back when the PARes status is a Y or an A. If your
processor is ATOS, this must be passed in the authorization, if available.

CVV Card Verification Value. Security feature for credit cards and debit cards. This
feature consists of two values or codes: one that is encoded in the magnetic strip
and one that is printed on the card. Usually the CVV is a three-digit number on the
back of the card. The CVV for American Express cards is a 4-digit number on the
front of the card. CVVs are used as an extra level of validation by issuing banks.

Payer Authentication Using the Simple Order API | October 2019 228
Glossary

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Diners Club A globally issued card type that starts with a 3 or a 5. CyberSource identifies
Diners Club cards with a card type of 005. These cards participate in a card
authentication service (ProtectBuy) provided by 3D Secure.

Directory Servers The Visa and Mastercard servers that are used to verify enrollment in a card
authentication service.

Discover Primarily, a U.S. card type that starts with a 6. CyberSource identifies Discover
cards with a card type of 004. These cards participate in a card authentication
service (ProtectBuy) provided by 3D Secure.

ECI (ECI Raw) The numeric commerce indicator that indicates to the bank the degree of liability
shift achieved during payer authentication processing.

E-Commerce Alpha character value that indicates the transaction type, such as MOTO or
Indicator INTERNET.

Enroll CyberSource transaction type used for verifying whether a card is enrolled in the
Identity Check or Visa Secure service.

HTTP Hypertext Transfer Protocol. An application protocol used for data transfer on the
Internet.

HTTP POST POST is one of the request methods supported by the HTTP protocol. The POST
request request method is used when the client needs to send data to the server as part of
the request, such as when uploading a file or submitting a completed form.

HTTPS Hypertext Transfer Protocol combined with SSL/TLS (Secure Sockets Layer/
Transport Layer Security) to provide secure encryption of data transferred over
the Internet.

Identity Check Trademarked name for Mastercard’s card authentication service.

Payer Authentication Using the Simple Order API | October 2019 229
Glossary

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

I (Continued)

issuer The bank that issued a credit card.

J/Secure The 3D Secure program of JCB.

JCB Japan Credit Bureau. A globally issued card type that starts with a 3. CyberSource
identifies JCB cards with a card type of 007. These cards participate in a card
authentication service (J/Secure) provided by 3D Secure.

Maestro A card brand owned by Mastercard that includes several debit card BINs within
the U.K., where it was formerly known as Switch, and in Europe. Merchants who
accept Maestro cards online are required to use SecureCode, Mastercard’s card
authentication service. CyberSource identifies Maestro cards with the 024 and
042 card types.
Note that many international Maestro cards are not set up for online acceptance
and cannot be used even if they participate in a SecureCode card authentication
program.

Mastercard A globally issued card that includes credit and debit cards. These cards start with
a 5. CyberSource identifies these cards as card type 002 for both credit and debit
cards. These cards participate in a card authentication service (Identity Check)
provided by 3D Secure.

MD Merchant-defined Data that is posted as a hidden field to the ACS URL. You can
use this data to identify the transaction on its return. This data is used to match
the response from the card-issuing bank to a customer’s specific order. Although
payment card companies recommend that you use the XID, you can also use data
such as an order number. This field is required, but including a value is optional.
The value has no meaning for the bank, and is returned to the merchant as is.

Merchant ID Data that must be uploaded for the Mastercard and Visa card authentication
process for each participating merchant. The Merchant ID is usually the bank
account number or it contains the bank account number. The data is stored on the
Directory Servers to identify the merchant during the enrollment check.

MPI Merchant Plug-In. The software used to connect to Directory Servers and to
decrypt the PARes.

Payer Authentication Using the Simple Order API | October 2019 230
Glossary

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

PAN Primary Account Number. Another term for a credit card number.

PAReq Payer Authentication Request. Digitally signed Base64-encoded payer

authentication request message, containing a unique transaction ID, that a
merchant sends to the card-issuing bank. Send this data without alteration or
decoding. Note that the field name has a lowercase “a” (PaReq), whereas the
message name has an uppercase “A” (PAReq).

PARes Payer Authentication Response. Compressed, Base64-encoded response from

the card-issuing bank. Pass this data into CyberSource for validation.

PARes Status Payer Authentication Response status. One-character length status passed back
by Visa and Mastercard that is required data for Asia, Middle East, and Africa
Gateway authorizations.

processor Financial entity that processes payments. Also see acquiring processor.

ProofXML CyberSource field that contains the VEReq and VERes for merchant storage.
Merchants can use this data for future chargeback repudiation.

ProtectBuy Trademarked name for the Diners Club and Discover card authentication
services.

request ID A 22- or 23-digit number that uniquely identifies each transaction sent to
CyberSource. Merchants should store this number for future reference.

risk-based Risk-based authentication is provided by the card-issuing bank. The card-issuing

authentication bank gathers a cardholder’s transaction data or leverages what data they have to
silently authenticate the cardholder based on the degree of risk that they perceive
the transaction to have. They base their risk assessment on factors such as
cardholder spending habits, order or product velocity, the device IP address, order
amount, and so on.

SafeKey Trademarked name for the American Express card authentication service.

Payer Authentication Using the Simple Order API | October 2019 231
Glossary

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

S (Continued)

SCMP API CyberSource’s legacy name-value pair API that has been superseded by the
Simple Order API.

Simple Order API CyberSource’s current API, which provides three ways to access CyberSource
services: name-value pair (NVP), XML, and SOAP.

Solo A debit card type that was owned by Maestro. It was permanently discontinued
March 31, 2011.

Switch See Maestro.

TermURL Termination URL on a merchant’s web site where the card-issuing bank posts the
payer authentication response (PARes) message.

UCAF Universal Cardholder Authentication Field. A Base64-encoded string sent back

with Mastercard Identity Check-enrolled cards that specifically identifies the
transaction with the issuing bank and Mastercard. Standard for collecting and
sending AAV data for Mastercard Identity Check transactions. See AAV.

UCAF collection Value of 1 or 2 that indicates whether a Mastercard cardholder has authenticated
indicator themselves or not.

validate CyberSource service for decoding and decrypting the PARes to determine
success. The validate service returns the needed values for authorization.

VEReq Verify Enrollment Request. Request sent to the Directory Servers to verify that a
card is enrolled in a card authentication service.

VERes Verify Enrollment Response. Response from the Directory Servers to the VEReq.

VERes enrolled Verify Enrollment Response enrolled. One-character length status passed back by
Visa and Mastercard that is required data for Asia, Middle East, and Africa
Gateway authorizations.

Payer Authentication Using the Simple Order API | October 2019 232
Glossary

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

V (Continued)

Visa A globally issued card that includes credit and debit cards. These cards start with
a 4. CyberSource identifies these cards as card type 001 for both credit and debit
cards. These cards participate in a card authentication service (Visa Secure)
provided by 3D Secure.

Visa Secure (VbV) Trademarked name for Visa’s card authentication service.

XID String used by both Visa and Mastercard which identifies a specific transaction on
the Directory Servers. This string value should remain consistent throughout a
transaction’s history.

Payer Authentication Using the Simple Order API | October 2019 233
INDEX
Index

AB C D E F G H I J K L M N O P Q R S T U V W X Y Z

Numerics base64 format, converting 30, 57

Brazil transactions (Visa Secure)
16- and 19-digit Visa cards 74
payerAuthEnrollService_MCC field 161
payerAuthEnrollService_mobilePhone
A field 162
AAV payerAuthEnrollService_
payerAuthValidateReply_ overridePaymentMethod field 163
ucafAuthenticationData field 180, 189 payerAuthEnrollService_productCode
aesk_attempted 95 field 165

AIBMS
commerce indicator, enrollment 177 C
commerce indicator, validation 186 card authorization with payer authentication 30,
American Express 38, 58
card tests 95 CAVV 176, 184
SafeKey 15
check enrollment service
validation results 95, 134
description 21
application results in Business Center 201 requesting 22
Asia, Middle East, and Africa Gateway credit card types accepted 155
payerAuthEnrollReply_veresEnrolled
field 181 D
payerAuthValidateReply_paresStatus
field 179, 188 data storage 207
authentication form detail report 212
URL 174 Diners Club
authorizations, expired or multiple 39 ProtectBuy 15
Diners Club card tests 107, 142
B Diners Club ProtectBuy
validation results 107
Barclays
commerce indicator, enrollment 177 dipb_attempted 113
commerce indicator, validation 186 Discover card tests 113, 142
Barclays, enrollment XID 182 Discover ProtectBuy
Barclays, validation XID 190 validation results 113

Payer Authentication Using the Simple Order API | October 2019 234
Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

E P
e-commerce indicator (ECI) 187 PAReq and PARes storage 207
enrollment data storage 207 PARes 232
example code password, enrolled card 21, 22, 23
payerAuthEnrollService 193, 194, 195 payer authentication details
enrolled card 202
F storage duration 202
unenrolled card 204
FDC Germany
commerce indicator, enrollment 177 payer authentication report
commerce indicator, validation 186 comparing to payment reports 211
frequency 208
interpreting 209
I
transactions reported 208
Identity Check 15 payer authentication search options 206
issuing bank payerAuthEnrollService
authentication form, URL 174 example code 193, 194, 195
CAVV 176, 184
pb_attempted 107
enrollment check 22, 62
proofXML storage 207
J
R
J/Secure 15
reason codes
J/Secure, validation results 101
validation 188
JCB
reports
J/Secure 15
detail 212
tests 101
detail, XML format 213
downloading summary report 209
M retention time limit 208
Maestro summary 208
(U.K. domestic) tests 83 risk-based authentication 225
tests 91
Maestro cards 15 S
Mastercard SafeKey 15
Identity Check 15
settling transactions, time limit 207
Mastercard Identity Check
storing payer authentication data 202
validation results 83
Streamline
Mastercard tests 83, 126
commerce indicator, enrollment 177
commerce indicator, validation 186
ECI raw 178, 187
summary report 208

Payer Authentication Using the Simple Order API | October 2019 235
Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

T Visa Vale Alimentacao (VSAVA) 163

Visa Vale Refeicao (VSAVR) 163
testing 70
Visa, 16- and 19-digit cards 74
tests
American Express 95
Diners Club cards 107, 142 X
Discover cards 113, 142 XID
JCB J/Secure 101 API field 182
Maestro cards 91 validate in reply 190
Mastercard cards 83, 126
XML report sample 222
Visa cards 74, 119
transaction details
enrollment check information 201
transaction history, retention time limit 208
transaction search
authenticated card 204
enrolled card 201
unenrolled card 204
using 201

U
unenrolled card, payer authentication
details 204

V
vbv_attempted 74
Verified by Visa
validation results 95
Visa
Visa Secure 15
Visa card tests 74, 119
Visa Secure
Brazilian transaction requirements, account
type 163
Brazilian transaction requirements, merchant
category code 161
Brazilian transaction requirements, mobile
phone 162
Brazilian transaction requirements, product
code 165
validation results 74

Payer Authentication Using the Simple Order API | October 2019 236

Solid Starts - First 100 Days
94% (18)
Solid Starts - First 100 Days
287 pages
Hourglass Workout Program by Luisagiuliet 2
76% (21)
Hourglass Workout Program by Luisagiuliet 2
51 pages
12 Week Program: Summer Body Starts Now
89% (45)
12 Week Program: Summer Body Starts Now
70 pages
Read People Like A Book by Patrick King-Edited
61% (69)
Read People Like A Book by Patrick King-Edited
12 pages
Livingood, Blake - Livingood Daily Your 21-Day Guide To Experience Real Health
77% (13)
Livingood, Blake - Livingood Daily Your 21-Day Guide To Experience Real Health
260 pages
Facial Gains Guide (001 081)
91% (45)
Facial Gains Guide (001 081)
81 pages
Cheat Code To The Universe
94% (77)
Cheat Code To The Universe
34 pages
Curse of Strahd
95% (467)
Curse of Strahd
258 pages
The Psychiatric Interview - Daniel Carlat
91% (34)
The Psychiatric Interview - Daniel Carlat
473 pages
The Borax Conspiracy
91% (57)
The Borax Conspiracy
14 pages
The Secret Language of Attraction
86% (107)
The Secret Language of Attraction
278 pages
How To Develop and Write A Grant Proposal
83% (541)
How To Develop and Write A Grant Proposal
17 pages
Workbook For The Body Keeps The Score
88% (52)
Workbook For The Body Keeps The Score
111 pages
Donald Trump & Jeffrey Epstein Rape Lawsuit and Affidavits
83% (1016)
Donald Trump & Jeffrey Epstein Rape Lawsuit and Affidavits
13 pages
KamaSutra Positions
78% (69)
KamaSutra Positions
55 pages
KamaSutra Positions
69% (83)
KamaSutra Positions
55 pages
7 Hermetic Principles
93% (28)
7 Hermetic Principles
3 pages
27 Feedback Mechanisms Pogil Key
75% (12)
27 Feedback Mechanisms Pogil Key
6 pages
36 Questions That Lead To Love
91% (35)
36 Questions That Lead To Love
3 pages
Sample Mental Health Progress Note
96% (47)
Sample Mental Health Progress Note
3 pages
How 2 Setup Trust
97% (307)
How 2 Setup Trust
3 pages
100 Questions To Ask Your Partner
80% (35)
100 Questions To Ask Your Partner
2 pages
The 36 Questions That Lead To Love - The New York Times
94% (34)
The 36 Questions That Lead To Love - The New York Times
3 pages
Satanic Calendar
25% (55)
Satanic Calendar
4 pages
The 36 Questions That Lead To Love - The New York Times
95% (21)
The 36 Questions That Lead To Love - The New York Times
3 pages
Jeffrey Epstein39s Little Black Book Unredacted PDF
75% (12)
Jeffrey Epstein39s Little Black Book Unredacted PDF
95 pages
ALCHEMIST
64% (14)
ALCHEMIST
4 pages
1001 Songs
71% (69)
1001 Songs
1,798 pages
Zodiac Sign & Their Most Common Addictions
63% (30)
Zodiac Sign & Their Most Common Addictions
9 pages
The 4 Hour Workweek, Expanded and Updated by Timothy Ferriss - Excerpt
23% (954)
The 4 Hour Workweek, Expanded and Updated by Timothy Ferriss - Excerpt
38 pages
Payer - Authentication - SO - API Mar20
No ratings yet
Payer - Authentication - SO - API Mar20
241 pages
3d Secure Registration PDF
No ratings yet
3d Secure Registration PDF
4 pages
PHP Script For Paypal Website Standard Payment Method
100% (1)
PHP Script For Paypal Website Standard Payment Method
16 pages
EMV Third Edition
From Everand
EMV Third Edition
Gerardus Blokdyk
No ratings yet
David Case Study Draft v3.0
No ratings yet
David Case Study Draft v3.0
5 pages
Karen's Case Study
100% (1)
Karen's Case Study
12 pages
The Art of Application Performance Testing by Ian Molyneaux
No ratings yet
The Art of Application Performance Testing by Ian Molyneaux
12 pages
Test Strategies For Mobile Device Applications
No ratings yet
Test Strategies For Mobile Device Applications
24 pages
Security in Computing - Lecture Notes, Study Material and Important Questions, Answers
No ratings yet
Security in Computing - Lecture Notes, Study Material and Important Questions, Answers
38 pages
Web Service API: Integration Guide
No ratings yet
Web Service API: Integration Guide
124 pages
API Documentation October 18, 2016
No ratings yet
API Documentation October 18, 2016
37 pages
MasterCard SecureCode Merchant Implementation Guide 03 January 2014 Version
No ratings yet
MasterCard SecureCode Merchant Implementation Guide 03 January 2014 Version
73 pages
PayPal Virtual Terminal User Guide
No ratings yet
PayPal Virtual Terminal User Guide
48 pages
3D SECURE V2 Manual Ver 1.0.5 EN
No ratings yet
3D SECURE V2 Manual Ver 1.0.5 EN
47 pages
Bug Bounty Funshop by Prateek Tiwari
No ratings yet
Bug Bounty Funshop by Prateek Tiwari
72 pages
JavaCard in Smart World.v4
No ratings yet
JavaCard in Smart World.v4
38 pages
3D Secure
No ratings yet
3D Secure
10 pages
Cyber Crime Hacking
No ratings yet
Cyber Crime Hacking
21 pages
VISA Ais Guide Stepspcicompliant
No ratings yet
VISA Ais Guide Stepspcicompliant
15 pages
R4 Discover D-PASU.S.terminalGuide2017
No ratings yet
R4 Discover D-PASU.S.terminalGuide2017
40 pages
Visa Pin Security Program Auditors Guide
No ratings yet
Visa Pin Security Program Auditors Guide
97 pages
4577XXXXXXXXXX19 - 13 07 2023
No ratings yet
4577XXXXXXXXXX19 - 13 07 2023
3 pages
Chip Card Testing and Approval Requirements V8.0
No ratings yet
Chip Card Testing and Approval Requirements V8.0
74 pages
Data Mining in Creditcard
No ratings yet
Data Mining in Creditcard
5 pages
SF Dump
No ratings yet
SF Dump
17 pages
Static Residential Proxiesidpkf PDF
No ratings yet
Static Residential Proxiesidpkf PDF
10 pages
Debit Cards User Guide
No ratings yet
Debit Cards User Guide
24 pages
Payment Gateways Ubl
No ratings yet
Payment Gateways Ubl
1 page
General Data Breach
No ratings yet
General Data Breach
24 pages
MuhammadShahmeerAmir Tutorial BreakingBarriers
100% (1)
MuhammadShahmeerAmir Tutorial BreakingBarriers
117 pages
NFC Standards Payments Narada
No ratings yet
NFC Standards Payments Narada
25 pages
Cyber Crime Class
No ratings yet
Cyber Crime Class
32 pages
Dark_Web
No ratings yet
Dark_Web
4 pages
Raw PHP
No ratings yet
Raw PHP
7 pages
3-D Secure 2.0 - ExternalFAQs - Vfinal PDF
No ratings yet
3-D Secure 2.0 - ExternalFAQs - Vfinal PDF
9 pages
Chargeback Guide
0% (1)
Chargeback Guide
716 pages
Lootbits
No ratings yet
Lootbits
1 page
Card CHIP EMV Tags TLV Decoder Utility - Neapay
No ratings yet
Card CHIP EMV Tags TLV Decoder Utility - Neapay
6 pages
Test Case CC As Payment
No ratings yet
Test Case CC As Payment
2 pages
Raboplus Account Opening Checklist
No ratings yet
Raboplus Account Opening Checklist
3 pages
Emv TVR
No ratings yet
Emv TVR
19 pages
Amex WS PIP Terminal Interface Spec ISO Apr2011
No ratings yet
Amex WS PIP Terminal Interface Spec ISO Apr2011
232 pages
HSM 3des Key Pairs Generator and Composer For Combining Keys
No ratings yet
HSM 3des Key Pairs Generator and Composer For Combining Keys
5 pages
8-Digit BIN and 11-Digit Account Range FAQ
No ratings yet
8-Digit BIN and 11-Digit Account Range FAQ
10 pages
Visa Chip Simplifying Implementation
No ratings yet
Visa Chip Simplifying Implementation
2 pages
Paytm Powered OTP Bin List 59d48f08b7
No ratings yet
Paytm Powered OTP Bin List 59d48f08b7
8 pages
Payu Implementation Manual Template en
No ratings yet
Payu Implementation Manual Template en
84 pages
Log 2022 02 08
No ratings yet
Log 2022 02 08
25 pages
PFP ExpressCheckout PP
No ratings yet
PFP ExpressCheckout PP
84 pages
What Is "Card-Not-Present" Fraud?
100% (1)
What Is "Card-Not-Present" Fraud?
2 pages
D B: W U W "C " R: ATA Reaches Hat The Nderground Orld of Arding Eveals
No ratings yet
D B: W U W "C " R: ATA Reaches Hat The Nderground Orld of Arding Eveals
33 pages
Visa Secure August 2021 Release Notes 1.0
No ratings yet
Visa Secure August 2021 Release Notes 1.0
9 pages
MasterCard Authentication Guide Europe
No ratings yet
MasterCard Authentication Guide Europe
75 pages
All Live Authorize - Net Sites
No ratings yet
All Live Authorize - Net Sites
10 pages
New Vulnerabilities in Public Transport Schemes For Apple Pay GPay and Samsung Pay
No ratings yet
New Vulnerabilities in Public Transport Schemes For Apple Pay GPay and Samsung Pay
34 pages
EBC - Transaction Management - Transaction Details (00 IDR)
No ratings yet
EBC - Transaction Management - Transaction Details (00 IDR)
4 pages
Nti Isaac Kofi Atm
100% (1)
Nti Isaac Kofi Atm
126 pages
CC Merged
No ratings yet
CC Merged
51 pages
Non-Collateral Personal Loan - Google Search
No ratings yet
Non-Collateral Personal Loan - Google Search
13 pages
Module 15: Programming in C++: Partha Pratim Das
No ratings yet
Module 15: Programming in C++: Partha Pratim Das
33 pages
This Study Resource Was: Consolidated Balance Summary
No ratings yet
This Study Resource Was: Consolidated Balance Summary
8 pages
VSDC Ca Service Description
No ratings yet
VSDC Ca Service Description
26 pages
Paypal
No ratings yet
Paypal
24 pages
Copy Me Popular
From Everand
Copy Me Popular
Neil Smith
No ratings yet
Cybersource Payer Authentication: Using The Simple Order API
No ratings yet
Cybersource Payer Authentication: Using The Simple Order API
261 pages
1) Full Refund For Installment
No ratings yet
1) Full Refund For Installment
2 pages
Contract Agreement New
No ratings yet
Contract Agreement New
2 pages
How To Extract HP ALM Test Script
No ratings yet
How To Extract HP ALM Test Script
3 pages
Singapore
No ratings yet
Singapore
3 pages
ER Order
No ratings yet
ER Order
3 pages
Bach Flower Alphabetical PDF
No ratings yet
Bach Flower Alphabetical PDF
2 pages
GPAP Connectivity Test Plan For CyberSource 3DS
No ratings yet
GPAP Connectivity Test Plan For CyberSource 3DS
1 page
Member: 23245803
No ratings yet
Member: 23245803
2 pages
3Ds Connectivity Test
No ratings yet
3Ds Connectivity Test
5 pages
ContestAPAC Testing
No ratings yet
ContestAPAC Testing
8 pages
Test Result - January Promo 2019
No ratings yet
Test Result - January Promo 2019
19 pages
Write Up Pepssi
No ratings yet
Write Up Pepssi
18 pages
Access 1
No ratings yet
Access 1
7 pages
Prop. Kaltim Undangan Sosialisasi Asesmen
No ratings yet
Prop. Kaltim Undangan Sosialisasi Asesmen
12 pages
F8T User Manual
No ratings yet
F8T User Manual
27 pages
Id Privacy Full
No ratings yet
Id Privacy Full
179 pages
Bio Metric Project
No ratings yet
Bio Metric Project
8 pages
E-Commerce Law in Pakistan
No ratings yet
E-Commerce Law in Pakistan
7 pages
ATC88 Course & Exam Eram Self
No ratings yet
ATC88 Course & Exam Eram Self
4 pages
2021-03-23-11 Moonton EMPAS
No ratings yet
2021-03-23-11 Moonton EMPAS
367 pages
DSSSBOnline
No ratings yet
DSSSBOnline
2 pages
Wa0004.
No ratings yet
Wa0004.
1 page
Eap Testing
No ratings yet
Eap Testing
7 pages
Shiva Aadhaar (2)
No ratings yet
Shiva Aadhaar (2)
1 page
Jurat 4
No ratings yet
Jurat 4
1 page