On This Page

Configuration

This section describes how to set up the plugin. You complete most of the Plugin configuration using PrestaShop Back Office.
When merchants support digital payment processing using Apple Pay or Google Pay, they must complete some setup using the Apple Pay or Google Pay Developer websites.

Configuring Plugin Settings

Use PrestaShop Back Office to configure these settings:
  • General settings
  • Payment method settings
  • Fraud management settings
  • Report settings
  • Latin American country settings, if they apply
For details about these settings, see Configuration Settings.
To configure these settings, follow these steps:
  1. Open PrestaShop Back Office and select
    Modules > Module Manager
     from the Dashboard. The Module Manager page opens.
  2. Find the Plugin in the Payment section on the Module Manager page, or enter Cybersource Official in the Search field and click
    Enter
    .
  3. Click
    Configure
    . The Configure Cybersource Official page opens.
  4. Under each tab, enter your configuration information, and click
    Save
    .

Configuration Settings

This section describes the configuration settings for the Cybersource Official Plugin.

General Settings

Sandbox Mode
When sandbox mode is set to
Yes
, PrestaShop operates in sandbox (test) mode so that you can test new changes and conduct experiments.
When sandbox mode is set to
No
, PrestaShop operates in production (live) mode.
Merchant ID
This setting specifies the shop or store Cybersource Merchant ID, which is a unique Cybersource identifier for the merchant.
Merchant Key ID
This setting identifies a specific key or token provided by a payment gateway to authenticate and authorize the merchant's integration with the gateway.
Merchant Secret Key
This setting identifies a confidential or private key used for secure communication between the merchant's online store and a payment gateway.
Payer Authentication/3-D Secure
When this setting is set to
Yes
, customers may receive one-time-password (OTP) pop-ups when placing orders using credit cards. This enables the exchange of data between the merchant, card issuer, and, when necessary, the customer, to validate that the transaction is being initiated by the rightful owner of the account. This may be a requirement for the country in which you are trading.
Enhanced Logs
When this setting is set to
Yes
, logs are generated and can be accessed by selecting
Configure > Advanced Parameters > Logs
.
Payment Action
Use the drop-down menu to choose one of these transaction settings:
  • Authorize:
     when selected, this setting generates an authorize-only transaction for a customer order.
  • Sale:
    when selected, this setting generates a sale (bundled authorization and capture) transaction for a customer order.

Payment Settings

Card Payment
When this setting is set to
Yes
, customers can use a credit or debit card as a payment method.
Click to Pay
When this setting is set to
Yes
, customers can use Click to Pay as a payment method. When the setting is set to
Yes
, you must also provide a Click to Pay API key, which you can configure in the Cybersource
Business Center
.
Google Pay
When this setting is set to
Yes
, customers can use Google Pay as a payment method. When the setting is set to
Yes
, you must also enter the Google Pay Merchant ID and Google Pay Merchant Name, which you obtain from a Google Pay Developer account.
Apple Pay
When this setting is set to
Yes
, customers can use Apple Pay as a payment method. When the setting is set to
Yes
, you must also enter the Apple Pay Merchant ID, Path to Certificate (file), and Path to Key (file), which you obtain from an Apple Developer account. See Enabling Apple Pay for information about the requirements for enabling Apple Pay and generating these files.
eCheck
When this setting is set to
Yes
, customers can use
eCheck
 as a payment method.

Fraud Management Settings

Fraud Management
When this setting is set to
Yes
, merchants can identify and prevent fraudulent activities that might occur when their customers are using PrestaShop.
Tokenization
When this setting is set to
Yes
, customers can safely save and store their card information so that it can be used for future purchases.
Enforce Strong Customer Authentication
When this setting is set to
Yes
, the card holder is 3-D Secure challenged when saving their card information.
The Enforce Strong Customer Authentication setting is available only when the Payer Authentication/3-D Secure (general Plugin setting) and Tokenization (fraud management Plugin setting) are enabled.
Limited Saved Card Rate
When this setting is set to
Yes
, merchants can specify the number of cards that customers can save in their account, and they can specify the amount of time for which that card information can be saved:
  1. Saved Card Limit Count:
     specifies the maximum number of cards a customer can save to their account.
  2. Saved Card Limit Time Frame:
     specifies the time frame (from 1 to 24 hours) for which customers can save the specified number of cards to their account.
