On This Page
REST API

Capture Context API

This section contains the information you need to request the capture context using the capture context 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.
For information on JSON Web Tokens, see JSON Web Tokens.
The capture context is signed with long‑lasting keys so that its authenticity can be validated.
You can define the payment cards and other application features in the capture context. Use the
allowedCardNetworks
 field to define the card types. These are the available card networks:
  • American Express
  • Diners Club
  • Discover
  • JCB
  • Mastercard
  • Visa
Use the
allowedPaymentTypes
 field to define the digital payment methods.
For more information on enabling and managing these digital payment methods, see these topics:
IMPORTANT
When integrating with
Cybersource
 APIs,
Cybersource
 recommends 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.
Cybersource
 uses semantic versioning practices, which enables you to retain backwards compatibility as new fields are introduced in minor version updates.

Endpoint

Production:
POST
https://api.cybersource.com
/up/v1/capture-contexts
Test:
POST
https://apitest.cybersource.com
/up/v1/capture-contexts