On This Page

Capture Context Components

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.

There are some components of Unified Checkout that are available in the API, the Business Center or both. For information about how to configure Unified Checkout using the Business Center, see Configure the Unified Checkout Merchant Experience. For information about which fields are available using the API or the Business Center, and when one is overridden by the other, see Capture Context Fields in the Business Center. For a full capture context with all possible fields, see Example: Unified Checkout Complete Capture Context.

Use these required fields to request the capture context:

allowedPaymentTypes
clientVersion
country
locale
data.orderInformation.amountDetails.currency
data.orderInformation.amountDetails.totalAmount
targetOrigins: The URL in this field value must contain
https
.

This example shows the minimum fields that must be included in the capture context:

{
  "targetOrigins": [
    "http://localhost:8080"
  ],
  "country": "US"
  "locale": "en_US"
  "data": {
    "orderInformation": {
      "amountDetails": {
        "totalAmount": "21.00",
        "currency": "USD"
      }
    }
  }
}

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

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.

Related Information

API field reference guide for the REST API

Endpoint

Production:

POST https://api.cybersource.com/uc/v1/sessions

Test:

POST https://apitest.cybersource.com/uc/v1/sessions

Production in Saudi Arabia:

POST https://api.sa.cybersource.com/uc/v1/sessions

Test in Saudi Arabia:

POST https://apitest.sa.cybersource.com/uc/v1/sessions