Google reCAPTCHA
When this setting is set to
Yes
, merchants enter the Google reCAPTCHA keys, which are used to provide an advanced risk analysis engine and adaptive challenges to keep malicious software from engaging in abusive activities on your website:
  • reCAPTCHA Site Key
  • reCAPTCHA Secret key, which can be configured on the Google reCAPTCHA website
See Generating a Google reCAPTCHA Site Key and Secret Key for the steps on how to generate these keys.
Device Fingerprint
When this setting is set to
Yes
, merchants can identify and track devices that access their website such as computers, smart phones, and tablets.

Report Settings

Transaction Request Report
This report includes details for individual transactions that are processed each day.
When this setting is set to
Yes
, this report is downloaded from the
Business Center
 to PrestaShop. The report is downloaded to different locations, depending on the mode in which PrestaShop is operating:
  • In sandbox (test) mode, the report downloads to
    {PrestaShopModuleInstallationDirectory}/cybersourceofficial/Reports/Sandbox
  • In production (live) mode, the report downloads to
    {PrestaShopModuleInstallationDirectory}/cybersourceofficial/Reports/Production
    .
Cybersource strongly recommends that PrestaShop and the
Business Center
 operate in the same time zone so that the Transaction Request Report and Payment Batch Detail Report work properly.
Payment Batch Detail Report
This report includes transactions that are processed with the applications. This report is available shortly after captured transactions are batched.
When set to
Yes
, this report is downloaded from the
Business Center
 to PrestaShop. The report is downloaded to different locations, depending on the PrestaShop mode:
  • In sandbox (test) mode, the report downloads to this location:
    {PrestaShopModuleInstallationDirectory}/cybersourceofficial/Reports/Sandbox
  • In production (live) mode, the report downloads to this location:
    {PrestaShopModuleInstallationDirectory}/cybersourceofficial/Reports/Production
Cybersource strongly recommends that PrestaShop and the
Business Center
 operate in the same time zone so that the Transaction Request Report and Payment Batch Detail Report work properly.
Conversion Detailed Report
This report retrieves Case Management changes from the
Business Center
 at regular intervals to ensure that orders are updated in PrestaShop.

Latin American Country Settings

Installments
When this setting is set to
Yes
, customers can make installment payments ranging from 1 to 24 months. You can configure installment payment settings for these Latin American countries: Brazil, Chile, Columbia, Mexico, and Peru. See Enabling Installment Payments for how to configure installment payments.
Merchant Descriptor Name
This configuration applies only to Brazil and Mexico.
This setting enables merchants to add a short description that appears on a customer credit card statement or bank statement to identify a particular transaction.
Grace Period
This setting stipulates a time period after a due date during which a payment can be made without incurring late fees or penalties. See Enabling Grace Period Payments for further information about configuring grace period payments for Mexico, the only country for which this setting currently applies.

Enabling Installment Payments

Use PrestaShop Back Office to enable installment payments, which are applicable for payments in Brazil, Chile, Colombia, Mexico, and Peru.
  1. Open PrestaShop Back Office and select
    Modules > Module Manager
     from the Dashboard. The Module Manager page opens.
  2. Find the Plugin in the Payment section on the Module Manager page, or enter Cybersource Official in the Search field and click
    Enter
    .
  3. Click
    Configure
    . The Configure Cybersource Official page opens.
  4. Select the
    LATAM SETTINGS
     tab.
  5. From the
    Country
     drop-down menu, choose the country for which you want to configure the installment payments.
  6. Choose the relevant options from each drop-down menu for these settings and click
    Save
    :
    • Processor
    • Installments (In Months)
    • Choose Card Types
    When a specific card type is selected for a processor in a certain country, it cannot be chosen for any other processor within that country.

Enabling Grace Period Payments

Use PrestaShop Back Office to enable grace period payments, which are applicable only for payments in Mexico.
  1. Open PrestaShop Back Office and select
    Modules > Module Manager
     from the Dashboard. The Module Manager page opens.
  2. Find the Plugin in the Payment section on the Module Manager page, or enter Cybersource Official in the Search field and click
    Enter
    .
  3. Click
    Configure
    . The Configure Cybersource Official page opens.
  4. Select the
    LATAM SETTINGS
     tab.
  5. From the
    Country
     drop-down menu, choose
    Mexico
    .
    You must select Mexico as the country to get access to the Grace Period setting because this setting is only applicable in Mexico.
  6. To enable grace period payments, set
    Grace Period
     to
    Yes
    , and click
    Save
    .

