API Overview

Recent Revisions to This Document

Payer Authentication Developer Guide

Introduction to Payer Authentication
- Why Payer Authentication Is Needed
- EMV 3-D Secure 2.0
- Payer Authentication Customer Workflow
- Payer Authentication Merchant Workflow
- Acquirer Information
- Enable Merchant Account for EMV 3-D Secure
- Payer Authentication Configuration Testing
- Request Endpoints
- Payer Authentication Integrations

Implementing Direct API for Payer Authentication
- Prerequisites
- After Implementation and Before Go Live

Step 1: Setup Service
- Request Fields
- Important Response Fields

Step 2: Device Data Collection
- Which Device Data is Collected
- Building the Iframe
- Initiating the Device Data Collection Iframe
- Submitting the Device Data Collection Iframe
- Receiving the Device Data Collection URL Response

Step 3: Payer Authentication Check Enrollment Service
- Request Fields
- Interpreting the Check Enrollment Response
- Important Response Fields

Step 4: Step-Up Iframe
- Building the Iframe Parameters
- Creating the Iframe
- Invoking the Iframe
- Receiving the Step-Up Results

Step 5: Payer Authentication Validation Service
- Request Fields
- Interpreting the Validation Response
- Redirecting Customers to Pass or Fail Message Page

Combining the Authentication and the Authorization Services
- Combining Check Enrollment and the Authorization Services
  - Check Enrollment Response Fields and Their Equivalent Authorization Request Fields
- Combining the Validation and the Authorization Services
  - Validation Fields and their Equivalent Authorization Fields

Implementing SDK Payer Authentication
- Implementation Overview
- Process Flow for SDK Integration
- Prerequisites for SDK Implementation
  - Credentials/API Keys
    - Generating your API Key:
- What Mobile Device Data is Collected
- Using the Android SDK
  - Updating the Gradle Build Properties
  - Configuring the Android SDK
  - Setting Up the Initial Call
- Using the iOS SDK
  - Downloading and Importing the SDK
  - Configuring Your Build Environment
  - Configuring the iOS SDK
  - Setting Up the Initial Call
- Running Payer Authentication with SDK
  - Requesting the Check Enrollment Service (SDK)
  - Interpreting the Response
  - Authenticating Enrolled Cards
    - Calling Cardinal.cca_continue (Android SDK)
    - Calling Cardinal session continue (iOS SDK)
    - Receiving the Authentication Results
  - Requesting the Validation Service
    - Interpreting the Response
    - Redirecting Customers to the Message Page

Testing Payer Authentication
- Testing Process
  - Enrollment Check Response Fields
  - Authentication Validation Response Fields
- Test Cases for 3-D Secure 2.x
  - Test Case 2.1: Successful Frictionless Authentication
  - Test Case 2.2: Unsuccessful Frictionless Authentication
  - Test Case 2.3: Attempts Processing Frictionless Authentication
  - Test Case 2.4: Unavailable Frictionless Authentication
  - Test Case 2.5: Rejected Frictionless Authentication
  - Test Case 2.6: Authentication Not Available on Lookup
  - Test Case 2.7: Enrollment Check Error
  - Test Case 2.8: Time Out
  - Test Case 2.9: Bypassed Authentication
  - Test Case 2.10a: Successful Step-Up Authentication
  - Test Case 2.11a: Unsuccessful Step-Up Authentication
  - Test Case 2.12a: Unavailable Step-Up Authentication
  - Test Case 2.14: Require Method URL
- Payer Authentication Exemption Test Cases
  - Test Case 1a: Initial/First Recurring Transaction: Fixed Amount
  - Test Case 2a: Card Authentication Failed
  - Test Case 2b: Suspected Fraud
  - Test Case 2c: Cardholder Not Enrolled in Service
  - Test Case 2d: Transaction Timed Out at the ACS
  - Test Case 2e: Non-Payment Transaction Not Supported
  - Test Case 2f: 3RI Transaction Not Supported
  - Test Case 3a: Transaction Risk Analysis Exemption: Low Value: Mastercard EMV 3-D Secure 2.1 and 2.2
  - Test Case 3b: Transaction Risk Analysis: Low Value: Visa
  - Test Case 3c: Transaction Risk Analysis: Low Value: Discover
  - Test Case 3d: Acquirer Transaction Risk Analysis: Cartes Bancaires
  - Test Case 4a: Trusted Beneficiary Prompt for Trustlist
  - Test Case 4b: Utilize Trusted Beneficiary Exemption
  - Test Case 5a-1: Identity Check Insights (ScoreRequest = N)
  - Test Case 5a-2: Identity Check Insights (ScoreRequest = Y)
- HTTP Status Codes

Payer Authentication Use Cases
- Use Case: Collecting Device Data
  - Required Fields for Collecting Device Data
  - Optional Fields for Collecting Device Data
  - Simple Order Example: Setting Up with Payer Authentication
