API Overview

Digital Accept Secure Integration Developer Guide
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introducing Digital Accept Secure Integration Product Suite

Flex API v2
- Flex API v2 Integration Task List
- Generating the Capture Context
  - REST Example: Generating the Capture Context
- Validating the Capture Context
- Securing Payment Information
- Tokenizing Payment Information
- Validate the Transient Token
- Using the Transient Token to Process a Payment

Microform Integration v2
- How It Works
- PCI Compliance
- Getting Started
- Accept Card Information
  - Server-Side Setup
    - Capture Context
    - Creating the Server-Side Capture Context
    - Validating the Server-Side Capture Context
  - Client-Side Setup
  - Transient Tokens for Accepting Card Information
    - Transient Token Time Limit
    - Transient Token Response Format
    - Validating the Transient Token
    - Using the Transient Token to Process a Payment
- Accept eCheck Information
  - Server-Side Setup
    - Capture Context
    - Creating the Server-Side Capture Context
    - Validating the Server-Side Capture Context
  - Client-Side Setup
  - Transient Tokens for Accepting eCheck Information
    - Transient Token Time Limit
    - Transient Token Response Format
    - Validating the Transient Token
- Next Steps
  - Styling
  - Events
  - Security Recommendations
- Reference
  - JavaScript API Reference
    - Class: Field
    - Module: FLEX
    - Class: Microform
    - Class: MicroformError
    - Global
  - Capture Context API
    - REST Example: Requesting the Capture Context
  - Getting Started Examples
  - JSON Web Tokens
  - Browser Support
  - PCI DSS Guidance
  - Test Card Numbers

Introduction to Unified Checkout
- Unified Checkout Flow
  - Enabling Unified Checkout in the Business Center
- Server-Side Set Up
  - Capture Context
- Client-Side Set Up
  - Loading the JavaScript Library and Invoking the Accept Function
    - JavaScript Example: Initializing the SDK
    - JavaScript Example: Displaying the Button List
    - JavaScript Example: Processing a Payment
  - Complete Integration Examples
    - JavaScript Example: Setting Up with Full Sidebar
    - JavaScript Example: Setting Up with the Embedded Component
- Transient Tokens
  - Transient Token Format
    - Example: Transient Token Format
  - Token Verification
  - Support for Dual-Branded Cards
- Authorizations with a Transient Token
  - REST Example: Requesting an Authorization with a Transient Token
- Capture Context API
  - Features
  - Requesting the Capture Context
    - Required Fields for Requesting the Capture Context
    - REST Example: Requesting the Capture Context
  - Validating the Capture Context
- Payment Details API
  - REST Example: Retrieving Transient Token Payment Details
- JavaScript API Reference
  - Class: Accept
  - Class: AcceptError
  - Class: UnifiedPayments
- Unified Checkout Configuration
  - Enable Digital Payments
    - Enrolling in Apple Pay
    - Preparing a Device for Testing Apple Pay on Unified Checkout
    - Enabling Click to Pay
    - Enrolling in Google Pay
    - Managing Google Pay Authentication Types
    - Enrolling in Echeck/ACH Services
  - Manage Permissions
    - Managing Permissions as a Direct Merchant
    - Managing Permissions as a Portfolio Administrator
- Test Your Unified Checkout Configuration
  - Test Payment Details
  - Customer Authentication
    - Set Up Customer Authentication for Visa
    - Authentication Methods
- Unified Checkout Appendix
  - Unified Checkout UI
    - Apple Pay UI
    - Click to Pay UI
    - Google Pay UI
    - Manual Payment Entry UI
    - Pay with Bank Account UI
    - Paze UI
  - JSON Web Tokens
  - Client Version History
  - Webhooks Support
  - Unified Checkout Integration Examples
    - Unified Checkout with Authorization
      - Example: Unified Checkout with Authorization
    - Unified Checkout with Sale
      - Example: Unified Checkout with Sale
    - Unified Checkout with Sale and Decision Manager
      - Example: Unified Checkout with Sale and Decision Manager
    - Unified Checkout without Service Orchestration
      - Example: Unified Checkout without Service Orchestration
    - Echeck Payment with a Transient Token
      - Example: Echeck Payment with a Transient Token
  - Supported Countries for Digital Payments
    - Supported Countries for Digital Payments A-D
    - Supported Countries for Digital Payments E-K
    - Supported Countries for Digital Payments L-R
    - Supported Countries for Digital Payments S-Z
  - Supported Locales
  - Reason Codes

