Salesforce Commerce Cloud

Introduction

This document is intended as an installation guide and user manual for the Salesforce Commerce Cloud plugin for the Addon Payments payment platform.

This document describes how to configure int_addon_payments_sfra, bm_addon_payments and bm_addon_payments_configuration cartridges in Salesforce Commerce Cloud in the Storefront Reference Architecture (SFRA).

Cartridges includes:

Addon Payments checkout from cart and payment pages.
Billing creation in the checkout process.
Review and post-process Addon Payment transactions in the Business Manager.

Implementation guide

Overview

This integration between Addon Payment and Commerce Cloud is made up of three cartridges:

int_addon_payments_sfra – Commerce Cloud storefront extension cartridge.
bm_addon_payments – Business Manager extension “Addon Payments
Transactions” cartridge.

Orders paid with integration can be post-processed from separate Business Manager module. Post-processing includes transaction capture, refund and void. Check sections 2.2.4 and 2.3 for more details.

Installation and Configuration

Import metadata

Upload and import metadata_addon_payments.zip in Business Manager > Administration > Site Development > Site Import & Export. Upload archive with the Local option in the Upload Archive section.

After upload process, choose metadata_addon_payments.zip archive in the list and click
on import button.

Add cartridge to cartridge path

Add int_addon_payments_sfra into the cartridge path of a Site in Business Manager > Administration > Sites > Manage Sites > Your Site > Settings and include int_addon_payments_sfra before your cartridges record, as in the image below.

Add API Credentials

In Business Manager > Administration > Operations > Services > Credentials, click on Addon_Payments_Credentials and set the credential given.

In non-production environments, it’s recommendable to enable communication log for the
int_addon_payments.http.rest service. The communication log will log every request and response to the log files.

To enable this option, navigate to the Business Manager > Administration > Operations > Services and click on int_addon_payments.http.rest and check the communication log enabled checkbox.

PLEASE NOTE: By enabling the communication log, some details such as customer’s personal information including address, phone, and email will be logged in cleartext. This should only be used for debugging purposes. We recommend, if possible, only use this in a sandbox; however, when used in production, ensure you are disabling / unchecking the communication log box immediately after you are done with your debugging. Further, some credentials will also be saved in cleartext.

Addon Payments Transaction in Business Manager

Add bm_addon_payments into the Business Manager cartridge path in Business Manager > Administration > Sites > Manage Sites > Manage the Business Manager Site > Settings and add bm_addon_payments to the input.

Grant access to Business Manager modules:

Go to Business Manager > Administration > Organization > Roles & Permissions and select the target role that needs to have access to Addon Payments Transaction management.

Select the Business Manager Modules tab in the drop-down list on top. You must select your target site as the active context.

Scroll to the Addon Payments Transactions module. Grant access to it by selecting the checkbox and clicking Update.

Once you do this, every Business Manager user with that role can manage Addon Payments Transactions by selecting Business Manager > Merchant Tools> Ordering > Addon Payments Transactions.

Custom cache required for fast and stable work on the integration. Navigate to Business Manager > Administration > Operations > Custom Caches and check checkbox Enable Caching.

Updating Cartridge Custom Preferences

Into Business Manager > Merchant Tools > Site Preferences > Custom Preferences, there is a new Custom Site Preference Group called Addon Payments Checkout.

Click in the option for Addon_Payments_Checkout, that contains the next list of preferences:

Addon Payments URL: Needed URL to get Addon Payments JavaScript
Addon Payments base URL: URL given for rendering the Addon Payments payment form
Addon Payments redirect URL: URL given to manage actions from the Business Manager
Merchant Id: Given by Addon Payments
Merchant Key: Given by Addon Payments
Merchant Password: Given by Addon Payments
Product Id: Given by Addon Payments
Addon Payments allowed operations: An array of allowed operations: deposit (debit) or credit.
Success URL: By default, AddonPayments-PaymentConfirming
Error URL: By default, AddonPayments-PaymentConfirming
Cancel URL: By default, AddonPayments-PaymentConfirming
Addon Payments Pre-Authorization Type: Defines two types of pre Authorization: Pre Authorization and subsequent capture. (AUTH) or Pre-Authorization + capture (All in one) (SETTLE)

