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
- Establishing a Payment Session with a Capture Context
  - REST Example: Establishing a Payment Session with a Capture Context
- Validating the JSON Web Token
  - Retrieving the Public Key ID
  - Retrieving the Public Key
  - JAVA Example: Validating the Transient Token
- Populating the JSON Web Token with Customer Information
  - Constructing the JSON Payload
  - Generating a JSON Web Encryption Data Object
  - Populating the Token Request

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 Paymemt
  - Accept Check 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 Check 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
    - Events
    - Global
  - Capture Context API
    - REST Example: Requesting the Capture Context
  - Getting Started Examples
  - JSON Web Tokens
  - Browser Support
  - PCI DSS Guidance

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
  - 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
- Authorizations with a Transient Token
  - REST Example: Requesting an Authorization with a Transient Token
- Capture Context API
  - REST Example: Requesting the Capture Context
- Payment Details API
  - REST Example: Retrieving Transient Token Payment Details
- 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
  - Manage Permissions
    - Managing Permissions as a Direct Merchant
    - Managing Permissions as a Portfolio Administrator
- 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
- JavaScript API Reference
  - Class: Accept
  - Class: AcceptError
  - Class: UnifiedPayments
- 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
  - 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
  - REST Example: Requesting 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
- Supported Countries for Click to Pay
- Supported Locales

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

`Flex API`

The Flex API enables merchants to securely accept customer payment information captured within a server-side application using a set of APIs. These APIs protect your customer's primary account number (PAN), card verification number (CVN), and other payment information by embedding it within a transient token. This allows payment data to be stored and transported and complies with the Payment Card Industry Data Security Standard (PCI DSS) policies and procedures. These transient tokens can be validated by the receiver to ensure the data integrity and protect against data injection attacks.

WARNING

Flex API is intended for server-side applications only. Do not use the Flex API in client-side applications. To add secure payments directly into client-side code, use Unified Checkout.

IMPORTANT

Each request that you send to Cybersource requires header information. For information about constructing the headers for your request, see the REST Getting Start Developer Guide
.

How It Works

Follow these steps to capture payments using the Flex API:

Establish a payment session with a predefined customer context.

Validate the JSON Web Token.

Populate the JSON Web Token with customer information.

Customer Context

An important benefit of the Flex API is managing Personal Identifiable Information (PII). You can set up your customer context to include all PII associated with transactions, protecting this information from third parties.

Back to top