On This Page
PrestaShop
The plugin for PrestaShop provides a payment solution for merchants using PrestaShop
to manage their orders. This section describes the payment methods and services the
plugin provides.
Supported payment methods:
- Credit and debit cards
- eCheck
- Click to Pay
- Apple Pay
- Google Pay
Supported payment services:
- Payment acceptance services:
- Authorization only
- Sale (bundled authorization and capture)
- Electronic check debit (sale) foreCheckpayment method
- Installment payments for Brazil, Chile, Colombia, Mexico, and Peru
- Grace period payments for Mexico
- Order management services:
- Capture an authorization (not foreCheck)
- Multiple partial captures (not foreCheck)
- Standard and partial refunds
- Standard and partial void captures (not foreCheck)
- Standard and partial void refunds
- Full authorization reversal (not foreCheck)
- Token Management Service(TMS) for credit and debit card payments:
- Create payment token along with authorization
- Update an existing token along with authorization
- Update an existing token from My Account section
- Delete an existing token from My Account section
- Create payment token for new payment methods during checkout
- Make a payment with a stored token during checkout
- Reporting services that allow you to import these CybersourceBusiness Centerreports into PrestaShop:
- Transaction Request Report
- Payment Batch Detail Report
- Conversion Detail Report
Release Information
This section provides information about the plugin
releases.
Release Version | Release Date | Support End Date |
---|---|---|
2.1.0 | April 5, 2022 | September 29, 2022 |
3.1.0 | September 29, 2022 | April 5, 2022 |
4.1.0 | September 21, 2023 | July 2026 |
4.2.0 | December 13, 2023 | December 13, 2026 |
Version 4.2.0 includes the following enhancements:
- Cybersource authentication signature updated.
- Compatible with PrestaShop versions 1.7.6.0 to 1.7.8.10
Version 4.1.0 includes enhancements that provide customers with a flexible and
convenient purchasing experience:
- Installment payment options for customers in Mexico, Brazil, Colombia, Chile, and Peru. This feature enables customers to conveniently split their payments into installments.
- Grace period payment options for customers in Mexico. This feature enables customers to delay a payment for a specified period after making a purchase.
- Expanded card payment services, which includes credit and debit card options. This feature enables customers to securely make payments using their preferred card type.
Installation
Before you install the plugin, make sure that these requirements are met:
- You are using PrestaShop version 1.7.x.
- You have created aBusiness Centeraccount and have generatedBusiness CenterREST API keys:
- To create an account, go to the Business Center Registration website.
- To generate REST API keys, seeGetting Started with REST Developer Guide.
- You have created an Apple Developer account if you are processing Apple Pay transactions.
- You have created an Google Pay Developer account if you are processing Google Pay transactions.
Follow these steps to install the plugin:
- Download the Plugin from the PrestaShop website to your local system.PrestaShop Modules > Payments > Other Payments > Cybersource Official
- Open PrestaShop Back Office and chooseModules > Module Managerfrom the Dashboard.The Module Manager page opens.
- ClickUpload a Moduleon the Module Manager page.The Upload a module pane appears.
- Clickselect filefrom the Upload a module pane and select the file you downloaded to your local system. You can also drag the file into the Upload a module pane.The pane displays the status of the installation. After the Plugin is installed, the pane indicates that the module is installed. You can close it or clickConfigureto configure the Plugin.
Configuration
This section describes how to set up the plugin. You
complete most of the Plugin configuration using PrestaShop Back Office.
- For information about the configuration settings for the Plugin, see Configuration Settings.
- For information about how to access the configuration settings for the Plugin, see Configuring Plugin Settings
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:
- Open PrestaShop Back Office and selectModules > Module Managerfrom the Dashboard. The Module Manager page opens.
- Find the Plugin in the Payment section on the Module Manager page, or enter Cybersource Official in the Search field and clickEnter.
- ClickConfigure. The Configure Cybersource Official page opens.
- Under each tab, enter your configuration information, and clickSave.
Configuration Settings
This section describes the configuration settings for the Cybersource Official
Plugin.
General Settings
- Sandbox Mode
- When sandbox mode is set toYes, PrestaShop operates in sandbox (test) mode so that you can test new changes and conduct experiments.
- When sandbox mode is set toNo, 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 toYes, 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 toYes, logs are generated and can be accessed by selectingConfigure > 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 toYes, customers can use a credit or debit card as a payment method.
- Click to Pay
- When this setting is set toYes, customers can use Click to Pay as a payment method. When the setting is set toYes, you must also provide a Click to Pay API key, which you can configure in the CybersourceBusiness Center.
- Google Pay
- When this setting is set toYes, customers can use Google Pay as a payment method. When the setting is set toYes, 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 toYes, customers can use Apple Pay as a payment method. When the setting is set toYes, 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 toYes, customers can useeCheckas a payment method.
Fraud Management Settings
- Fraud Management
- When this setting is set toYes, merchants can identify and prevent fraudulent activities that might occur when their customers are using PrestaShop.
- Tokenization
- When this setting is set toYes, 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 toYes, 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 toYes, 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:
- Saved Card Limit Count:specifies the maximum number of cards a customer can save to their account.
- 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 toYes, 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 toYes, 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 toYes, this report is downloaded from theBusiness Centerto 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 theBusiness Centeroperate 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 toYes, this report is downloaded from theBusiness Centerto 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 theBusiness Centeroperate 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 theBusiness Centerat regular intervals to ensure that orders are updated in PrestaShop.
Latin American Country Settings
- Installments
- When this setting is set toYes, 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.
- Open PrestaShop Back Office and selectModules > Module Managerfrom the Dashboard. The Module Manager page opens.
- Find the Plugin in the Payment section on the Module Manager page, or enter Cybersource Official in the Search field and clickEnter.
- ClickConfigure. The Configure Cybersource Official page opens.
- Select theLATAM SETTINGStab.
- From theCountrydrop-down menu, choose the country for which you want to configure the installment payments.
- Choose the relevant options from each drop-down menu for these settings and clickSave:
- 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.
- Open PrestaShop Back Office and selectModules > Module Managerfrom the Dashboard. The Module Manager page opens.
- Find the Plugin in the Payment section on the Module Manager page, or enter Cybersource Official in the Search field and clickEnter.
- ClickConfigure. The Configure Cybersource Official page opens.
- Select theLATAM SETTINGStab.
- From theCountrydrop-down menu, chooseMexico.You must select Mexico as the country to get access to the Grace Period setting because this setting is only applicable in Mexico.
- To enable grace period payments, setGrace PeriodtoYes, and clickSave.
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:
- Open PrestaShop Back Office and selectModules > Module Managerfrom the Dashboard. The Module Manager page opens.
- Find the Plugin in the Payment section on the Module Manager page, or enter Cybersource Official in the Search field and clickEnter.
- ClickConfigure. The Configure Cybersource Official page opens.
- Select theFRAUD MANAGEMENT SETTINGStab.
- Set the Enforce Strong Customer Authentication setting toYes.
- ClickSave.
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:
- You have a CybersourceBusiness Centeraccount.
- You have an Apple Developer account.
- Your website:
- Adheres to the Apple Pay guidelines specified on theAcceptable Use Guidelines for Apple Pay on the Webpage on the Apple Pay Developer site.
- Uses the HTTPS protocol. For more information about this requirement, seeSetting Up Your Serverpage on the Apple Pay Developer site.
Setting Up Apple Pay
This section describes the requirements for setting up Apple Pay to process Apple Pay transactions through PrestaShop.
- Follow the instructions for enabling Apple Pay on theSetting Up Apple Paypage on the Apple Developer website. Before proceeding, ensure that you have completed these steps:
- Create a Merchant ID
- Create a Payment Processing Certificate
- Validate the merchant domain
- Create a Merchant Identity Certificate
- Download the Merchant Identity Certificate.
- Convert the downloaded certificate to a PEM format:openssl x509 -inform der -in merchant_id.cer -out merchant_id.pemAfter the certificate is converted, it displays in the Keychain Access menu.
- Double-click the certificate on the Keychain Access menu. The certificate is installed and the associated private key displays in the Keychain Access menu.
- Right-click the private key, select theExportoption, and export the key asmerchant_id.p12.
- Convert the exported private key to a KEY format:openssl pkcs12 -in merchant_id.p12 -out merchant_id.key -nodes
- Upload the converted key (merchant_id.key) and certificate (merchant_id.pem) files to your website server.
- Open PrestaShop Back Office and selectModules > Module Managerfrom the Dashboard. The Module Manager page opens.
- Find the Plugin in the Payment section on the Module Manager page, or enter Cybersource Official in the Search field and clickEnter.
- ClickConfigure. The Configure Cybersource Official page opens.
- Select thePAYMENT SETTINGStab 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.
- Go to the Google reCAPTCHA website and click theAdmin Consolelink.
- Complete these steps to register a new site:
- Enter a label that will be used to identify the site.
- Choose the Score based (v3) option for the reCAPTCHA type.
- Enter the domain on which PrestaShop is hosted.
- Enter the email address of the website owner.
- Check the box to accept the terms of service and clickSubmit.The reCAPTCHA site key and secret key are generated.
- Open PrestaShop Back Office and selectModules > Module Managerfrom the Dashboard. The Module Manager page opens.
- Find the Plugin in the Payment section on the Module Manager page, or enter Cybersource Official in the Search field and clickEnter.
- ClickConfigure. The Configure Cybersource Official page opens.
- Select theFRAUD MANAGEMENT SETTINGStab 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/paymentReporth
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
- Open a Linux terminal.
- Entercrontab-eto enter editor mode. For example:root@PrestashopQA4:/etc# crontab -e
- 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
- EnterCtrl + Xto close the editor.
- Enter thecrontab -lcommand to check the scheduled cron job. For example:
The scheduled cron job should appear on the screen. For example:root@PrestashopQA4:/etc# crontab -l15 * * * * curl https://www.dev.prestahop.cybsplugin.com/mps1760/module/mybank/paymentReport
Setting Up Cron Scheduler for Mac
- Open a Mac terminal.
- Entercrontab-eto enter editor mode.C02X63PRJG5J:~ $crontab -e
- 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
- EnterEsc + : + w + qto close the editor. The editor closes and displays this message:crontab: installing new crontab
- Enter thecrontab -lcommand to check the scheduled cron job.C02X63PRJG5J:~ $crontab -lThe 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
- Open the Task Scheduler app and clickCreate Task.The Create Task pane displays.
- Select theGeneraltab and enter a name for the task in theNamefield.
- Select theTriggerstab and clickNew.The New Trigger pane displays.
- Make the desired timing selections for the task in the New Trigger pane and clickOK.
- Select theActionstab in the Create Task pane and clickNew.The New Action pane displays.
- Select and enter this information in the New Action pane and clickOK.
- Action drop-down menu:choose Start a program.
- Program/script field:enter thecurlcommand.
- Add arguments (optional):enter the reporting URL.
- ClickOKin the Create Task pane to create the task. The new task displays in the Task Scheduler Summary.
Using the Plugin
The plugin provides merchants a frictionless way to process
payments, prevent fraud, and generate
reports within the
Business Center
while making it easy for customers to place and cancel orders, and save or update stored credit or
debit card information.Order Management
This section describes the order management process that occurs after a customer places
an order.
The order management process is handled using these PrestaShop office interfaces:
- customers use this interface to place and cancel orders, and save or update stored credit or debit card information.
- merchants use this interface to configure the Plugin and manage orders, which includes these tasks:
- Capture an authorization (multiple partial captures are also supported).
- Reverse an authorization (full authorization is supported).
- Void a capture (partial void is supported).
- Refund a capture (standard and partial refunds are supported).
- Void a refund (partial void is supported).
Order Status
Order status is triggered and updated when transactions are processed. The plugin supports custom and default statuses for orders.
Custom order statuses:
- Awaiting payment
- Awaiting cancel
- Cancel rejected
- Cancelled, refund initiated
- Payment pending for review
- Partial payment accepted
- Partial payment cancelled
- Payment cancelled
- Partial refunded (before shipped)
- Partial refunded (after shipped)
- Partial refund cancelled (before shipped)
- Partial refund cancelled (after shipped)
- Payment error
- Refund cancel error
- Payment cancel error
- Refund error
- Refund cancelled
- Order cancelled by merchant
Default order statuses:
- Payment accepted
- Cancelled
- Shipped
- Delivered
- Refunded
Only the shipped and delivered statuses can be manually updated.
Order Management Workflows
This section describes the order of events that the merchant completes after a customer
submits an order.
After-Authorization Workflow
This workflow comprises the sequence of events that occur after a customer places a new
order using PrestaShop Front Office. The workflow shows how the order status is updated
when the authorized transaction is captured or reversed (full authorization reversal).
- The new order displays in PrestaShop Back Office, and the order status isAwaiting payment.
- The merchant chooses one of these options:
- Standard capture.
- Partial capture.
- Cancel products. For a full authorization reversal, the merchant must also cancel the order, which requires that they select all the quantities and all the items included in the order.A partial authorization reversal is not supported.
- When the merchant initiates a full authorization reversal, the authorization is cancelled and the order status is set toCancelled.
- When the merchant initiates a multiple partial capture, they choose how many quantities to capture and whether to include the shipping costs.After multiple partial captures are processed, the order status is set toPartial payment accepted.
- When the merchant initiates a full capture, the entire authorization amount is captured, and the order status is set toPayment accepted.
After-Capture Workflow
This workflow comprises the sequence of events that occur after an authorization is
captured. The workflow shows how the order status is updated when the captured
transaction is refunded or voided.
- The merchant chooses one of these options:
- Standard refund.
- Partial refund
- Void capture.
- If the merchant voids the capture, the captured transactions are voided.When all quantities of the transaction are captured, the entire order is voided and the order status is set toPayment cancelled.If only a few quantities are captured, only the captured quantities are voided, and the order status is set toPartial payment accepted.
- If the merchant initiates a standard refundbeforeupdating the order status toshipped, the order status is set toPartial refunded (before shipped)until the refunded amount becomes equal to the captured amount. When the refunded amount becomes equal to the captured amount, the order status is set toRefunded.
- When the merchant selects a refundafterupdating the order status toshipped, the order status is set toPartial refunded (after shipped)until the refunded amount becomes equal to the captured amount. After the refunded amount becomes equal to the captured amount, the order status is set toRefunded.To refund the amount of an order, merchants can either generate a voucher or a credit slip for the refund. Depending on the type of refund they select and whether they issue a voucher or a credit slip, one of these actions occurs:
- When the merchant choosesGenerate a voucherfor a partial refund, the sum of the items is not refunded. Instead, a voucher is generated that can be used for future transactions.
- When the merchant choosesGenerate a voucherand enters the amount in the shipping costs field for a partial refund, then a voucher equal to the sum of the items and the shipping amount is generated.
- When the merchant choosesGenerate a credit slipfor a standard refund, the sum of the items is refunded.
- When the merchant chooses bothGenerate a credit slipandRepay shipping costsfor a standard refund, the sum of the items and the shipping amount are both refunded.
- When the merchant chooses bothGenerate a voucherandRepay shipping costsfor a standard refund, a voucher equal to the sum of the items and shipping amount is generated.
- When the merchant chooses bothGenerate a voucherandGenerate credit slipfor a standard refund, a voucher is generated and a refund for the sum of the items is not generated.
After-Refund Workflow
This workflow comprises the sequence of events that occur when the merchant voids a
refund under specific conditions:
- When the refund is processedbeforethe order is shipped, the refund is cancelled and the order status is set toPartial refund cancelled (Before shipped).
- When the refund is processedafterthe order is shipped, the refund is cancelled and the order status is set toPartial refund cancelled (After shipped).
- When the voided refund amount is equal to the refund amount, the refund is cancelled and the order status is set toRefund cancelled.
Customer Tasks
Customers can use the My Account option on the merchant's PrestaShop website to manage
orders and their payment information. The following sections contain the steps to
complete these tasks.
Saving Credit/Debit Card Information
Saving card information enables customers to use that information for future
transactions. Using PrestaShop Front Office, customers can save their card information
during the checkout process, or they can add their card information to their registered
PrestaShop accounts using the My cards feature.
If a customer wants to save their card
information during the checkout process, they can select the
Save my card
for future payment
option when entering their credit/debit card
payment (as shown below) during checkout.The card information can also be saved on the My cards
page in PrestaShop:
- Open PrestaShop Front Office.
- Go to the My cards section of the page and clickADD CARD.If no current address is associated with the customer account, the customer is prompted to add an address. The customer can enter the required address information and clickSave.If there is already an address associated with the customer account, the customer can select and use the address or add a new address.After the address information is complete and selected, the customer can update the card expiration information, if needed, or delete the existing card from the account.
- To update the expiration information for the card (expiration month/year), the customer clicksUpdate, or clicksDeleteto remove the card from the account. The customer can also change the billing address for the card by clickingChange.Customers can add only the number of cards that the merchant specified in the account configuration. The updated card information is tokenized and securely saved. The customer can use the saved card information for future transactions without having to enter that card information during the checkout process.
Selecting a Default Credit/Debit Card
When a customer has multiple cards associated with their account, they can
designate the default card. By default, the first card added to the account is set as
the default card. In the My cards page, the default card is identified with an asterisk
(*) that appears to the right of the card number.
To change the default card, the
customer follows these steps:
- Open PrestaShop Front Office.
- Open the My cards page. The page displays the saved cards associated with the account.
- Choose a card to set as the default card, and chooseMore > SET AS DEFAULT. The card is set as the default card.The default card cannot be deleted unless all other saved cards from the My cards section are deleted.
Cancelling an Order
This task provides the steps a customer takes to cancel an
order. They cannot cancel an order if the order is in review with the
merchant.
- Open PrestaShop Front Office.
- SelectMy Account > Order History. The Order history page displays the customer's orders.
- Select theDetailsicon for the order to cancel. The Order details page appears.
- Click theCancelicon to cancel the order.An Order cancellation confirmation notice appears.
- ClickYeson the Order cancellation confirmation notice to cancel the order.The order is cancelled and the order status is set to Cancelled.If the order was a sales transaction or was captured, the cancellation is sent to the merchant and the status is set toAwaiting cancel.After the customer cancels an order, the merchant can accept or reject the order cancellation (as instructed in Processing a Cancelled Order). If the merchant accepts the cancellation request, a refund for the order amount is initiated, and the order status is set toCancelled, refund initiated. If the merchant rejects the cancellation request, the order status is set toCancel rejected.
Merchant Tasks
Merchants use PrestaShop Back Office to manage orders. This section describes the steps
to complete these tasks.
Processing a Cancelled Order
When a customer cancels an order, a request is sent to the merchant, and the order
status is set to
Awaiting cancel
. Merchants can accept or reject an order that a
customer cancels. - Open PrestaShop Back Office and selectOrders > Ordersfrom the Dashboard.
- Locate and select the order the customer cancelled. The information for that order displays.
- Choose one of these options:
- ClickAccept cancellationto accept and process the cancelled order. A refund for the order amount is processed, and the order status is set toCancelled, refund initiated.
- ClickReject cancellationto reject the cancelled order. The order status is set toCancel rejected.
Processing a Merchandise Return
When a customer requests to return merchandise, the information appears on the
Merchandise Returns page in PrestaShop Back Office. Follow these steps to process the
return.
- Open PrestaShop Back Office and selectCustomer Service > Merchandise Returns. The Merchandise Returns page displays and identifies the order or orders for which customers have requested a return.
- Select the order for which you want to process the return. The Edit > Return Merchandise Authorization (RMA) menu displays.
- Choose one of these options from the Status drop-down menu and clickSave:
- Waiting for confirmation
- Waiting for package
- Package received
- Return completed
The status is updated for the order on the Merchandise Returns page. Next, you can proceed with selecting a return or refund option for the order. - SelectOrders > Ordersfrom the Dashboard.
- Select the order for which you want to process a return, and select one of these options:
- Return products
- Partial refund
Fraud Management
The plugin provides fraud management functionality
for merchants who also use the Cybersource
Business Center
. You can apply fraud management functionality to transactions in
these situations:- Fraud management is enabled in the plugin.
- You have a fraud management profile in theBusiness Center.
Fraud screening includes these features:
- Fraud Management Essentials (FME):used to enforce the rules created by the Cybersource Machine Learning System (MLS). Fraud management is used to define the merchant’s rules.
- Fraud Management Rules:
- When the decision status from theBusiness Centeris AUTHORIZED_PENDING_REVIEW or PENDING_REVIEW, the order is in review and the order status is set toPayment pending for review.
- When the decision status from theBusiness Centeris AUTHORIZED_RISK_DECLINED, the order is rejected and the order status is set toOrder cancelled by merchant.
The table below describes the possible decisions, outcomes, and timing that Decision
Manager uses when an order is triggered for review.
When the following transactions are in a Decision Manager review
state, certain settlement considerations apply:
- For authorizations:while accepting this transaction it is not recommended to settle it in theBusiness Center. When the transaction is settled in theBusiness Center, the follow-on services initiated from PrestaShop Back Office are impacted.
- For sales:
- The entire authorized amount should be settled in theBusiness Centerwhen accepting the transaction. When the settlement is not performed in theBusiness Center, the follow-on services initiated from PrestaShop Back Office fail.
- A follow-on void capture will not initiate from PrestaShop Back Office. While accepting review transactions, merchants should not select the settle option.
Decision | Execution Timing | Outcome of Decision |
---|---|---|
Monitor | Before authorization | Authorization is successful and no action
from the Decision Manager is required. Use this decision to understand
the outcome of a rule. |
Accept | Before authorization | The order is processed normally and is
placed successfully. |
Review | Before authorization | The authorization is successful, and
follow-on services are put on hold until the merchant accepts or rejects
it. The order status is set to Payment pending for review .
|
Reject | Before authorization | The order is rejected and the authorization
is not processed. The merchant is not able to view the order in
PrestaShop Back Office. |
Monitor | After authorization | The authorization is successful and no
action from Decision Manager is required. Use this decision to
understand the outcome of a rule. |
Accept | After authorization | The order is processed normally and placed
successfully. |
Review | After authorization | The authorization is successful, and
follow-on services are put on hold until the merchant accepts or rejects
it. The order status will be set to Payment pending for
review . |
Reject | After authorization | The original authorization is successful
and then is automatically reversed and the order status is set to
Order cancelled by merchant . |
Reporting
The plugin provides reporting functionality
for merchants who also use the
Business Center
. You can import these reports from the Business Center
into PrestaShop:- Transaction Request Report:includes details for individual transactions that are processed each day.
- Payment Batch Detail Report:includes transactions that are processed with the applications. This report is available shortly after captured transactions are batched.
- Conversion Detail Report:includes Case Management changes recorded in theBusiness Centerto ensure that updated orders are also included in PrestaShop. This report is generated at regular intervals and includes the results of the converted orders for each reviewer. This information provides an overview of all orders that were not immediately accepted.
Scheduling
The Plugin reporting
functionality works with a system scheduler to generate and update reports for
PrestaShop. There are some Cron Job modules available for PrestaShop, such as the
Cron Tab, that support reporting. Merchants can use any Cron Job module that
PrestaShop supports or any other online Cron service provider to generate reports.
Workflow
The reports are processed and orders are updated in PrestaShop as described in this
workflow:
- Orders with anAUTHORIZED_PENDING_REVIEWorAUTHORIZED_RISK_DECLINEDstatus are included in theps_cybersourceofficial_ordertable in the PrestaShop database.
- If a review is trigged for an order based on the profile rule in Decision Manager, aPayment pending for revieworder status displays for that order on the PrestaShop Back Office Orders page.
- The merchant uses theBusiness Centerto accept the order that is in review, and, if not already enabled, the merchant enables the reports using the Report Settings on the Plugin Configuration page.
- The scheduler runs the report at regular intervals according to the intervals the merchant configured. The order is accepted or rejected by the merchant in theBusiness Center, is retrieved, and the new status is updated asAUTHORIZEDorDECLINED. The updated order status displays in theps_cybersourceofficial_ordertable in the PrestaShop database.
- The original decision and the new decision are updated and displayed in theps_cybersourceofficial_conversion_detail_reporttable in the PrestaShop database.
- The order is updated asAwaiting paymentstatus for the authorization and displayed on the PrestaShop Back Office Orders page. The payment is accepted for the sale and any associated follow-on transactions (capture, void capture, refund, void refund, and full authorization reversal).
Testing
If you have not done so already, configure these settings
using PrestaShop Back Office. See Configuring Plugin Settings for
information about how to access these settings:
- General Settings:merchant ID, merchant key ID, and/or merchant secret key
- Payment Settings:applicable payment methods
After configuring the Plugin, complete this task to test the configuration using
PrestaShop Front Office to place an order and PrestaShop Back Office to manage the
order.
- Open PrestaShop Front Office to place an order.
- Enter any required personal information and select the payment method that you want to use to place the order.
- Enter the card information you want to use to place the order and clickPay. If the order is successful, an order confirmation message displays.
- Open PrestaShop Back Office to manage the order.
- SelectOrders > Ordersfrom the Dashboard. The Orders page displays and lists all active orders.
- Select and open the order you processed in Step 1. The order status for the order should displayAwaiting payment.
- ClickStandard Captureicon to capture the authorized amount, and clickYesto capture the entire order. The order status changes toPayment accepted.
- ClickStandard Refundto refund the full captured amount. The order status changes toRefunded.
- ClickVoid Refundto void the refunded amount. The order status changes toRefund cancelled.For more information about testing, including test cards, see
Upgrading
You can install a newer version of the plugin
using PrestaShop Back Office.
- Open PrestaShop Back Office and selectImprove > Modules > Module Managerfrom the Dashboard.
- Click the arrow next to the pluginConfigureicon and chooseUpgradefrom the drop-down menu.
Troubleshooting
This section might help you resolve specific issues that can occur during the
installation and upgrade processes for the plugin.
Issue: PrestaShop Language Pack Installation Error
You get a
1: Cannot download language pack "en"
error message when installing
the Plugin. To resolve this issue, complete these steps:
- Locate and open theTools.php file, which resides inhtdocs/PrestaShop root/Classesdirectory on your system.
- Search for and select this string in the Tools.php file:curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
- Replace the selected string with this string:curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, true);
- Save the file and reload your browser page.
Issue: Debug Mode is Enabled in Production
When debug mode is enabled in the production instance, you need to disable it.
- Open PrestaShop Back Office and selectConfigure > Advanced Parametersfrom the Dashboard. The Advanced Parameters page appears.
- SelectPerformancefrom the Advanced Parameters page.
- Set Debug mode toNo.
Issue: User Interface Appears Incorrectly After a Plugin Upgrade
After upgrading the Plugin, if the user interface looks incorrect, you need to clear
the cache.
- Open PrestaShop Back Office and selectConfigure > Advanced Parametersfrom the Dashboard. The Advanced Parameters page appears.
- From the Advanced Parameters page, clickPerformance.
- ClickClear Cache.
Configuring and Testing Email
Follow these steps to configure the email that customers receive during order
management.
- Open PrestaShop Back Office and selectAdvance Parameters > Emailfrom the Dashboard. The email page appears.
- Select these options from the Email section of the page to configure how email is sent:
- Send emails to: Customer service
- Set my own SMTP parameters (for advanced users ONLY)
- Both HTML and text formats
- Yes for log emails
- Select and specify this information for your SMTP parameters:
- Mail domain name: do not enter information (leave this field empty)
- SMTP server: enter the server domain. For example,smtp.gmail.com.
- SMTP username: enter the email address from which emails are sent. For example,csproduct@gmail.com.
- SMTP password: enter the password for the email address provided above.
- Encryption: select TLS
- Port: enter 587
- ClickSaveto save the configuration.
- Test your email configuration by entering an email address to which you want to send the test message, and clickSend a test email.
Configuring Order Status Visibility
You can choose to hide order status messages that you do not want customers to
view.
- Open PrestaShop Back Office, and selectCustomer Service > Order Messagesfrom the Dashboard.
- Click the pencil icon beside the order status message you would like to hide.
- In the Order status pane, selecthide this status in all customer orders.
- ClickSave.
Troubleshooting Assistance
For help with troubleshooting, contact GlobalPartnerSolutionsCS@visa.com and provide the following information:
- Summary of the issue
- Steps needed to reproduce the issue
- Platform version
- Plugin version
- Platform Merchant ID
- Configuration screenshots
- List of themes/additional extensions installed
- Log file and any other data or screenshots related to the issue