Documentation Home

Cardinal Commerce Environment Setup

Prerequisites

  • Users must follow the BroadleafCommerce Paymetrics Environment Setup and Paymetrics Quick Start guides located here:link.

  • Users must establish their own accounts with Cardinal Commerce in order to use the BroadleafCommerce Cardinal Commerce payment functionality.

  • Please familiarize yourself with the Cardinal Commerce PayPal Credit and PayPalExpress API before proceeding.

Once oyu have establised an account with Cardinal Commerce, begin by including the Cardinal Commerce Module dependency to your pom.xml

<dependency>
    <groupId>com.broadleafcommerce</groupId>
    <artifactId>broadleaf-cardinalcommerce</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <type>jar</type>
    <scope>compile</scope>
</dependecy>

Make sure to include the dependency in your core pom.xml as well:

<dependency>
    <groupId>com.broadleafcommerce</groupId>
    <artifactId>broadleaf-cardinalcommerce</artifactId>
</dependency>

You should now begin to setup your environment to work with Broadleaf Commerce Cardinal Commerce support. The first step is to make Broadleaf Commerce aware of your Cardinal Commerce account credentials.
This is accomplished through environment configuration (see Runtime Environment Configuration).

Broadleaf allows you to create your own property files per environment (e.g. common.properties, local.properties, development.properties, integrationdev.properties, integrationqa.properties, staging.properties, and production.properties)
You will need to enter the following key/value pairs in the appropriate locations and replace the "?" with your Paymetrics XiPay account details:

You can also store these configs in the Database by utilizing the blSystemPropertiesService

Note - the processor Id, merchant ID, and the transaction password are assigned on a per merchant basis. The transaction URL is what your Cardinal Commerce transactions will communicate with. The timeout connect and timeout read are the timeout values to connect to the transaction url and for receiving a response, respectively.

Cardinal Commerce

gateway.cardinal.configuration.messageVersion=?
gateway.cardinal.configuration.transactionUrl=?
gateway.cardinal.configuration.timeoutRead=?
gateway.cardinal.configuration.timeoutConnect=?
gateway.cardinal.configuration.transactionPwd=?

PayPalCredit (Bill Me Later) Specific

gateway.cardinal.payPalCredit.configuration.processorId=?
gateway.cardinal.payPalCredit.configuration.merchantId=?

PayPalExpress Specific

gateway.cardinal.payPalExpress.configuration.processorId=?
gateway.cardinal.payPalExpress.configuration.merchantId=?
gateway.cardinal.payPalExpress.configuration.completeCheckoutOnCallback=?