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
- Validating the Capture Context
- Securing Payment Information
- Tokenizing Payment Information
- Validate the Transient Token
- Using the Transient Token to Process a Payment
- JSON Web Tokens

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
    - Transient Token Use Cases
      - Use Case 1: Add a New Credit Card
      - Use Case 2: Checkout with a Saved Card
      - Use Case 3: Edit a Credit Card
- 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
- Reference
  - JavaScript API Reference
  - Capture Context API
  - Getting Started Examples
  - JSON Web Tokens
  - Browser Support
  - PCI DSS Guidance
  - WCAG 2.2 Compliance
  - Test Card Numbers

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 in the Business Center
        Set Up Customer Authentication for 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
- 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
- Sessions API
  - Capture Context
    - Allowed Card Networks
    - Target Origins
    - Allowed Payment Types
    - Client Version
    - Auto-check Enrollment
    - Button Type
    - Customize Button Text
    - Complete Mandate
      - completeMandate.type
      - completeMandate.decisionManager
      - completeMandate.consumerAuthentication
      - completeMandate.tms
    - Capture Mandate
      - captureMandate.comboCard
      - captureMandate.CPF
      - captureMandate.requestSaveCredentials
      - captureMandate.showConfirmationStep
      - captureMandate.billingType
      - captureMandate.requestEmail
      - captureMandate.requestPhone
      - captureMandate.requestShipping
      - captureMandate.shipToCountries
    - Include Card Prefix
    - Email Autolookup
    - Mobile as Identity for Click to Pay
  - Example: Unified Checkout Complete Capture Context
  - Validating the Capture Context
  - Session Validation
- 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
  - Client Version History

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
  - Add Click to Pay to a Merchant Account
  - Enable Click to Pay
    - Enabling Click to Pay Drop-In UI Using the API
      - Required Fields for Enabling Click to Pay Drop-In UI
      - Optional Fields for Enabling Click to Pay Drop-In UI
      - REST Example: Enabling Click to Pay Drop-In UI
    - Enabling Click to Pay in the Business Center
- Server-Side Set Up
- Client-Side Set Up
  - Loading the JavaScript Library and Invoking the Accept Function
  - Adding the Payment Application and Payment Acceptance
- Sessions API - Capture Context
  - Features
    - Allowed Card Networks
    - Target Origins
    - Allowed Payment Types
    - Auto-check Enrollment
    - Button Type
    - Customize Button Text
    - Capture Mandate
      - captureMandate.comboCard
      - captureMandate.CPF
      - captureMandate.requestSaveCredentials
      - captureMandate.showConfirmationStep
      - captureMandate.billingType
      - captureMandate.requestEmail
      - captureMandate.requestPhone
      - captureMandate.requestShipping
      - captureMandate.shipToCountries
    - Include Card Prefix
    - Email Autolookup
    - Mobile as Identity for Click to Pay
    - UI/UX Customization Look and Feel
  - Requesting the Capture Context Using the Sessions API
  - Validating the Capture Context
  - Session Validation
- Transient Tokens
- Payment Details API
- Payment Credentials API
- JavaScript API Reference
- Unified Checkout Configuration
  - Upload Your Encryption Key
    - Generate a Public Private Key Pair
    - Uploading Your Key Pair
  - Manage Permissions
    - Managing Permissions as a Direct Merchant
    - Managing Permissions as a Portfolio Administrator
  - Click to Pay Customer Authentication
    - Set Up Customer Authentication for Click to Pay
    - Enable Click to Pay Customer Authentication Using the API
      - Required Fields for Enabling Click to Pay Authentication
      - Optional Fields for Enabling Click to Pay Authentication
      - REST Example: Enabling Click to Pay Authentication
    - Enable Click to Pay Customer Authentication Using the Business Center
- Update to Click to Pay Drop-In UI Version 1
  - Update Reason Codes
  - Version 1 Update Checklist
- Click to Pay UI Guidelines
  - Click to Pay UI Examples
- Test Your Click to Pay Configuration
  - Test Payment Details
  - Handle Errors
- Appendix
  - Client Version History
  - Customization Matrix
  - JSON Web Tokens
  - Reason Codes
  - Supported Countries for Click to Pay
  - Supported Locales

Processing Authorizations with a Transient Token
- Authorization with a Transient Token
- Authorization and Creating TMS Tokens with a Transient Token

On This Page

Sessions API - Capture Context

This section contains the information you need to request the capture context using the

sessions

API.

The capture context request contains all of the merchant-specific parameters that tell the frontend JavaScript library how to behave within your payment experience.

The capture context is a signed JSON Web Token (JWT) containing this information:

Merchant-specific parameters that dictate the customer payment experience for the current payment transaction.

A one-time public key that secures the information flow during the current payment transaction.

The capture context request includes these elements:

allowedCardNetworks

allowedPaymentTypes

clientVersion

targetOrigins

For information on JSON Web Tokens, see JSON Web Tokens.

IMPORTANT

When integrating with Cybersource APIs, Cybersource insists that you dynamically parse the response for the fields that you are looking for. Additional fields may be added in the future.

You must ensure that your integration can handle new fields that are returned in the response. While the underlying data structures will not change, you must also ensure that your integration can handle changes to the order in which the data is returned.

Back to top