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 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
  - 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
    - Managing Google Pay Authentication Types
  - Manage Permissions
    - Managing Permissions as a Direct Merchant
    - Managing Permissions as a Portfolio Administrator
- Test Your Unified Checkout Configuration
  - Customer Authentication
    - Set Up Customer Authentication for Visa
    - Authentication Methods
- 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
- Test Card Numbers

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

Capture Context

The capture context request is a signed JSON Web Token (JWT) that includes all of the merchant-specific parameters. This request tells the front-end JavaScript library how to behave within your payment experience. The request provides authentication, one-time keys, the target origin to the Microform Integration, in addition to allowed card networks and payment types (card or check). The capture context request includes these elements:

allowedPaymentTypes

clientVersion

targetOrigins

For information about JWTs, see JSON Web Tokens.

Target Origin: The target origin is defined by the scheme (protocol), host name (domain), and port number (if used).

You must use the https:// protocol. Sub-domains must also be included in the target origin.

Any valid top-level domain is supported, such as .com, .co.uk, and.gov.br. Wildcards are not supported.

For example, if you are launching Unified Checkout on example.com, the target origin could be any of these values:

https://example.com
https://subdomain.example.com
https://example.com:8080

You can define the payment cards and digital payments that you want to accept in the capture context.
Allowed Payment Types: You can specify the type of Microform Integration you want to accept in the capture context. You can accept card and eCheck information.; Use the
allowedPaymentTypes
field to define the payment type. Possible values:
CARD
CHECK
The
allowedPaymentTypes
field is optional. When this field is provided in the capture context, the Microform Integration defaults the field value to
CARD
and is returned in the response.

Back to top