- Use Case: Collecting Device Data Using a Stored Payment Credential (TMS Token)
  - Required Fields for Collecting Device Data Using a Stored Payment Credential (TMS Token)
  - Optional Fields for Collecting Device Data
  - Simple Order Example: Setting Up with Payer Authentication Using a Token
- Use Case: Collecting Device Data Using Digital Payment (Google Pay)
  - Required Fields for Collecting Device Data
  - Optional Fields for Collecting Device Data
  - Simple Order Example: Setting Up Payer Authentication Using Google Pay
- Use Case: Checking Enrollment in Payer Authentication
  - Required Fields for Checking Enrollment in Payer Authentication
  - Optional Fields for Checking Enrollment in Payer Authentication
  - Simple Order Example: Check Enrollment
- Use Case: Checking Enrollment in Payer Authentication While Using a Stored Payment Credential (TMS Token)
  - Required Fields for Checking Enrollment in Payer Authentication While Using a Stored Payment Credential (TMS Token)
  - Optional Fields for Checking Enrollment in Payer Authentication
  - Simple Order Example: Checking Enrollment Using a Token
- Use Case: Checking Enrollment in Payer Authentication Using Digital Payment (Google Pay)
  - Required Fields for Checking Enrollment in Payer Authentication
  - Optional Fields for Checking Enrollment in Payer Authentication
  - Simple Order Example: Checking Enrollment in Payer Authentication Using Google Pay
- Use Case: Validating Step-Up
  - Required Fields for Validating Step-Up
  - Optional Fields for Validating Step-Up
  - Simple Order Example: Validating the Challenge
- Use Case: Validating Step Up Using Digital Payment (Google Pay)
  - Required Fields for Validating Step-Up
  - Optional Fields for Validating Step-Up
  - Simple Order Example: Validating the Challenge When Using Google Pay
- Use Case: Validating and Authorizing a Transaction
  - Required Fields for Processing an Authorization Using Visa Secure
  - Optional Fields for Validating Step-Up
  - Simple Order Example: Processing an Authorization Using Visa Secure

Website Modification Reference
- Website Modification Checklist
- EMV 3-D Secure Services Logos
- Informational Message Examples

Alternate Methods for Device Data Collection
- Device Data Collection Overview
  - Prerequisites
  - Endpoints
- Collecting Device Data
  - Card BIN in JWT
  - Card BIN as a POST Parameter Plus JWT

Upgrading Your Payer Authentication Implementation
- Benefits
- PSD2 Impact
  - Mandates
- Recommended Integration
- Migrating from EMV 3-D Secure 1.x to 2.x FAQ

Payer Authentication Transaction Details in the Smartpay Fuse Portal
- Payer Authentication Search
- Storing Payer Authentication Data
- Searching for Payer Authentication Details
  - Enrolled Card
    - Enrollment Check
    - Authentication Validation
  - Card Not Enrolled
    - Transaction Details

Payer Authentication Reports
- Payer Authentication Summary Report
  - Downloading the Report
  - Matching the Report to the Transaction Search Results
  - Interpreting the Report
  - Comparing Payer Authentication and Payment Reports
- Payer Authentication Detail Report
  - Report Element
  - PayerAuthDetail Element
  - ProofXML Element
  - VEReq Element
  - VERes Element
  - PAReq Element
  - PARes Element
  - AuthInfo Element
  - Report Examples

Reason Codes

Glossary

Recent Revisions to This Document

24.04

Corrected Test Case Card Number: For Test Case 2.5: Rejected Frictionless Authentication by the Issurer, the test card numbers for Mastercard 2.2.0 and Mastercard (mada) were updated. See Test Case 2.5: Rejected Frictionless Authentication.
Added list of HTTP Status Codes: Added a list of HTTP status codes to the testing section. For more information, see HTTP Status Codes.
Added use cases for setup and enrollment check with tokens.: Updated the use cases to include using tokens during payer authentication. For more information, see Use Case: Collecting Device Data Collection Using Stored Payment Credential (TMS Token) and Use Case: Checking Enrollment in Payer Authentication While Using a Stored Payment Credential (TMS Token).
Test cases for mada are supported.: Updated the test cases for the 3-D Secure 2.x section to include test results for the mada card. For more information, see Test Cases for 3-D Secure 2.x.
Highlighted API fields specific to Meeza card usage: Added API fields to the country-specific section for the setup and check enrollment use cases that are required when using the Meeza card. For more information, see Use Case: Setting Up Payer Authentication and Use Case: Checking Enrollment in Payer Authentication.

24.03

Updated the test cases to mention that the Meeza card is supported for payer authentication as card type 067, and should be tested using Mastercard numbers. For more information, see Test Cases for 3-D Secure 2.x.

24.02

Added a short description of the other products in the risk management portfolio that work with payer authentication. For more information, see Introduction to Payer Authentication.

24.01

Updated the date that a Visa Secure 3-D Secure mandate that changes some conditionally optional fields to required fields occurs. The effective date was pushed back by six months to August 12, 2024. For more information, see Optional Fields for Checking Enrollment in Payer Authentication.

Back to top