Introduction to the Click to Pay Drop-In UI
- Click to Pay Customer Workflows
  - Recognized Click to Pay Customer
  - Unrecognized Click to Pay Customer
  - Guest Customer
- Click to Pay Drop-In UI Flow
  - Enabling Unified Checkout in the Business Center
- Server-Side Set Up
  - Capture Context
- Client-Side Set Up
  - Loading the JavaScript Library and Invoking the Accept Function
    - JavaScript Example: Initializing the SDK
    - JavaScript Example: Displaying the Button List
  - Adding the Payment Application and Payment Acceptance
    - JavaScript Example: Setting Up with Full Sidebar
    - JavaScript Example: Setting Up with the Embedded Component
- Transient Tokens
  - Transient Token Format
  - Token Verification
  - Support for Dual-Branded Cards
- Capture Context API
  - Features
  - Requesting the Capture Context
    - Required Fields for Requesting the Capture Context
    - REST Example: Requesting the Capture Context
  - Validating the Capture Context
- Payment Details API
  - Required Field for Retrieving Transient Token Payment Details
  - REST Example: Retrieving Transient Token Payment Details
- Payment Credentials API
  - Required Field for Retrieving Payment Credentials
  - REST Example: Retrieving Payment Credentials
- Unified Checkout Configuration
  - Upload Your Encryption Key
    - Generate a Public Private Key Pair
    - Uploading Your Key Pair
  - Enable Click to Pay
    - Enabling Click to Pay
  - Manage Permissions
    - Managing Permissions as a Direct Merchant
    - Managing Permissions as a Portfolio Administrator
- Click to Pay Appendix
  - Client Version History
  - JSON Web Tokens
  - Reason Codes
  - Supported Countries for Click to Pay
  - Supported Locales
  - Click to Pay UI

Processing Authorizations with a Transient Token
- Authorization with a Transient Token
  - Required Field for an Authorization with a Transient Token
  - REST Interactive Example: Authorization with a Transient Token
  - REST Example: Authorization with a Transient Token
- Authorization and Creating TMS Tokens with a Transient Token
  - Required Fields for an Authorization and Creating TMS Tokens with a Transient Token
  - REST Interactive Example: Authorization and Creating TMS Tokens with a Transient Token
  - REST Example: Authorization and Creating TMS Tokens with a Transient Token

On This Page

`Unified Checkout` Flow

To integrate Unified Checkout into your platform, you must follow several integration steps. This section gives a high-level overview of how to integrate and launch Unified Checkout on your webpage and process a transaction using the data that Unified Checkout collects for you. You can find the detailed specifications of the APIs later in this document.

The integration flow consists of four events:

You send a server-to-server API request for a capture context. This request is fully authenticated and returns a JSON Web Token (JWT) that is necessary in order to invoke the frontend JavaScript library. For information on setting up the server side, see Server-Side Set Up.

You invoke the Unified Checkout JavaScript library using the JWT response from the capture context request. For information on setting up the client side, see Client-Side Set Up.

You process the payment through the Unified Checkout complete mandate feature.

Optional:
Capture the payment response through webhook notifications.

Information that is captured by Unified Checkout, including the billing and shipping address, can be retrieved using the payment details API.

The figure below shows the Unified Checkout payment flow.

Diagram that shows the sequence and flow of a Unified Checkout payment. — Unified Checkout Payment Flow

For more information on the specific APIs referenced, see these topics:

Capture Context API

Payment Details API

Enabling `Unified Checkout` in the `Business Center`

To begin using Unified Checkout, you must first ensure that your merchant ID (MID) is configured to use the service and that any payment methods you intend to use are properly set up.

Log in to the Business Center:

Test URL:

https://businesscentertest.cybersource.com/ebc2

Production URL:

https://businesscenter.cybersource.com

If you are unable to access this page, contact your sales representative.

In the Business Center, go to the left navigation panel and choose

Payment Configuration

>

Unified Checkout

.

You can configure various payment methods such as Apple Pay, Click to Pay, and Google Pay. Click

Set up

and follow the instructions for your selected payment methods. When payment methods are enabled, they appear on the payment configuration page.

Manage Unified Checkout Digital Payments Solutions

Click

Manage

to edit your existing payment method configurations or enroll in new payment methods as they are released.

Back to top