CyberSource (deprecated)

API Version

Minimum required API version: 1.1.0

Payment Methods

Payment MethodPayment Method Type
American ExpressCards
AuraCards
CartaSiCards
Carte BlancheCards
Carte BleueCards
DankortCards
DINERSCards
DISCOVERCards
HipercardCards
JALCards
JCBCards
MAESTROCards
MAESTRO UKCards
MASTERCARDCards
NICOSCards
ORICOCards
UATPCards
VISACards

Currencies

CyberSource supports many currencies, but not all currencies are supported by all providers. Contact CyberSource support for provider-specific details.

Features

The following table provides an overview of all supported and non-supported features.

FeatureSupported
3DS 2.0 ExternalNo
3DS 2.0 PaymentsOS-handledNo
3DS 2.0 Provider-handledNo
3DS 2.0 Self-handledNo
InstallmentsNo
Level 2 and 3 DataNo
Multi-seller PaymentsNo
Network TokensNo
Payment FacilitatorNo
PayU RiskNo
Pre-authorizationNo
Retrieve Supported Payment MethodsNo
Retrieve Supported PlansNo
Statement Soft DescriptorNo
Stored Credentials FlagNo
Transaction Processing without CVVNo

Requests

The following table lists all supported requests for card-based transactions.

Use the bodybuilder to create a sample request body for each request type.

RequestPartial/MultipleModeNotes
Authorize Partial is supportedSynchronous
Capture Both partial and multiple are supportedSynchronousSupport for multiple/partial capture depends on the specific provider.
Charge Not ApplicableSynchronous
Refund Both partial and multiple are supportedSynchronousSupport for multiple/partial refund depends on the specific provider.
Void Not ApplicableSynchronousVoid after capture on the same day is supported (before the nightly batch).

Setup Procedures

The following table lists the setup procedures that are specific to this provider.

ConfigurationRequired/Optional
In the PaymentsOS Control Center, configure the following credentials:
  • merchantID: The merchant ID or username provided by CyberSource.
  • transactionSecurityKey: The transaction security key provided by CyberSource. See How to Generate a SOAP Toolkit API Security Key in the CyberSource documentation.
  • sharedSecretKey: The shared secret key that you generated in your CyberSource account.
  • publicKey: The public key that you generated in your CyberSource account.
For help in generating the sharedSecretKey and publicKey, see Create a Shared Secret Key for HTTP Signature Authentication in the CyberSource documentation. To see your CyberSource credentials, login to either the CyberSource test or live environment and choose Account Management.
Required
In your CyberSource account, make sure that the CyberSource Relaxed Requirement mode setting is set to false (the default). This means that address data and expiration date fields are mandatory in requests. Contact CyberSource support for assistance.

Note: Information in this guide is presented on the assumption that the Relaxed Requirement mode setting is set to false (if you need to operate with the Relaxed Requirement mode setting set to true, then contact PaymentsOS Support).
Required
In your CyberSource account, enable Partial Authorization if desired. Contact CyberSource support for assistance. Note: If Partial Authorization is enabled, then the authorization.amount can be different to the payment.amount.Optional
In your CyberSource account, add specific external providers. Contact CyberSource support for assistance.Optional

Optional Transaction Reconciliation fields

This is a summary of the optional fields that can be used for transaction reconciliation, in the authorization, capture, charge, refund, and void requests.

Attribute Name Description Usage CyberSource Field Name
reconciliation_id A unique ID that can be sent in a `post` authorization, charge, capture, or refund request.
Not all providers support this field. Providers who do use it, will return it in response to an authorization, capture, charge, refund, or void request.
It can be used for transaction reconciliation. Merchant Reference Number
or
Transaction Reference Number
provider_data.transaction_id The ID of the transaction in the provider's system.
It may be returned by the provider in response to an authorization, capture, charge, refund, or void request.
Some providers set this field to the `reconciliation_id` value that was sent in the request. For other providers, CyberSource may generate the value for this field.
It can be used for reconciliation with the bank. Transaction Reference Number
provider_data.external_id The ID of the authorization or charge request in the provider's system.
It may be returned by the provider in response to an authorization, capture, charge, refund, or void request.
It can be used to connect to the CyberSource Business Center. Request ID

Testing

Use the test cards in the Testing Credit Card Services page to test authorization and capture requests.

You can simulate test responses as described in the CyberSource Testing page.

Last modified June 27, 2024