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

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
- 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
    - 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 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

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
- 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

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 frontend JavaScript library how to behave within your payment experience. For information on JSON Web Tokens, see JSON Web Tokens.

You can define the payment cards and digital payments that you want to accept in the capture context. Use the

allowedCardNetworks

field to define the card types.

Available card networks for card entry:

American Express

Diners Club

Discover

JCB

Mastercard

Visa

IMPORTANT

Click to Pay supports American Express, Mastercard, and Visa for saved cards.

Use the

allowedPaymentTypes

field to define the digital payment methods.

Example:

{
  "targetOrigins" : [ "https://www.test.com" ],
  "clientVersion" : "0.19",
  "allowedCardNetworks" : [ "VISA", "MASTERCARD", "AMEX" ],
  "allowedPaymentTypes" : [ "PANENTRY", "CLICKTOPAY", "GOOGLEPAY" ],
  "country" : "US",
  "locale" : "en_US",
  "captureMandate" : {
    "billingType" : "FULL",
    "requestEmail" : true,
    "requestPhone" : true,
    "requestShipping" : true,
    "shipToCountries" : [ "US", "GB" ],
    "showAcceptedNetworkIcons" : true
  },
  "orderInformation" : {
    "amountDetails" : {
      "totalAmount" : "1.01",
      "currency" : "USD"
    },
  }
}

This diagram shows how elements of the capture context request appear in the card entry form.

Image of the capture context request code and how it appears in the
entry form elements. — Anatomy of a Manual Card Entry Form

For more information on requesting the capture context, see Capture Context API.