API Overview

Unified Checkout Developer Guide
- Recent Revisions to This Document

Introduction to Unified Checkout

Unified Checkout Quick Start
- Step 1: Enable Unified Checkout
- Step 2: Set Up the Server-Side Component
- Step 3: Set Up the Client-Side Component
- Step 4: Configure Unified Checkout
- Step 5: Test Your Unified Checkout Integration

Unified Checkout Flow

Payment Methods
- Cards
  - Pay with Token
- eCheck/ACH Service
  - Enrolling in eCheck/ACH Services
  - Pay with eCheck/ACH Service UI
- Digital Wallets
  - Apple Pay
    - Enrolling in Apple Pay
    - Preparing a Device for Testing Apple Pay on Unified Checkout
    - Apple Pay UI
  - Google Pay
    - Enrolling in Google Pay
    - Managing Google Pay Authentication Types
    - Google Pay UI
  - Click to Pay
    - Enabling Click to Pay
      - Set Up Customer Authentication for Visa Click to Pay
      - Click to Pay Customer Authentication
    - Click to Pay UI
    - Click to Pay UI Guidelines
    - Click to Pay UI Examples
  - Paze
    - Paze UI
- Alternative Payment Methods
  - Online Bank Transfers
    - Bancontact
    - DragonPay
    - Tink Pay By Bank
    - iDeal
    - MyBank
    - Multibanco
    - Przelewy24|P24
    - Verify Status for Online Bank Transfers
    - Verify Status for Online Bank Transfers (Tink Pay By Bank)
    - Handle Responses
  - Buy Now, Pay Later
    - Afterpay
    - Verify Status for Afterpay
    - Handle Responses
    - Captures
  - Post-Pay Reference Payments
    - Konbini
    - Verify Status for Post-Pay Reference
    - Handle Responses
  - Alternative Payment Wallets
    - PayPal
    - Venmo
    - Verify Status for PayPal and Venmo
    - Handle Responses
    - Captures

Server-Side Set Up

Client-Side Set Up
- Loading the JavaScript Library
- Complete Integration Examples

Configuration
- Configure the Unified Checkout Merchant Experience
  - Enable Unified Checkout
  - Configure Payment Options
  - Customize the Unified Checkout Look and Feel
  - Look and Feel UI Examples
  - Configure Customer Data and Payment Flow
  - Capture Context Fields in the Business Center
  - Manage Permissions
    - Managing Permissions as a Direct Merchant
    - Managing Permissions as a Portfolio Administrator
- Process Payments with Unified Checkout
- Webhooks Support

Transient Tokens
- Transient Token Format
- Token Verification
- Dual-Branded Cards
- Authorizations with a Transient Token

Test Your Configuration
- Unified Checkout Test Cards
- Visa and Mastercard Click to Pay Test Cards
- Test Cards for Authentication by Click to Pay
- Echeck Test Values
- Test Authentication
- Handle Errors
- Reason Codes

Payment Details API

JavaScript API Reference

Update to Unified Checkout Version 1
- Update Reason Codes
- Version 1 Update Checklist

Appendix
- JSON Web Tokens
- Supported Countries for Digital Payments
- Supported Locales
- Security Recommendations
- PCI Compliance

VISA Platform Connect: Specifications and Conditions for Resellers/Partners

On This Page

completeMandate.consumerAuthentication

This field determines whether Payer Authentication should be used. Set this field to

true

and include

completeMandate.type

in your request to run Payer Authentication. When this field set to

true

, Payer Authentication runs. When this field is set to

false

or is not included in the request, Payer Authentication does not run.

When you use Unified Checkout with Payer Authentication, device data is collected through Payer Authentication setup and Unified Checkout completes all calls that are associated with Payer Authentication.

For information about challenge codes, see

consumerAuthenticationInformation.challengeCode

in the REST API Field Reference. Unified Checkout supports 3-D Secure data only when your payment processor supports it. For information see Visa Data Only in the Payer Authentication Developer Guide
.

To test Payer Authentication, you must use Payer Authentication test cards. See Test Cases for 3-D Secure 2.x in the Payer Authentication Developer Guide
.

Consumer authentication is available for these card types:

American Express

Cartes Bancaires

China UnionPay

Diners Club

Discover

EFTPOS

ELO

Jaywan

JCB

mada

Maestro

Mastercard

Visa

Consumer authentication runs for these payment methods when they are supported in your Unified Checkout configuration:

PANENTRY

CLICKTOPAY

when the transaction is not authenticated with Click to Pay.

GOOGLEPAY

when the transaction is not authenticated with Google Pay.

Unified Checkout does not attempt to authenticate for Click to Pay and Google Pay if the transaction has already been authenticated when it is received by Unified Checkout. For information about testing authentication, see Test Authentication.

Back to top