Enforcing Strong Customer Authentication

Select the Enforce Strong Customer Authentication setting to prompt a 3-D Secure challenge when a customer saves their credit card information. The customer is 3-D Secure challenged when a transaction is declined as reported by response code 478 (Strong Customer Authentication required). After the transaction is declined, another request is sent for the same order.
The Enforce Strong Customer Authentication setting is available only when the Payer Authentication/3-D Secure (general Plugin setting) and Tokenization (fraud management Plugin setting) are enabled. See Configuration Settings for information about these settings and Configuring Plugin Settings for information about how to set them.
Follow these steps to enable Enforce Strong Customer Authentication:
  1. Open PrestaShop Back Office and select
    Modules > Module Manager
     from the Dashboard. The Module Manager page opens.
  2. Find the Plugin in the Payment section on the Module Manager page, or enter Cybersource Official in the Search field and click
    Enter
    .
  3. Click
    Configure
    . The Configure Cybersource Official page opens.
  4. Select the
    FRAUD MANAGEMENT SETTINGS
     tab.
  5. Set the Enforce Strong Customer Authentication setting to
    Yes
    .
  6. Click
    Save
    .

Enabling Apple Pay

This section describes the requirements for configuring and using the plugin to process Apple Pay transactions through PrestaShop.

Account and Website Requirements

Before you configure the Plugin to process Apple Pay transactions, ensure that these requirements are met:

Setting Up Apple Pay

This section describes the requirements for setting up Apple Pay to process Apple Pay transactions through PrestaShop.
  1. Follow the instructions for enabling Apple Pay on the
    Setting Up Apple Pay
     page on the Apple Developer website. Before proceeding, ensure that you have completed these steps:
    1. Create a Merchant ID
    2. Create a Payment Processing Certificate
    3. Validate the merchant domain
    4. Create a Merchant Identity Certificate
  2. Download the Merchant Identity Certificate.
  3. Convert the downloaded certificate to a PEM format: 
    openssl x509 -inform der -in merchant_id.cer -out merchant_id.pem
    After the certificate is converted, it displays in the Keychain Access menu.
  4. Double-click the certificate on the Keychain Access menu. The certificate is installed and the associated private key displays in the Keychain Access menu.
  5. Right-click the private key, select the
    Export
     option, and export the key as
    merchant_id.p12
    .
  6. Convert the exported private key to a KEY format: 
    openssl pkcs12 -in merchant_id.p12 -out merchant_id.key -nodes
  7. Upload the converted key (
    merchant_id.key
    ) and certificate (
    merchant_id.pem
    ) files to your website server.
  8. Open PrestaShop Back Office and select
    Modules > Module Manager
     from the Dashboard. The Module Manager page opens.
  9. Find the Plugin in the Payment section on the Module Manager page, or enter Cybersource Official in the Search field and click
    Enter
    .
  10. Click
    Configure
    . The Configure Cybersource Official page opens.
  11. Select the
    PAYMENT SETTINGS
     tab and enter the complete path to the certificate and key in the Apple Pay section.

Enabling Google Pay

This section describes the requirements for using and configuration steps to enable the plugin to process Google Pay transactions through PrestaShop.

Account Requirements

Before you configure the Plugin to process Google Pay transactions, ensure that you have a Google Pay Developer account.

Generating a Google reCAPTCHA Site Key and Secret Key

The Google reCAPTCHA site and secret keys allow you to safely process Google Pay payments. These keys protect your website when your customers use Google Pay to make payments.
  1. Go to the Google reCAPTCHA website and click the
    Admin Console
     link.
  2. Complete these steps to register a new site:
    1. Enter a label that will be used to identify the site.
    2. Choose the Score based (v3) option for the reCAPTCHA type.
    3. Enter the domain on which PrestaShop is hosted.
    4. Enter the email address of the website owner.
    5. Check the box to accept the terms of service and click
      Submit
      .The reCAPTCHA site key and secret key are generated.
  3. Open PrestaShop Back Office and select
    Modules > Module Manager
     from the Dashboard. The Module Manager page opens.
  4. Find the Plugin in the Payment section on the Module Manager page, or enter Cybersource Official in the Search field and click
    Enter
    .
  5. Click
    Configure
    . The Configure Cybersource Official page opens.
  6. Select the
    FRAUD MANAGEMENT SETTINGS
     tab and enter the keys in the Google reCAPTCHA section of the tab.

