SAP Commerce Cloud
Last updated: January 22, 2025
SAP Commerce Cloud Connector integrates seamlessly with the SAP B2C Accelerator. The Connector for SAP Commerce Cloud (formerly Hybris) enables you to implement a global payment strategy through a single integration in a secure, compliant, and unified approach.
We currently support:
- SAP CC 1905, 2005, 2011, 2105, 2205, and 2211, including B2C Accelerator
- SAP Spartacus 3.2 front end with server-side rendering (SSR) support, which is compatible with SAP CC 1905, 2005, and 2011
- SAP Spartacus 4.2 front end with SSR support, which is compatible with SAP CC 2011 and later
This guide explains how to integrate with our plugin.
- SAP Commerce Fulfillment process – With our APIs for authorization, capture, refund and void. The same functionality has been brought onto our Spartacus v3.2 storefront connector.
- SAP Commerce Backoffice – The connector provides specific customizations for the back office to ease the administration, configuration and management of all the operations related to the integration with our payment solution.
- 3DS 2.0 (PSD2) – In case of a non-frictionless interaction, the user must enter additional information related to Strong Customer Authentication (SCA).
- SAP Web Content Management System (WCMS) – The connector enables business users to add cards and alternative payment methods using CMS components.
- Express checkout – One-click payments with Apple Pay and Google Pay from the Product details page and Cart page.
- Co-branded cards – Full support for co-branded cards like Cartes Bancaires.
- Level 2 or Level 3 Data – If you provide Level 2 or Level 3 data with your transactions, you may qualify for reduced interchange rates. Cardholders also benefit from the additional data, as they receive more detailed transaction information in their card statements.
If you haven't already, create a test account with us.
To set up our SAP CC plugin, you'll need four API keys: a secret key, a public key, a signature key, and an authorization header key. You can create your secret and public keys in the Dashboard. The signature key and authorization header key are generated when you create a webhook for your business.
- Download the latest Checkout.com SAP Commerce Cloud Connector. This contains the installer recipes and connector extensions.
- Unzip the Connector .zip file.
- Copy the extracted folders to the
HYBRIS_ROOTof your Hybris installation. - Remove the SAP Commerce fulfillment extension
yacceleratorfulfilmentprocessfromlocalextensions.xml, because the connector handles the fulfillment using thecheckoutfulfilmentprocessextension. - Run the
ant cleancommand from your Hybrisbin/platformdirectory. - Edit your
localextensions.xmland add the following:
The extensions do not rely on any absolute paths, so you can place the extensions in a different location, such as ${HYBRIS_BIN_DIR}/custom.
- Run the following commands to install the add-ons to
yaccelatorstorefront. You can replaceyaccelatorstorefrontwith your custom storefront.
Our optional sample data add-on allows you to add fields to the checkout page, which can be used to gather information from your customers or upsell services and products.
- Run the following code:
- Run the
ant clean allcommand from your Hybris bin/platform directory. - Run the
hybrisserver.shcommand to start up the Hybris server. - Update your running system using
ant updatesystem.
After setting up the hosts file, the connector will work initially without any external setup needed, because our sample data add-on will provide all the required data for the accelerator’s electronics and apparel stores.
The add-ons are independent and can be installed on separate server instances.
The add-on comes with one Gradle recipe to be used with the Hybris installer. The recipe is b2c_acc_plus_checkout_com with b2c and Checkout.com functionality, and it is based on the b2b_acc_plus recipes provided by Hybris.
The recipe generates the local.properties file with the properties defined in the recipe. You can choose to add this file to the customconfig folder.
To install the add-on using one of the recipes detailed in that folder, run the following commands:
Our SAP Commerce Cloud Connector supports multiple Checkout.com channels, where a different website is connected to each channel. If you have multiple websites running on SAP Commerce Cloud, you can have a different configuration for each one and keep the payment transaction separate.
- In the Secret keys tab, set Use NAS to True, and enter your public key, secret key, signature key, and authorization header key in the corresponding fields. When you enter your secret key, it must contain the
Bearerprefix. - Set Use NAS Authorisation Header key and Use NAS Signature key to True.
- In the Global Settings tab, set the environment to Test, so you can start testing payments. You'll need to change this to Production when you're ready to go live.
- Select the Payment Action:
- The Authorize and Capture option means that the charge is authorized and captured (that is, the money due from the customer's account is moved into your account) at the same time.
- The Authorize option will only authorize the charge. You'll have to capture the payment manually.
- Set the following fields according to your preference:
- Review transactions at risk: If set to True, payment events coming from Checkout.com that have the risk flag set to
truewill be created with transaction status REVIEW. Otherwise, the payment status will be ACCEPTED. - Authorization amount validation threshold: This field is used to determine whether the authorization amount reflects the value of the order. The threshold is the allowed difference in the amounts that may exist due to the way the amounts are calculated. Increase it if you observe false positives in your integration.
- Billing descriptor: If set to True, the payment requests made will contain the billing descriptor name and city you have specified. Otherwise, no billing descriptor will be sent.
- Review transactions at risk: If set to True, payment events coming from Checkout.com that have the risk flag set to
We send payment events for all webhooks configured in the Dashboard. There should be at least one webhook created per environment pointing to the webhook event receiver. Read our webhook documentation for more information.
The connector requires the following events to be sent:
payment_approvedpayment_pendingpayment_declinedpayment_expiredpayment_canceledpayment_voidedpayment_void_declinedpayment_capturedpayment_capture_declinedpayment_refundedpayment_refund_declined
This reflects your checkoutComPaymentEventTypes configuration property. If the webhook in the Dashboard sends more events, the event receiver will ignore them.
To set up your webhooks, start by creating them in the Dashboard:
- Sign in to the Dashboard.
- Go to Developers > Webhooks.
- Select Create configuration.
- Enter a name for your webhook.
- Set up your endpoint URL, using the following example:
https://<server>:<port>/checkoutevents/receive-event. - Generate an Authorization Header Key and a Signature Key.
- Copy and store both values.
- Select all Gateway type events.
- Select the entity that you want to generate the webhooks for.
- Select Create webhook.
In your SAP Commerce Cloud's Administration Cockpit:
- In the left-side navigation menu, select Checkout.com > Merchant Configuration, and select the storefront that you want to configure the webhooks endpoint for.
- Locate the Secret Keys section, and add the Authorization Header key and Signature Key values you copied earlier.
- Select Save.
There are a number of ways you can extend your SAP Commerce Cloud integration to suit your business needs.
In this section, you'll learn how to:
Information
In order to start accepting an alternative payment method, we first need to enable it on your account. Please contact your account manager or our Sales team to get started.
We currently support the following payment methods on SAP CC:
Check the individual payment method pages to see which ones you can support. Availability will depend on your location, as well as your customer's billing address and currency.
- Sign in to your SAP CC Administration Console and go to Apple Pay Payments > ApplePay Configuration.
- Enter your merchant name.
- Enter your merchant ID. You can find this in your Apple Developer account.
- Enter your two-letter country code.
- Select which payment capabilities you want to support. Read the Apple documentation for more information.
- Select the payment networks you wish to support. Read the Apple documentation for more information.
- Enter the private key from your merchant identity certificate. You can find this in the contents of the
.keyfile in your Apple Developer account. - Enter the public key from your merchant identity certificate. You can find this in the contents of the
.pemfile in your Apple Developer account.
See our Apple Pay documentation for more information.
- Sign in to your SAP CC Administration Console and go to Google Pay Payments > GooglePay Configuration.
- Select which card networks you want to support through Google Pay with the allowed card networks setting. See Google's documentation for more information.
- Select which card authorization methods you want to support through Google Pay with the allowed card authentication methods setting. See Google's documentation for more information.
- Select the environment used for processing payments – either Test or Production. This is not the same as the Checkout.com environment setting.
- The payment gateway defines which gateway Google Pay uses. This should be left as
checkoutltd. - Enter your gateway merchant ID. You can find it in your Dashboard account.
- Enter your merchant name.
- Enter your merchant identifier. You can find this in your Google payments profile.
- Set Type to CARD. This defines the payment methods supported by Google Pay.
See our Google Pay documentation for more information.
The availability of the payment methods in SAP Commerce Cloud is defined by three attributes:
| Attribute | Description |
|---|---|
CMS Component | For a payment method to be visible, the CMS component related to the payment needs to be added to the CheckoutComPaymentButtonsSlot content slot. If you have multiple sites, the payment should be added for each site. Any payment methods that are not globally accepted by the merchant should not be added to the CMS component, regardless of the customer’s shipping or billing country. |
Billing Country | Card payments are available for all countries. You can choose to make other payment methods available only for specific billing countries by supplying them in the list. Countries excluded from the list will not be able to use the alternative payment methods. If the list is empty, no country restrictions are applied. |
Currency | Card payments do not have any currency restrictions applied. You can choose to make other payment methods available only for specific currencies by supplying them in the list. Currencies excluded from the list will not be able to use the alternative payment methods. If the list is empty, no currency restrictions are applied. |
- Go to card payments.
- If you want to process all payments as 3D Secure (3DS) payments, set Use 3D Secure to True.
- Select whether you want to attempt non-3D Secure transactions. If you select True, any cards that do not support 3DS will go through without a 3DS check. If you select False, cards that do no support 3DS will be blocked.
This add-on is compliant with the 3DS 2.0 (PSD2) directive. In case of a non-frictionless interaction, where a customer is required to enter additional information related to Strong Customer Authentication (SCA), the customer will be sent to our hosted solution page. Read our 3DS documentation for more information.
The following tables show the checkout fields which you should map each commerce field to. Use the eligibility criteria to integrate this feature with the connector.
| Commerce field | Additional parameters | Description | Checkout field |
|---|---|---|---|
| Not applicable | The customer's VAT registration number, as a 13-character |
|
| Not applicable | The taxes calculated for the full order |
|
|
| The invoice number, as a 15-character |
|
| Commerce field | Additional parameters | Description | Checkout field |
|---|---|---|---|
|
| The code identifying a commodity for VAT purposes, as a 12-character |
|
| The SAP Commerce product code |
| |
|
| The shipping address country, as a two-character |
|
| The shipping address ZIP code or post code, as a 10-character |
| |
|
| The cost of shipping the order |
|
|
| The discount applied to the whole order |
|
|
| The cart entry’s product name, translated to the customer’s session language, as a 26-character |
|
| The sum of all tax values of the particular | The added tax for the cart entry |
|
| The sum of all discount values for the particular entry | The discount applied to the cart entry |
|
|
| The quantity of the cart entry, which must be greater than |
|
|
| The total cost of the cart entry |
|
|
| The product’s unit of measure code, as a 12-character |
|
|
| The product cost per each individual unit |
|
|
| The charges involved in the import or export duty for the order |
|
Not applicable | The total tax applied to the order shipping costs (including shipping, duties, and handling charges) |
| |
| Not applicable | The ZIP code or post code from where the order will be shipped, as a 10-character |
|
Information
If you're a system integrator, refer to our interchange reduction content to ensure the correct legibility rules are applied when processing payments.