Salesforce Commerce Cloud

The first step to use the plugin is the installation process. Before you proceed, make sure your infrastructure meets these system requirements:

Once done, follow these steps:

1. Install cartridge
   You can use the cartridge with Storefront Reference Architecture (SFRA). Install the cartridge to your project root directory at the same level as storefront-reference-architecture. Have a look at this folder structure example:

   
   my-project/
   |-- link_worldline_direct/
   |  |-- cartridges/
   |  |  |-- bm_worldline_direct/
   |  |  |-- int_worldline_direct/
   |  |-- documentation/
   |  |-- metadata/
   |-- storefront-reference-architecture
   |  |-- cartridges/
   |  |  |-- app_storefront_base/
   |  |  |-- modules/
   

1. Install Node modules
   From the cartridge’s root directory, install Node modules using your command line:

   
   npm install
   
   

2. Build code
   From the cartridge’s root directory, compile the client-side assets using your command line:

   
   npm run build
   
   

3. Upload code
   Upload int_worldline_direct and bm_worldline_direct using Commerce Cloud UX Studio or
   sgmf-scripts command line utils.
   
   
4. Import metadata
   To add new configuration items, import the predefined metadata by following these steps:
   • Open the /metadata/site_import/sites/ folder.
   • Rename the yourSiteId folder to the ID of your site in the Business Manager.
   • Zip the site_import folder.
   • In the Business Manager, go to Administration > Site Development > Site Import & Export and import the zipped file.
   
   
   After the import, attributes named WorldlineDirect[attributeName] are added to Administration > Site Development. >.
   
   System Object Types > Site Preferences > Attribute Definitions
   System Object Types > Order > Attribute Definitions
   System Object Types > OrderPaymentInstrument > Attribute Definitions
   System Object Types > CustomerPaymentInstrument > Attribute Definitions
   Custom Object Types
   
   The service worldline.https.direct.yourSiteId is added to Administration > Operations > Services.

After the installation, you need to configure the plugin to link your store to our platform.

Login to the Business Manager. Set the following values in the menus and confirm by clicking "Apply" or "Save":

Set Cartridge paths

To embed an external module and link it with the Business manager, follow these steps:

• • Go to Administration > Sites > Manage Sites > [yourSite] > Settings. Enter the following in "Cartridges":
    
    

    int_worldline_direct:app_storefront_base

• • Go to Administration > Sites > Manage Sites > Manage the Business Manager site > Settings. Enter the following in front of any other existing cartridges:
    
    

    bm_worldline_direct:int_worldline_direct:bm_app_storefront_base:bm_custom_plugin

Define Business Manager permissions

Manage the access rights of the module to ensure correct interaction with your Business manager and storefronts:

• • Go to Administration > Organization > Roles & Permissions. Click on the role you want to update in the table. Go to Business Manager Modules.
  • In the "Select context" pop-up, select all storefront sites that will use Worldline-Direct Payments Cartridge.

Configure credentials for Test/Live environment

To target our test/live environment and make sure that your requests are legitimate, you need to configure URL endpoints and an API key/secret pair linked to a specific PSPID.

• Go to Administration > Operations > Services. Open the “Credentials” tab.
• Click on the worldline.https.direct.yourSiteId.TEST in column “Name” in the table to configure either test/live. Perform the action for both environments.

• Enter the following in the table:

• Open the Services Tab. Click on worldline.https.direct.yourSiteId and enter the following in the table:

Perform the action for both environments.

Set up Merchant ID, Data Locale and Operation code

Every transaction is channeled via a test/live PSPID on our platform. You also need to define whether our platform processes transactions in authorisation or direct sale mode. If your customers’ native language is different than English, you also need to define the language of the payment pages via the locale.

• Go to Merchant tools > Site Preferences > Custom Preferences. Click on “WORLDLINE_DIRECT” in column “ID” for setting up your general configuration to connect your store to our platform. Perform the actions as stated in the table:

• Enter the following data on the site:

Configure payment methods and integration methods

We categorise payment methods in two different clusters:

• Card payments
• Alternative payment methods

You can process card payments either via Hosted Tokenization Page or Hosted Checkout Page, whereas the alternative payment methods are available only via Hosted Checkout Page.

Follow these steps to make your choice:

• Go to Merchant tools > Ordering > Payment methods. Click on either “WORLDLINE_DIRECT_CARD”/”WORLDLINE_DIRECT_REDIRECT” in column “ID”. Make sure to select YES for enabled. Perform the actions as stated in the table:

• Go to Merchant tools > Site Preferences > Custom preferences. Click on either of them in column “ID” to configure and customise them.

Configure webhooks

The plugin uses webhooks to get the current status of your transactions from our platform. This way your store database is always up to date.

• Configure a WebhooksKey, WebhooksKeySecret and Endpoint URLs in your PSPID as described in our dedicated guide. Make sure to use the following formula for your endpoint URLs:
  https://{domain}/on/demandware.store/Sites-{yourSiteId}-Site/{locale}/WorldlineDirect-Webhooks
• Go to Merchant tools > Site Preferences > Custom preferences. Click on “WORLDLINE_DIRECT_WEBHOOKS” in column “ID”. Perform the actions as stated in the table:

• Go to Administration > Operations > Jobs. Click on “WorldlineProcessWebhooks” in the list. Go to Job Step to set the scope to your site. Configure the schedule for the job based on your needs.

Test connection

Once you have completed all the steps, verify the configuration by establishing a test connection between the plugin and our platform:

• Go to Merchant Tools > Ordering > Worldline-Direct Transactions. Click on the “Test API connection” button. Check that the appearing dialogue box states “Connection to the Worldline-Direct API succeeded”.

We have designed the plugin to follow-up on your orders automatically and autonomously, freeing you from the administration involved. Learn here how to use our plugin effectively which could help your business to thrive!

Follow-up on orders Check payment status / Process unconfirmed orders

To make sure

• your platform registers successful payments (StatusCode=5 or 9 and Status=”PAYMENT_CREATED”) as such and not as unfinished (because of a failed redirection of your customers to the Salesforce Commerce Cloud website.
• authorised transactions are finalised by a capture (If you choose Operation Code: Authorisation during the initial order).

the plugin implements the “Check payment status job”. Follow these steps to make them work:

• Modify property cancelUnconfirmedOrderAfterHours to the desired amount of hours after which the plugin cancels an order in a pending status.
• Check out how to capture authorisations automatically or manually.

Capture authorisation automatically

If you choose to authorise transactions only during the initial order, our plugin will capture them for you at a later point. You can define the intervals and the timing for the captures based on your business requirements.

Go to Administration > Jobs > WorldlineCaptureAuthorizedPayments > Schedule and History. Perform the actions as stated in the table for the respective capture mode:

Perform maintenance operations

Captures, refunds and cancellations of authorisations are standard processes (also known as maintenance operations) in your everyday business logic. Learn here how to perform these operations in the Business manager:

Go to Merchant Tools > Ordering > Worldline-Direct Transactions. Look up the transaction in question and click on “Details” in column “Category”. The dialogue box shows the possible actions you can perform on a transaction. Perform the action as stated in the table to perform the respective maintenance operations.

Perform test transactions

Use our platform's test environment to make sure your plugin works as intended. We offer test data sets on our dedicated Test cases page. Target our test environment as described in the "Configure Plugin" section.