Payment Processor

Payment processor has site context and is automatically created by default on site id RefArch.

If you have different site id navigate to Business Manager > Merchant Tools > Payment Processors and check if you have ADDON_PAYMENTS processor id created.

If not, make sure to create it by clicking on New and setting on the ID field ADDON_PAYMENTS name.

Payment Method

Same as the Payment processor, the Payment Method has site context and is automatically created by default on site id RefArch.

If you have different site id navigate to Business Manager > Merchant Tools > Payment Method and check if you have ADDON_PAYMENTS method id created.

If not, make sure to create it by clicking on New and setting on the Payment Processor selector ADDON_PAYMENTS option. Click on Apply.

Job configuration for removal outdated transaction

To record transaction created from Business Manager cartridge use custom object feature. After the year transaction became outdated and to remove it job with recurring interval was imported with metadata.

Job has site context and default site id is RefArch.

If you have different site id, navigate to Business Manager > Administration > Operations > Jobs > RemoveOutdatedAddonPaymentsTransaction > Job Steps and click on RefArch mark near Scope and select new site to run.

BNPL

The Buy Now Pay Later Lending service from CaixaBank Payments & Consumer (CPC) is the financing platform that connects companies, lenders and consumers. “Quix” is the name of the payment method for merchants that allows customers to select financing options and lenders to facilitate purchase process. Offer Split payments, divided in 3 and Installments up to 12 months. From € 50 to € 1.200.

Configuration

Into Business Manager > Merchant Tools > Site Preferences > Custom Preferences, there is a Addon Payments Checkout.

It is necessary to configure the new Type of Financing parameter, you can choose between:Split Pay or Instalments.

Configure the QUIX Payment Method

The image and descriptions of QUIX will make your customers recognize it and enjoy the financing conditions.

If you only use the ecommerce module to offer financing to your customers, we suggest that you enter the following settings in the module configuration panel:

Upload the QUIX logo: Downloadable from the Addon Payments developer portal in the APMs – BNPL section
Upload the QUIX logo Downloadable from the Addon Payments developer portal in the APMs – BNPL section.

You can see more detail in the installation and configuration section.

Title: Allows you to configure the title of the payment method that will appear on the checkout screen.
Logo: Allows you to configure the icon of the payment method that will be displayed at checkout, being able to modify or delete it.

Banner

Quix offers the possibility of loading an installment simulator that will show the information related to the installments and terms of the financing requested.

It is necessary to configure some parameters.

Into Business Manager > Merchant Tools > Site Preferences > Custom Preferences, there is Addon Payments Widget.

Type of Financing: By default, Instalments.
Type of Variant: One of several variants of the widget. Possible values are: [text, select, text_banner, select_banner ].
Widget Color: A valid HEX color that will be use to customize widget.
Widget Branding: Quix will provide this value. Depending on this value, one version of the widget or another will be display. This includes legal texts visual components distinct.

Product banner:

Cart banner:

Configure the addon payments icon

After importing the data it is necessary to go to Merchant Tools > Content Assets and find addon-payments-card.

We can edit the file by clicking on lock.

Now at the bottom we can select the desired icon to appear in the payment tab.

It is important to follow the same structure as in the example.

Addon Payment Transactions

To record the transactions between Salesforce Commerce Cloud and Addon Payments, a new custom object was created, Addon Payments Transactions. To know how to install it visit the 2.2.4 section.

This integration introduces a new Business Manager function, Addon Payments Transactions.

The Addon Payment Transactions extension allows you to manage transactions assigned to Commerce Cloud Orders by the Commerce Cloud Business manager. Addon Payments Transactions module supports capture and partial capture, void, refund.

The main Addon Payments Transactions page displays all orders in a site that were paid or partially paid. You can access this page in the Ordering menu by selecting Business Manager > Merchant Tools > Ordering > Addon Payments Transactions. This page displays various information from the order record.

imagen 22