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: Client-Defined Trigger for Click to Pay or PAN Entry
    - 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
  - Dual-Branded Cards
- Authorizations with a Transient Token
  - REST Example: Requesting an Authorization with a Transient Token
- Capture Context API
  - Features
  - Client Version History
  - 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
- Unified Checkout Configuration
  - Webhooks Support
  - Enable Digital Payments
    - Enrolling in Apple Pay
    - Preparing a Device for Testing Apple Pay on Unified Checkout
    - Enabling Click to Pay
      - Set Up Customer Authentication for Visa
    - Enrolling in Google Pay
    - Managing Google Pay Authentication Types
    - Enrolling in Echeck/ACH Services
    - Enrolling in Alternative Payment Methods
  - Manage Permissions
    - Managing Permissions as a Direct Merchant
    - Managing Permissions as a Portfolio Administrator
- Test Your Unified Checkout Configuration
  - Test Payment Details
  - Customer Authentication
- Payment Methods
  - Cards
  - Online Bank Transfers
    - Opt in to iDeal on Unified Checkout
    - Opt in to Multibanco on Unified Checkout
    - Example: Verify Status for Online Bank Transfers
  - Buy Now, Pay Later
    - Opt in to Afterpay on Unified Checkout
    - Captures
      - Required Fields for Capturing an Authorization
      - REST Example: Capturing an Authorization
- 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
  - 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
  - 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

Payment Details API

This section contains the information you need to retrieve the non-sensitive data associated with a Unified Checkout transient token and the payment details API. This API can be used to retrieve personally identifiable information, such as the cardholder name and billing and shipping details, without retrieving payment credentials, which helps ease the PCI compliance burden.

There are two methods of authentication, and they are described in the

Getting Started with REST Developer Guide

:

Set Up a JSON Web Token Message

Set Up HTTP Signature Message

IMPORTANT

Cybersource recommends that you dynamically parse the response for the fields that you are looking for when you integrate with Cybersource APIs. Cybersource may add additional fields in the future.

You must ensure that your integration can handle new fields that are returned in the response. Even though the underlying data structures do not change, you must also ensure that your integration can handle changes to the order in which the data is returned. Cybersource uses semantic versioning practices, which enables you to retain backwards compatibility as new fields are introduced in minor version updates.

Endpoint

Production:

GET https://api.cybersource.com/up/v1/payment-details/{id}

Test:

GET https://apitest.cybersource.com/up/v1/payment-details/{id}

The

{id}

is the full JWT received from Unified Checkout as the result of capturing payment information. The transient token is a JWT object that you retrieved as part of a successful capture of payment information from a cardholder.

Back to top