Scheduling Report Generation

Schedulers on a Linux, Mac, or Windows system are used to set up how often a specified report is generated. Schedulers for Linux and Mac systems are set up using a Cron Tab. The scheduler for a Windows system is set up using the Windows Task Scheduler app.
When setting up a schedule for generating a specific report, use this format:
  • Format:
     <
    shop domain name
    >/module/cybersourceofficial/paymentReport
  • Example:
    http://www.prestashop_1.7.8.6.com/module/cybersourceofficial/paymentReport
    h

Cron Tab Syntax for Mac and Linux Systems

When setting up the reporting schedule on a Linux or Mac system, you use
crontab
 commands that determine how often and when the report is generated.
The syntax is: 
* * * * * [command]
The asterisk (*) represents each of these timing parameters:
  • Minute (0-59)
  • Hour (0-23)
  • Day of Month (1-31)
  • Month (1-12)
  • Day of week (0-6), (0-Sunday)
For example, these timing parameters indicate how often a specified report is generated:
  • * * * * * [command]
    : Runs every minute of every day of every week of every month.
  • 0 * * * * [command]
    : Runs every hour of every day of every week of every month.
  • 30 2 * * * [command]
    : Runs at 2:30 a.m. every day of every week of every month.
  • 0 0 2 * * [command]
    : Runs once a month every month on the second day of the month.
  • 0 * * * 1 [command]
    : Runs every Monday at every hour.
  • 0,10,20 * * * * [command]
    : Runs on 0, 10, 20 minute of every hour of every day of every week of every month.
  • 0 5-10 * * * *[command]
    : Runs every hour between 5 and 10 a.m.
  • @reboot [command]
    : Runs every time after the server reboots.
  • */5 * * * * [command]
    : Runs every 5 minutes of every day.

Setting Up Cron Scheduler for Linux

  1. Open a Linux terminal.
  2. Enter
    crontab-e
     to enter editor mode. For example: 
    root@PrestashopQA4:/etc#  crontab -e
  3. Enter the command to set the timing for the cron job. For example, this command sets the cron job to run every 15th minute of every hour, every day, every week, and every month: 
    15 * * * * curl https://www.dev.prestahop.cybsplugin.com/mps1760/module/mybank/paymentReport
  4. Enter
    Ctrl + X
     to close the editor.
  5. Enter the
    crontab -l
     command to check the scheduled cron job. For example: 
    root@PrestashopQA4:/etc#  crontab -l
    The scheduled cron job should appear on the screen. For example: 
    15 * * * * curl https://www.dev.prestahop.cybsplugin.com/mps1760/module/mybank/paymentReport

Setting Up Cron Scheduler for Mac

  1. Open a Mac terminal.
  2. Enter
    crontab-e
     to enter editor mode.
    C02X63PRJG5J:~    $crontab -e
  3. Enter the command to set the timing for the cron job. For example, this command sets the cron job to run every 45th minute of every hour, every day, every week, and every month:
    45 * * * * curl https://www.qa.prestahop.cybsplugin.com/mps1786/module/cybersourceofficial/paymentReport
  4. Enter
    Esc + : + w + q
     to close the editor. The editor closes and displays this message:
    crontab: installing new crontab
  5. Enter the
    crontab -l
     command to check the scheduled cron job.
    C02X63PRJG5J:~    $crontab -l
    The scheduled cron job should display on the screen. For example: 
    45 * * * * curl https://www.qa.prestahop.cybsplugin.com/mps1786/module/cybersourceofficial/paymentReport

Setting Up Task Scheduler for Windows

  1. Open the Task Scheduler app and click
    Create Task
    .
    The Create Task pane displays.
  2. Select the
    General
     tab and enter a name for the task in the
    Name
     field.
  3. Select the
    Triggers
     tab and click
    New
    .
    The New Trigger pane displays.
  4. Make the desired timing selections for the task in the New Trigger pane and click
    OK
    .
  5. Select the
    Actions
     tab in the Create Task pane and click
    New
    .
    The New Action pane displays.
  6. Select and enter this information in the New Action pane and click
    OK
    .
    • Action drop-down menu:
       choose Start a program.
    • Program/script field:
      enter the
      curl
       command.
    • Add arguments (optional):
       enter the reporting URL.
  7. Click
    OK
     in the Create Task pane to create the task. The new task displays in the Task Scheduler Summary.