Updated the section on configuring web services to refer to a change in the
procedure where SOAP p12 certificates are uploaded to a section now called
Simple Order P12 Key File. See Configuring WebService.
Added note to the configuring section to ensure that the Test mode is used when testing. See
Configuring Shopify.
The testing section was revised to describe how to install and use a new test app. For more
information, see Reference Information.
WooCommerce
Updated the WooCommerce plug-in. For more information, see WooCommerce.
25.12.01
Oracle Netsuite
Removed Oracle Netsuite module from guide.
25.10.01
Shopify
Added note that when using the test server, ensure that the Test Mode
option is enabled. See Configuring
Shopify on page 122.
WooCommerce
Added note to the troubleshooting section to check with support services for configuration
guidance when your account is managed by a merchant services provider.
See Support and Troubleshooting on page 129.
25.09.02
PrestaShop
This revision contains only editorial changes and no technical
updates.
Shopify
The app now supports Shopify subscriptions.
Clarified that during installation, you use the transacting merchant ID
as your credentials. See Installing the Live
App.
25.09.01
This revision contains only editorial changes and no technical updates.
25.08.01
WooCommerce
Updated all information in this section. See WooCommerce.
VISA Platform Connect: Specifications and Conditions for
Resellers/Partners
The following are specifications and conditions that apply to a Reseller/Partner enabling
its merchants through
Visa Acceptance platform
. Failure to meet any of the specifications and conditions below is
subject to the liability provisions and indemnification obligations under
Reseller/Partner’s contract with Visa/Cybersource.
Before boarding merchants for payment processing on a VPC acquirer’s connection,
Reseller/Partner and the VPC acquirer must have a contract or other legal agreement
that permits Reseller/Partner to enable its merchants to process payments with the
acquirer through the dedicated VPC connection and/or traditional connection with
such VPC acquirer.
Reseller/Partner is responsible for boarding and enabling its merchants in
accordance with the terms of the contract or other legal agreement with the relevant
VPC acquirer.
Reseller/Partner acknowledges and agrees that all considerations and fees associated
with chargebacks, interchange downgrades, settlement issues, funding delays, and
other processing related activities are strictly between Reseller and the relevant
VPC acquirer.
Reseller/Partner acknowledges and agrees that the relevant VPC acquirer is
responsible for payment processing issues, including but not limited to, transaction
declines by network/issuer, decline rates, and interchange qualification, as may be
agreed to or outlined in the contract or other legal agreement between
Reseller/Partner and such VPC acquirer.
DISCLAIMER: NEITHER VISA NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR ANY ERRORS OR
OMISSIONS BY THE
Visa Platform Connect
ACQUIRER IN PROCESSING TRANSACTIONS. NEITHER VISA
NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR RESELLER/PARTNER BOARDING MERCHANTS OR
ENABLING MERCHANT PROCESSING IN VIOLATION OF THE TERMS AND CONDITIONS IMPOSED BY THE
RELEVANT
Visa Platform Connect
ACQUIRER.
About the Integrated Solutions
Visa Acceptance Solutions
offers integrated solutions to enhance payment acceptance,
fraud management, recurring billing, reconciliation, and reporting processes. Our
integrated solutions provide significant and vast use cases for product managers to
developers and business professionals. Reduce your operational costs through streamlined
payment integrations and improve customer satisfaction through flexible and secure
payment options. Our solutions can easily scale to your growing business needs, help
increase sales and conversion rates, and provide a clear value proposition to
distinguish your business from competitors.
for you. These solutions offer potential use cases that improve
operational efficiency, enhance security, and provide comprehensive reporting and
invoicing. Reduce the risk of errors, protect against fraudulent transactions, and
ensure accurate financial records through streamlined reconciliation processes. Our
solutions are ideal for various industries including financial services, healthcare,
manufacturing, and distribution. For example, in healthcare, our solutions can manage
payment operations efficiently, ensuring secure and accurate processing of payments for
services rendered, and support timely invoicing actions.
Open PrestaShop Back Office and from the Dashboard, choose
Modules >
Module Manager
.
Figure:
Dashboard
The Module Manager page opens.
Click
Upload a Module
on the Module Manager page.
Figure:
Module Manager page
The Upload a module pane appears.
Click
select file
from 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.
Figure:
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
click
Configure
to 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 configuration using the Apple Pay or
Google Pay Developer websites.
Merchant ID, which is a unique identifier for the merchant.
Merchant Key ID
IMPORTANT
Merchant Key ID is only required
if
Authentication Type
is set to
Shared
Secret
.
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
IMPORTANT
Merchant Secret Key is only
required if
Authentication Type
is set to
Shared Secret
.
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 might be
required 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:
This setting generates an authorize-only
transaction for a customer order.
Sale:
This setting generates a sale (bundled authorization
and capture) transaction for a customer order.
IMPORTANT
If an authorization returns
an
AVS FAILED
error when you are in
Sale
mode, merchants must manually review the transaction and decide
whether to cancel or accept the transaction. If they accept it, they
must manually capture it.
Payment Settings
Figure:
Payment Settings tab
Card Payment
When this setting is set to
Yes
, payment cards are
accepted as a payment method during checkout. The accepted card types
list enables the merchant to control which card types are accepted.
Google Pay
When this setting is set to
Yes
, Google Pay is accepted
as a payment method during checkout. The merchant's ID and name are
needed to use Google Pay. These can be configured from the Google Pay
Merchant account.
Apple Pay
When this setting is set to
Yes
, Apple Pay is accepted
as a payment method during checkout. The merchant's Apple Pay Merchant
ID, Path to Certificate file, and Path to Key file are needed to use
Apple Pay. These can be configured from the Apple Developer account.
eCheck
When this setting is set to
Yes
, customers can use
eCheck
as a payment method.
Fraud Management Settings
Figure:
Fraud Management Settings tab
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 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
challenged to authenticate when saving their card information.
IMPORTANT
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 how long to save the card information:
Saved Card Limit Count
: Maximum number of
cards a customer can save to their account.
Saved Card Limit Time Frame
: Time frame (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: The public key that renders reCAPTCHA on your
web page.
reCAPTCHA Secret key: The private key that provides validation to
the server.
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
Figure:
LATAM Settings tab
Installments
When 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. For more information about configuring installment
payments, see Enabling 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. For more
information about configuring grace period payments for Mexico (the only
country for which this setting currently applies), see Enabling Grace Period Payments.
Message-Level Encryption
Message-Level Encryption (MLE)
enables you to store
information or communicate with other parties while helping to prevent uninvolved
parties from understanding the stored information. MLE is optional and supported
only for payments services.
IMPORTANT
Before configuring MLE in the module, ensure you have created the .p12
certificate and securely stored the password. This certificate is required to
authenticate and encrypt messages.
The following steps are required for MLE
Key Directory Path
The path to the directory where you have stored the .p12
certificate
Key File Name
The name of your .p12 certificate
Key Password
The password to the .p12 you set when creating the certificate
Back Office to enable installment payments, which
are applicable for payments in Brazil, Chile, Colombia, Mexico, and Peru.
Open
PrestaShop
Back Office and select
Modules >
Module Manager
from the Dashboard. The Module Manager page
opens.
Find the Plugin in the Payment section on the Module Manager page, or enter
Visa Acceptance Solutions
Official
in the
Search
field and click
Enter
.
Click
Configure
. The Configure
Visa Acceptance Solutions
Official page opens.
Select the
LATAM SETTINGS
tab.
From the
Country
drop-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
click
Save
:
Processor
Installments (In Months)
Choose Card Types
IMPORTANT
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.
IMPORTANT
Card types selected in the
LATAM Settings tab must match the accepted card types specified in the
Card Payments payment settings. For more information, see Payment
Settings in the Configuration Settings
section.
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 select
Modules >
Module Manager
from the Dashboard. The Module Manager page
opens.
Find the Plugin in the Payment section on the Module Manager page, or enter
Visa Acceptance Solutions
Official
in the
Search
field and click
Enter
.
Click
Configure
. The Configure
Visa Acceptance Solutions
Official page opens.
Select the
LATAM SETTINGS
tab.
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.
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 challenged to authenticate 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.
IMPORTANT
The
Enforce Strong Customer
Authentication
setting is available only when the Payer
Authentication/
3-D Secure
in the general Plugin setting) and
Tokenization in the 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 select
Modules >
Module Manager
from the Dashboard. The Module Manager page
opens.
Find the Plugin in the Payment section on the Module Manager page, or enter
Visa Acceptance Solutions
Official
in the
Search
field and click
Enter
.
Click
Configure
. The Configure
Visa Acceptance Solutions
Official page opens.
Select the
FRAUD MANAGEMENT SETTINGS
tab.
Set the
Enforce Strong Customer Authentication
setting
to
Yes
.
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:
page on
the Apple Developer website. Before proceeding, complete these steps:
ADDITIONAL INFORMATION
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.pem
After 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.
from the Dashboard. The Module Manager page
opens.
Find the Plugin in the Payment section on the Module Manager page, or enter
Visa Acceptance Solutions
Official
in the
Search
field and click
Enter
.
Click
Configure
. The Configure
Visa Acceptance Solutions
Official page opens.
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, you must have a
Google Pay Developer account.
Generating a Google reCAPTCHA Site Key and Secret Key
The Google reCAPTCHA site and secret keys enable you to safely process Google Pay
payments. These keys protect your website when your customers use Google Pay to make
payments.
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 click
Submit
.The reCAPTCHA site key and secret key
are generated.
Open
PrestaShop
Back Office and select
Modules >
Module Manager
from the Dashboard. The Module Manager page
opens.
Find the Plugin in the Payment section on the Module Manager page, or enter
Visa Acceptance Solutions
Official
in the
Search
field and click
Enter
.
Click
Configure
. The Configure
Visa Acceptance Solutions
Official page opens.
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 specify 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:
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 at 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 a.m. and
10 a.m.
@reboot [command]
: Runs each time the server reboots.
*/5 * * * * [command]
: Runs every five minutes of every
day.
Setting Up Cron Scheduler for Linux
Open a Linux terminal.
Enter
crontab-e
to enter editor mode. For example:
root@PrestashopQA4:/etc# crontab -e
Editor mode displays and look similar to the editor mode shown in the image
below.
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:
Editor mode displays and look similar to the editor mode shown in the image
below.
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:
Order status is triggered and updated when transactions are processed. The plugin
supports these 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 is
Awaiting payment
.
The merchant chooses one of these options:
Standard capture
: When the merchant initiates a full capture, the entire
authorization amount is captured, and the order status is set to
Payment
accepted
.
Partial capture
: 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 to
P
artial payment accepted
.
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 to
Cancelled
.
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
: If the merchant initiates a standard refund
before
updating the order status to
shipped
, the
order status is set to
Partial 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 to
Refunded
.
Partial refund
: When the merchant selects a refund
after
updating the order status to
shipped
, the order status is set
to
Partial 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 to
Refunded
. If
only a few quantities are captured, only the captured quantities are voided, and
the order status is set to
Partial payment accepted
.
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 to
Payment
cancelled
.
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 chooses
Generate a voucher
for 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 chooses
Generate a voucher
and 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 chooses
Generate a credit
slip
for a standard refund, the sum of the items is
refunded.
When the merchant chooses both
Generate a credit
slip
and
Repay shipping costs
for a
standard refund, the sum of the items and the shipping amount are both
refunded.
When the merchant chooses both
Generate a
voucher
and
Repay shipping costs
for a
standard refund, a voucher equal to the sum of the items and shipping amount is
generated.
When the merchant chooses both
Generate a
voucher
and
Generate credit slip
for 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 processed
before
the order is shipped, the refund is
cancelled and the order status is set to
Partial refund cancelled
(Before shipped)
.
When the refund is processed
after
the order is shipped, the refund is
cancelled and the order status is set to
Partial 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 to
Refund
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 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 click
Add
Card
.
ADDITIONAL INFORMATION
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 click
Save
.
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.
To update the expiration information for the card, click
Update
, or click
Delete
to remove
the card from the account. The customer can also change the billing address for
the card by clicking
Change
.
Customers can only add 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 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 choose
More > Set as
Default
. The card is set as the default card. Note that the
default card cannot be deleted unless all other saved cards from the My cards
section are deleted.
Cancelling an Order
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 to
Cancelled, refund initiated
. If the
merchant rejects the cancellation request, the order status is set to
Cancel
rejected
. This task provides the steps to cancel an order. Customers
cannot cancel an order in review with the merchant.
Open
PrestaShop
Front Office.
Select
My Account > Order History
. The Order history
page displays the customer's
orders.
Select the
Details
for the order to cancel. The Order
details page
appears.
Click the
Cancel
to cancel the order. An Order
cancellation confirmation notice appears.
Click
Yes
on the Order cancellation confirmation notice.
ADDITIONAL INFORMATION
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 to
Awaiting cancel
.
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 select
Orders >
Orders
from the Dashboard.
Locate and select the order that the customer cancelled. The information for
that order displays.
Choose one of these options:
ADDITIONAL INFORMATION
Accept cancellation
to accept and process the
cancelled order. A refund for the order amount is processed, and the
order status is set to
Cancelled, refund initiated
.
ADDITIONAL INFORMATION
Reject cancellation
to reject the cancelled
order. The order status is set to
Cancel 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 select
Customer
Service > Merchandise Returns
. The Merchandise Returns page
appears and identifies the orders that customers want to return.
Select the order to process for a return. The
Edit > Return
Merchandise Authorization (RMA)
menu displays.
From the
Status
drop-down menu, choose an option. The
options are:
ADDITIONAL INFORMATION
Waiting for confirmation
Waiting for package
Package received
Return completed
Click
Save
. The status is updated for the order on the
Merchandise Returns page. Continue by selecting a return or refund option for
the order.
Select
Orders > Orders
from the Dashboard.
Select the order to process a return, and select one of these options:
ADDITIONAL INFORMATION
Return products
Partial refund
Fraud Management
The plugin provides fraud management functionality for merchants who also use the
Visa Acceptance Solutions
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 the
Business Center
.
Fraud screening includes these features:
Fraud Management Essentials (FME): used to enforce the rules created by the
Visa Acceptance Solutions
Machine Learning System (MLS). Fraud management defines the
merchant’s rules.
Fraud Management Rules:
When the decision status from the
Business Center
is
AUTHORIZED_PENDING_REVIEW
or
PENDING_REVIEW
, the order is in review and the order
status is set to
Payment pending for review
.
When the decision status from the
Business Center
is
AUTHORIZED_RISK_DECLINED
, the order is rejected and the
order status is set to
Order cancelled by merchant
.
The table below describes the possible decisions, outcomes, and timing that
Decision Manager
uses when an order is triggered for review.
IMPORTANT
When the following transactions are in a
Decision Manager
review state, certain settlement considerations apply:
For authorizations:
When accepting this transaction, it is not
recommended to settle it in the
Business Center
. When the transaction is
settled in the
Business Center
, the follow-on services initiated from
PrestaShop Back Office are impacted.
For sales:
The entire authorized amount should be settled in the
Business Center
when accepting the transaction. When the settlement
is not performed in the
Business 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 Manager Decisions, Execution Timings, and Outcomes for Orders
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 the
Business Center
to 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 are 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 supported by
PrestaShop
or any other online Cron service provider to generate
reports.
The reports are processed and orders are updated in
PrestaShop
as
described in this workflow:
Orders with an
AUTHORIZED_PENDING_REVIEW
or
AUTHORIZED_RISK_DECLINED
status are included in the
ps_cybersourceofficial_order table in the
PrestaShop
database.
If a review is trigged for an order based on the profile rule in
Decision Manager
, a
Payment pending for review
order status displays for that order on the
PrestaShop
Back Office Orders page.
The merchant uses the
Business Center
to 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 that the merchant configured. The order is accepted or rejected by
the merchant in the
Business Center
, the order is retrieved, and the
order status is updated as
AUTHORIZED
or
DECLINED
. The updated order status displays in the
ps_
Visa Acceptance Solutions
official_order
table in the
PrestaShop
database.
The original decision and the new decision are updated and displayed in the
ps_
Visa Acceptance Solutions
official_conversion_detail_report
table in the
PrestaShop
database.
The order is updated as
Awaiting payment
status 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
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 to place
the order.
Enter the card information to use for the order and click
Pay
. If the order is successful, an order
confirmation message displays.
Open
PrestaShop
Back Office to manage the order.
Select
Orders > Orders
from 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 display
Awaiting payment
.
Click
Standard Capture
to capture the authorized amount,
and click
Yes
to capture the entire order. The order
status changes to
Payment accepted
.
Click
Standard Refund
to refund the full captured
amount. The order status changes to
Refunded
.
Click
Void Refund
to void the refunded amount.
The order status changes to
Refund cancelled
.
For more information about testing, including test cards to use, see
Upgrading
You can install a newer version of the plugin using
PrestaShop
Back Office.
Open
PrestaShop
Back Office and from the Dashboard, select
Improve > Modules > Module Manager
.
Click the arrow beside the plugin
Configure
icon and
choose
Upgrade
from 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.
: Enter the transacting Merchant ID (MID)
assigned to you by Visa Acceptance Solutions.
API Key
: Enter the Key from your REST API Shared
Secret Key.
API Shared Secret Key
: Enter the Shared Secret from
your REST API Shared Secret Key.
Accepted Card Types
: Choose the card brands you want
to accept.
Configure Debug Mode
:
Yes
: Compiles detailed logs for every transaction. This
option is only recommended for the Test Environment or when troubleshooting
issues in Production.
No
: Only basic logging occurs.
Configure Message Level Encryption
:
Enabled
Yes
: Encrypts the full request message using JSON Web
Tokens before being transmitted to the Visa Acceptance Platform.
No
: Uses the HTTP Signature.
JSON Web Tokens use a digital certificate to prove who you are, while HTTP
Signature uses a shared secret key to confirm the message is genuine. Both methods
are PCI compliant.
Certificate File
: Upload the p12 certificate for your
Visa Acceptance Solutions
Merchant ID.
Key Password
: Enter the password that was used when you
created your p12 certificate.
Configure Secure Payment Methods
:
Enable
: Choose
Yes
to enable the
extension.
Title
: Enter the label your customers see on the
checkout page.
Payment Action
: Choose one of these options:
Authorize and Capture
: Captures the
transaction automatically when the authorization is approved.
Authorize only
: Sends an authorization
request and if approved, you must manually request a capture.
Payment Card Types
: Choose the card brands you want
to offer to your customers.
Allowed Payment Methods
: Choose the payment methods
you want to offer to your customers. These payment card types must be
enabled for your MID in the
Business Center
. See here for
details.
Select Layout
:
Embedded
: The payment widget appears inline
on the checkout page.
Sidebar
: The payment widget appears on the
right side on the checkout page.
Payment from Applicable Countries
:
All Allowed
: Uses the
Adobe Commerce
global settings to determine which
countries are available.
Specific Countries
: Specify which countries
you want to accept payments from.
Payer Authentication
/
3-D Secure
:
Choose
Yes
to enable
3-D Secure
.
Tokenization
: Choose
Yes
to enable
your customers to save their payment cards for future purchases.
Tokenization Title
: Enter the label you want your
customers to see when they pay with a saved card.
Saved Card Verification
: Choose
Yes
to request that your customer enter their card security code when paying
with a saved card.
Enforce Strong Customer Authentication
: Choose
Yes
to enforce a
3-D Secure
challenge when
a customer saves their card for the first time.
Order Management
The Visa Acceptance Solutions extension provides comprehensive order management
capabilities for handling transactions after they are processed. This includes capturing
authorized payments and processing refunds when necessary.
The order management features enable you to:
Capture authorized transactions to collect funds.
Process full or partial refunds for completed transactions.
Manage the payment lifecycle from authorization to settlement.
Capture
When you have the
Payment Action
set to
Authorization
, you must capture the transaction to collect the
funds.
Enter an order from the list of orders.
Click
Invoice
.
Check the item(s) that require capturing.
Ensure the drop-down capture option is set to
Capture
Online.
Click
Submit Invoice
.
Refund
To refund an order:
From the list of orders, choose the order you want.
Click on
Invoices
.
Select the appropriate invoice.
Click the
Credit Memo
button.
Check the item(s) to be refunded.
Verify and if necessary update the
Refund Totals
.
Click
Refund
.
Support & Troubleshooting
Get support for the Visa Acceptance Solutions extension by providing detailed information about your issue.
If you require support with this extension, sign into the Support Center to raise a case,
providing these details:
Summary of the issue
Steps needed to reproduce the issue
Platform version
Extension version
Visa Acceptance Solutions
Merchant ID
Configuration screenshots
List of themes/additional extensions installed
Log file and any other data or screenshots related to the issue
Upgrade
To upgrade from an earlier version of our
Adobe Commerce
extension, run these composer commands
Update the extension to the latest version:
composer require
Visa Acceptance Solutions
/module-payment:25.2.0
Run the setup upgrade command:
bin/magento setup:upgrade --keep-generated
Deploy static content:
bin/magento setup:static-content:deploy
Clean the cache:
bin/magento cache:clean
Adobe Commerce
You can integrate
Visa Acceptance Solutions
with the
Adobe Commerce
platform to process payments using Magento checkout. The
Adobe Commerce
extension supports popular payment methods, safeguards
payment data, minimizes fraud, and mitigates risks. This section describes the payment
management capabilities offered by
Visa Acceptance Solutions
through the
Adobe Commerce
integration.
This guide also applies to installing this extension in a Magento Open Source
environment.
Fraud Management
Fraud Management prevents fraud losses and gives you the flexibility to control
business practices and policies in real time. Fraud Management can help you
accurately identify and review potentially risky transactions while minimizing the
rejection of valid orders. Fraud Management comprises these capabilities:
Real-time fraud screening performed only during authorization
Device fingerprinting
On-demand Conversion Detail Report for changes in order status
Account Takeover Protection
Account Takeover Protection defends customers and merchants from fraudulent use of
online accounts. It monitors suspicious account changes and helps identify high risk
users at account creation and login. These capabilities comprise Account Takeover
Protection:
Real-time event screening of account creation, login, and changes
Device fingerprinting
Payer Authentication
Payer Authentication enables you to add support to your web store for card
authentication services offered by Visa
, Mastercard,
and other card brands. These
programs verify the cardholder’s identity directly with the card-issuing bank in
real time to increase payment security and reduce the risk of fraud. However, Payer
Authentication is not a fraud management service, and
Visa Acceptance Solutions
recommends that you configure a comprehensive fraud management program
such as
Decision Manager
in addition to Payer Authentication services. These services
comprise Payer Authentication:
Verified by Visa
Mastercard Identity Check
American Express SafeKey
Discover ProtectBuy
JCB
Diners
Maestro International
To comply with the recent mandates for French local processors that support Payer
Authentication, CMCIC, Atos and BNP processors no longer support these
combinations.
PayPal
The
Adobe Commerce Cloud
integration includes the PayPal payment
method. Processing your PayPal transactions through
Visa Acceptance Solutions
enables you to consolidate all payment types under a single gateway account,
simplify integration efforts, screen PayPal transactions for fraud with Decision
Manager, and streamline reporting. These services comprise PayPal:
Sessions
Check Status
Order
Authorization
Authorization Reversal
Capture
Sale
Refund
PayPal Credit
Billing Agreements
PayPal Credit
PayPal Credit is a payment method that allows merchants to accept a PayPal
transaction when the customer chooses to finance their purchase through PayPal.
Electronic Check (
eCheck
Service)
The
eCheck
Service a form of digital payment that serves the same
function as a physical check. When a merchant accepts an electronic check payment,
the funds are pulled directly from the customer’s checking or savings account. These
are the
eCheck
s include both debit and credit services.
eCheck
Service process refunds with the credit payment
service.
Online Bank Transfers
Online banking services enable customers to pay for goods by sending money from their
bank account to the merchant.
The
Adobe Commerce Cloud
extension supports the following payment
methods and corresponding online bank transfer services:
Bancontact
Sale
Check Status
Refund
Country: Belgium
iDEAL
Options
Sale
Check Status
Refund
Country: Netherlands
Tax Calculation
The Tax Calculation service provides real-time tax calculation during order checkout
for orders placed worldwide with your business.
Delivery Address Verification
The Delivery Address Verification service verifies the entered address and suggests
the recommended address for city, state, and zip code combinations in real time.
If this feature is enabled in the
Adobe Commerce Cloud
console, the
Adobe Commerce Cloud
extension verifies the delivery address on
shipping information updated by the user.
Klarna
Klarna credit provides a seamless user experience for online customer financing to
merchants of all sizes, which helps in increasing customer choice, loyalty and
growth in sales.
Google Pay
Google Pay is a digital wallet that enables customers to pay with any payment method
saved to their Google account.
Release Notes
This section provides information about functionality, bug fixes, and enhancements for
the
Implemented Direct Connection API Payer Authentication.
Removed dependency on
sales_order_grid
table for Google Pay and Secure Acceptance.
Apple Pay order cancel fixes.
PayPal billing address line 2 issue fixes.
Removed parenthesis for http signature request-target in core
and
eCheck
module
.
Upgraded version for the lcobucci/jwt from 3.4.2 to 3.4.6.
May 2023
Adobe Commerce Cloud
Visa Acceptance Solutions
3.5.5 is compatible with
Adobe Commerce Cloud
: 2.4.6, 2.4.5 p2, 2.4.5p1, 2.4.4 and PHP
8.2, 8.1
PHP support added for v 8.2.
Compatibility with
Adobe Commerce Cloud
v2.4.6 – Changed few components of zend framework to laminas as per the latest
Adobe Commerce Cloud
changes.
Fixed bugs related to supported card types and sandbox/production
issue in Apple Pay.
Fixed jQuery deprecated functions.
February 2023
Adobe Commerce Cloud
Visa Acceptance Solutions
3.5.4 is compatible with
Adobe Commerce Cloud
: 2.4.5 p2, 2.4.5 p1, 2.4.x, 2.3.x
New implementation for
eCheck
cron –
EventStatus
.
Fixed bug related to Strong Customer Authentication.
Removed required validation from reCAPTCHA fields.
Updated Klarna library from credit to payments.
Added
PaymentFlowMode
as inline and
PaymentMethodName
as
pay_now
in Klarna app session request.
Updated WSDL version to latest V1.206.
Add new payment reject status as
AUTHORIZED_RISK_DECLINED
for Decision Manager
reject.
Updating
Adobe Commerce
Follow these steps to update the
Visa Acceptance Solutions
bundle to the latest
version:
In your directory, navigate to the
Adobe Commerce
root
directory and find the
composer.json
file.
Open the
composer.json
file and in the
Require
field, change the version to the latest version of the plugin.
After you change the version in the
Require
field of the
composer.json
file, run the composer update command.
Configuring
Adobe Commerce
Customer payments can be managed through the
Adobe Commerce
or the
Visa Acceptance Solutions
Business Center
. This section describes the settings
you must configure in the
Business Center
as well as some general use cases that
are typical in the day-to-day management of your
Adobe Commerce
store. Contact Visa Acceptance Solutions for information about product availability and
enablment.
You must complete all of the configuration tasks in order to use the features offered in
the
Adobe Commerce
Cybersource integration.
Configuring Security Credentials
The module uses connection methods to access services that require their own security
credentials for authentication.
You must create and configure the SOAP toolkit key and REST API key for the
Adobe Commerce
to function properly.
If you do not have a
Business Center
account, go to the
website to create an account. To activate your merchant account, follow the instructions
that are emailed to you. Then log in to the
Business Center
to complete the
registration process. Be sure to store your merchant key ID for later use.
Creating a SOAP P12 Certificate
The
Adobe Commerce
integration uses the SOAP Toolkit API to
access several services.
integration requires REST API key
creation to use some services like Flex Microform and the Fraud Management
report.
From your
Business Center
account, you also need your merchant key ID
and shared secret key to enable the integration with
Adobe Commerce
. For information on how to generate a shared secret
key, see . Be sure
to store your key ID and shared secret key for later use.
Configuring Additional Backend Settings
Some services supported on
Adobe Commerce
require additional backend
setup on your
Business Center
account. Contact your
Visa Acceptance Solutions
account representative
to enable any of these services:
Payment Tokenization: Required by the module for credit card processing
Decision Manager
Payer Authentication
PayPal Express Checkout
eCheck
Service
Online Bank Transfers
Tax Calculation
Klarna
Click to Pay
: Enabled in the
Business Center
Apple Pay: Enabled in the
Business Center
Configuring Backend Settings
Follow these steps to access the configuration settings in the administration section
of your
Adobe Commerce
console:
Go to the
Adobe Commerce
administration console.
On the left navigation panel, click
Stores
.
Under Settings, click
Configuration
.
On the Configuration page, click
Sales
to expand the menu.
Click
Payment Methods
.
Choose
OTHER PAYMENT METHODS >
Visa Acceptance Solutions
.
ADDITIONAL INFORMATION
Complete all of the required fields in the sections and subsections of the settings to
configure the
Visa Acceptance Solutions
payment module and other payment methods. Expand
each section to complete the fields.
Configuring General Settings
The settings under the General section apply to all payment methods. Follow these steps to complete this section:
From the Cybersource setting, click the arrow to expand the General
section.
From the
Debug Mode
drop-down list,
choose
Yes
to troubleshoot using the
Adobe Commerce
logs (
cybs.log
). Diagnostic information
is stored in log files on the
Adobe Commerce
web server.
From the
Sort Order
drop-down list, change the default
module sort order.
In the
Show Exact Rejection or Error Message to Users
option set to:
No
to display general error messages according to
Adobe Commerce Cloud
in all rejection and error cases.
Yes
to display general error message according to the
responses from
Visa Acceptance Solutions
in all rejection and error
cases.
In the
Override Payment Error Route Path
field, enter
the error page route path. When you leave the default
Use system
value
box checked, the checkout or cart route is used if no path
is
entered.
Configuring WebService
The WebService configuration includes the default
Adobe Commerce
merchant ID (applies to all the payment methods), the REST shared key, and the
SOAP key detail. Follow these steps to complete the configuration:
Click
WebService Configuration
to expand the
section.
In the
Merchant ID
field, enter your
Visa Acceptance Solutions
merchant ID.
From the
Test Mode
drop-down list, choose:
Yes
to use the
Business Center
testing
environment.
No
to use the production
Business Center
.
Optionally, in the
Developer ID
field, you can enter
the developer ID. The ID cannot exceed eight characters. You can also
request that
Visa Acceptance Solutions
assign you a developer ID.
In the Simple Order P12 Key File section, upload the SOAP p12 certificate and
then enter the Key Password. If you did not generate a key, see Creating a SOAP p12 Certificate for
instructions.
Proper configuration of the SOAP WebService is required for the functioning
of other services including
Tax
Calculation, Secure Acceptance, PayPal, Account Takeover Protection,
and
Apple Pay. If you experience issues with these modules, verify
that the SOAP WebService options are configured correctly. The SOAP p12
Certificate must have the correct password and the Test Mode option must
match the correct environment for the
Visa Acceptance Solutions
Business Center
(test).
In the
REST API Shared Secret Key
field, enter the
Shared Secret key you generated from the
Proper configuration of the REST Web Service is required for other services
including Flex Microform,
Decision Manager
,
, Google Pay, and the Account Updater. If you experience issues with
these modules, verify that the REST Web Service options are configured
properly. The API Key Detail and API Shared Secret Key must have the correct
value, and the
Test Mode
option must match the
environment for the
Visa Acceptance Solutions
Business Center
.
Configuring Device Fingerprinting
Device Fingerprinting is used with
Decision Manager
for all relevant payment
methods. If you are not using
Decision Manager
, you must disable this
module. Follow these steps to configure device fingerprinting:
Click
Device Fingerprint
to expand the section.
In the
Active
field, choose
Yes
to activate it or
No
to deactivate it if you are not
using
Decision Manager
.
In the
Org ID
field, enter the value provided to you. To
obtain this value either for test or production, contact your
Visa Acceptance Solutions
representative.
Configuring the Delivery Address Verification Service
The Delivery Address Verification Service acts as an additional layer of address
verification and normalization on the shipping page. Follow these steps to configure
this section:
Click
Delivery Address Verification Service
to expand the
section.
From the
Address verification
drop-down list, choose
Yes
to enable this service or
No
to disable this service.
From the
Address Force Normalization
drop-down list, choose
Yes
to require the use of suggested address alternatives
or
No
to make suggested address alternatives optional.
Configuring Credit Card Payments
Follow these steps to configure
Visa Acceptance Solutions
credit card
payments:
From the
Enabled
drop-down list, choose
Yes
to activate or
No
to
deactivate the credit card payment method.
In the
Title
field, enter the text you want to display
as the name for credit card payment method. This name will be used for Web
Mobile, Flex Microform, and Silent Order Post.
In the
Payment API
drop-down list, choose
Payment API
to have an authorization performed and
post card data to
Visa Acceptance Solutions
. Choose
SOAP Toolkit
API
to have the card information tokenized. The SOAP service
separately requests authorizations.
In the
Checkout Flow Type
drop-down list, choose a
desired checkout type.
ADDITIONAL INFORMATION
Visa Acceptance Solutions
recommends that you choose
Flex
Microform
. Flex Microform is a REST-based Microform
Integration to access new enhancements, easier configuration, and updated
technology.
You will use all of the benefits from the Hosted Checkout
and Checkout API.
The customer never leaves your checkout page and
is a potential SAQ A qualification. For more information about Microform
Integration, see Microform Integration.
In the
CSRF Token Expiration Time (Seconds)
field, enter
the expiration time in seconds. This is the lifetime of the SOP security token
used to prevent card testing attacks. For the default of 600 seconds, leave this
field blank.
Configuring Strong Customer Authentication
When payer authentication is enabled and a transaction is declined with reason code
478
(Strong Customer Authentication required), another request is sent
from the
Adobe Commerce
module for the same order. The customer must
complete a
3-D Secure
challenge.
To configure this setting, click
Strong Customer Authentication
to
expand the section. In the
Enforce Strong Customer Authentication when saving a
card
drop-down list, choose
Yes
to have the cardholder
complete a
3-D Secure
challenge while saving a card.
Configuring Credit Card Settings
Follow these steps to complete the Credit Card Settings section:
Click
Credit Card Settings
to expand the
section.
From the
Payment Action
drop-down list,
choose
Authorize Only
or
Authorize and Capture
.
Authorize Only reserves funds during checkout and captures
when making an invoice. The Authorize and Capture payment
action authorizes and captures funds during the customer
checkout.
From the
Auth Indicator
drop-down list,
choose the purpose of the authorization.
From the
New Order Status
field
drop-down list, choose the order status assigned to the
order when successfully paid, or leave the default
Use system value
box checked
for
Processing
order status.
From the
Ignore AVS
drop-down list,
choose
Yes
to have the results of AVS
verification ignored.
In the
Ignore CVN
field, choose
Yes
to have the results of
CVN verification ignored.
In the
Skip Fraud Management for
Tokenization
field, choose
No
to
have
Skip Decision Manager
field set
to
false
for Secure Acceptance tokenization
requests and set to
true
otherwise.
In the
Skip Pre-Authorization Check for
Tokenization
field, choose to
No
to have the
skip preauthorization
field
set to
false
for Secure Acceptance
tokenization requests and set to
true
otherwise.
In the
Pass expiration date for tokenized card via
SOAP
field, specify the card expiration
date with SOAP Toolkit Authorization Calls for card
tokenization.
In the
Credit Card Types
box, choose
which card types you want to accept. This only applies to
Checkout API and
Flex Microform
configuration.
This option is not used for Hosted
Checkout.
In the
Payment from Applicable Countries
field, leave the default
Use system
value
box checked to accept credit card
payments from the countries choose, or clear the
Use system value
box to
specify countries in the next field.
To specify the countries from which to accept credit card
payments, in
Payment from Specific
Countries
box choose the
countries.
From the
Override secure acceptance
locale
drop-down list, leave the default
Use system value
box checked
to use the store locale language.
Configuring Payer Authentication
The Payer Authentication (
3-D Secure
) protocol reduces fraud and security to online
payments.
3-D Secure
adds frictionless authentication and improves the user
experience. You must have the SOAP Toolkit configured to use this service.
Follow these steps to configure the Payer Authentication section:
Click
Payer Authentication
to expand the section.
From the
Enabled
drop-down list, choose
Yes
to activate the Payer Authentication Module or
No
to deactivate it.
From the
Credit Card Types
field box, choose the card
types to be enabled for Payer Authentication.
Configuring Save Card for Later Service
Follow these steps to configure Save Card for Later Service settings:
Click
Save Card for Later Service
to expand the section.
From the
Enabled
drop-down list, choose
Yes
to enable the customer to save their credit card information
securely for later use.
In the
Saved Card Section Title
field, enter the name of the
saved cards payment method.
From the
Save Card for Later for Admin orders
drop-down list,
choose
Yes
to enable storing card details for orders placed in the
admin area.
From the
Use CVV for Saved Credit Cards
drop-down list, choose
Yes
to enable the customer to enter the Card Security Code when
paying with a stored card.
From the
Use CVV for Saved Credit Cards in Admin
drop-down list,
choose
Yes
to allow the merchant to enter the customer’s Card
Security Code when the customer is paying with a stored card.
Click
Save Config
.
Configuring reCAPTCHA
The
Adobe Commerce
SOAP Toolkit API provides an option to use
reCAPTCHA. This feature is essential in protecting the merchant's store from brute force
attacks. Most of the time, the reCAPTCHA is invisible to normal users, but it will
provide a visible challenge when necessary. The module providing reCAPTCHA is an
optional package.
Installing reCAPTCHA
To install reCAPTCHA, run the
following command for composer installation:
composer require
Visa Acceptance Solutions
/module-recaptcha
Creating reCAPTCHA
Follow these steps to
generate Google reCAPTCHA Site Key and Secret Key:
Visit the Google reCAPTCHA website: .
Log in to the reCAPTCHA Admin Console.
Click the
Create
icon.
Fill in the required details.
After you submit the details, the reCAPTCHA site key and secret key are generated.
Use these keys to configure the module in Back Store.
Configuring reCAPTCHA in
Adobe Commerce
Go the
Adobe Commerce
console.
On the Payment Methods page, under the
Visa Acceptance Solutions
settings, click
reCaptcha
to expand the section.
From the
Enabled
drop-down list, choose
Yes
to activate, or
No
to
deactivate reCAPTCHA.
In the
Website API Key
field, enter your site key
obtained from reCAPTCHA Admin Console.
In the
Secret API Key
field, enter your secret key
obtained from reCAPTCHA Admin Console.
From the
reCAPTCHA type
drop-down list, choose the
reCAPTCHA type that you choose for your API keys.
In the
Badge position
field, choose the reCAPTCHA badge
position.
In the
reCAPTCHA language
field, choose a language code
for reCAPTCHA or leave the
Auto
option selected.
Click
Save Config
.
Clear the
Adobe Commerce
cache.
Configuring the
eCheck
Payment Module
The
Visa Acceptance Solutions
eCheck
module enables customers to make purchases using a routing
number and an account number. During checkout, an
eCheck
transaction
request is sent to
Visa Acceptance Solutions
. If successful, the transaction is sent
to the Automated Clearing House (ACH).
The
Adobe Commerce
queries
Visa Acceptance Solutions
periodically
to check on the status of each pending
eCheck
transaction. In
response,
Visa Acceptance Solutions
provides an updated transaction status, known as a
Payment Event Type
. Various outcomes can occur during ACH processing. For
each pending transaction included in the
Visa Acceptance Solutions
response, the
Adobe Commerce
determines whether a transaction remains
pending, settles, or is rejected.
You can configure these
eCheck
payment event types :
Pending Event Type: No change is made to the transaction or order status. The order
remains in Payment Pending state.
Reject Event Type: The order is cancelled.
Accept Event Type: An invoice is prepared for that order, and the order status
changes to processing.
Testing
eCheck
Payment Settings
You can test the
eCheck
Payment Event Types using two
Adobe Commerce
settings that simulate possible event types during
the processing of the requested report. While the status request goes to
Visa Acceptance Solutions
, the
Adobe Commerce
ignores the
returned Payment Event Type in the response and uses the Test Event Type
instead.
Follow these steps to test the
eCheck
Payment Event
Types:
Click
eCheck
to expand the
section.
From the
Enabled
drop-down list, choose
Yes
to enable the
eCheck
payment
method.
In the
Title
field, enter the text that is displayed to
customers as the name of this payment method.
Configure the payment statuses for these event types:
ADDITIONAL INFORMATION
In the
Accept Event Type
box, choose which
payment statuses will mean accept, and signify the receipt of funds and
move the order status to processing.
In the
Pending Event Type
box, choose which
payment statuses will mean pending.
In the
Reject Event Type
box, choose which
payment statuses will mean reject because they were rejected after
processing by ACH despite being initially accepted during checkout.
Configure how to accept the
eCheck
payment method:
ADDITIONAL INFORMATION
To accept the default country configuration, in the
Payment
From Applicable Countries
field, ensure the
Use system value
box is checked.
To specify any other countries you will accept the
eCheck
payment method from, clear the
Use
system value
box and in the
Payment From
Specific Countries
box, choose the countries.
To require customers to enter a drivers license number, from the
Enabled Drivers License Number
drop-down list, choose
Yes
. For
TeleCheck
, contact a
representative to see if this field is required.
To require the customer to enter the check number, from the
Enabled
Check Number
drop-down list, choose
Yes
.
These processors have specified whether it is required or optional:
ADDITIONAL INFORMATION
Chase Paymentech Solutions
: Optional.
Cybersource ACH Service
: Not used.
: Optional on debits, and required on credits.
TeleCheck
: Strongly recommended on debit requests,
and optional on credits.
To require an agreement at the checkout page, from the
Agreement
Required
drop-down list, choose
Yes
.
From the
SEC code
drop-down menu, choose a code that
specifies the authorization method for the transaction.
In the
Sort Order
field, enter the number of entries to
be sorted on a page.
Click
Save Config
.
Configuring Fraud Management
You must configure the
Adobe Commerce
to work with Fraud Management
to use all of the features.
Follow these steps to configure Fraud Management in
Adobe Commerce
:
Click
Fraud Management
to expand the section.
From the
Enable Fraud Management CRON Job
drop-down list,
choose
Yes
.
In the
Fraud Management fail email sender
option, leave the
Use system value
box checked.
In the
Fraud Management fail email template
option, leave the
Use system value
box checked.
From the
Settle Fraud Management accepted order automatically
drop-down list, choose
Yes
.
Expand the
On-Demand Job
section to see the
Report
Date
field.
Enter a date to download an accepted or rejected transactions report, and click
Run
.
Click
Save Config
.
Fraud Management Orders
The
Decision Manager
rule setting and the response received for
authorizations and sales service determine whether the
Adobe Commerce Cloud
marks the orders as Pending Review.
On the
Decision Manager
Case Management page, when you change an order from
REVIEW
to
REJECT
or
ACCEPT
, the
Adobe Commerce Cloud
updates
payment transaction states periodically (by cron every two minutes) by contacting
Cybersource and querying for changes.
In the settings, find the
Adobe Commerce Cloud
Cron settings and
configure them to trigger an
Adobe Commerce Cloud
task. The task
looks for
Decision Manager
changes in the
Business Center
and
updates the
Adobe Commerce Cloud
Orders accordingly.
If the module detects a change in state, it updates the order status in the
Adobe Commerce Cloud
from Pending Review to one of these states:
Processing
Pending
Closed
If an order is Pending Review in
Decision Manager
, you
cannot prepare an invoice in the
Adobe Commerce Cloud
until
Decision Manager
accepts it.
Fraud Management Refunds
Decision Manager
must either accept or reject an order before issuing a
refund. If you reject an order in
Decision Manager
, an Authorization
Reversal for the order automatically occurs as part of the Cron process that queries
for updates in
Decision Manager
.
Configuring Custom Fields
Decision Manager
supports custom fields known as merchant-defined data
fields. You must configure the fields inside
Decision Manager
in the
Business Center
to use them. The Module for the
Adobe Commerce Cloud
sends 10 of these fields.
Follow these steps to add
custom fields provided by the
Adobe Commerce Cloud
:
Log in to the
Business Center
and go to
Decision Manager
> Shared Configuration > Custom Fields.
Choose
Merchant Custom Fields
.
To add a field, click
ADD CUSTOM FIELD
, enter a
name, and choose an
order element
. Use the list below
to map the correct names and elements for each field:
Logged-in customer:
Merchant_defined_data1
Account creation date:
Merchant_defined_data2
Purchase History Count:
Merchant_defined_data3
Last Order Date:
Merchant_defined_data4
Member account age:
Merchant_defined_data5
Repeat customer:
Merchant_defined_data6
Coupon Code Used:
Merchant_defined_data20
Discount Amount:
Merchant_defined_data21
Gift Message:
Merchant_defined_data22
Order Source:
Merchant_defined_data23
Shipping Method Code:
Merchant_defined_data31
Shipping Method Description:
Merchant_defined_data32
Click
Save
.
For detailed instructions on how to add custom fields, see the
Decision Manager
Guide. In the
Business Center
, go to
the left navigation panel, and choose
Decision
Manager > Documentation
> Guides
.
Configuring Apple Pay
To use Apple Pay, you must meet these prerequisites:
Have a valid Apple Developer Account.
All pages that incorporate Apple Pay must be served over HTTPS.
Follow these steps to configure Klarna payments.You can use the default merchant ID
or you can manually configure a new merchant ID:
Click
Klarna
to expand the section.
From the
Enable
drop-down list, choose
Yes
or
No
to activate or
deactivate Klarna.
From
Title
box, enter the text to display to customers
on the checkout page.
From the
Use Default Merchant ID
drop-down list, leave
Yes
selected to use the Merchant ID given in Web
Service Configuration under General Settings. Choose
No
to enter another merchant ID and transaction key in the next two fields.
If you choose not to use the default merchant ID, in the
Merchant
ID
field, enter a different merchant ID.
In the
Transaction Key
field, enter the transaction key
for the merchant ID you entered.
From the
New Order Status
drop-down list, choose the
order status assigned to the order successfully paid with
Visa Acceptance Solutions
.
Configure which countries you will accept Klarna from:
ADDITIONAL INFORMATION
To accept payment from the default countries, in the
Payment
From Applicable Countries
field, leave the
Use system value
box checked.
To specify other countries, clear the
Use system
value
box and in the
Payment From Specific
Countries
box, choose the countries from where you want
to accept Google Pay.
Configuring PayPal
Follow these steps to configure the PayPal Express Checkout, PayPal Credit, and
PayPal Billing Agreement:
Click
PayPal
to expand the section.
From the
Enable
drop-down list, choose
Yes
or
No
to activate or
deactivate PayPal.
In
Title
box, enter the text to display to customers on
the checkout page.
From the
New Order Status
drop-down list, choose the
order status assigned to the order successfully paid with Cybersource.
In the
Merchant ID
field, enter your
Adobe Commerce Cloud
merchant ID.
From the
PayPal Redirection Type
drop-down list, choose
Traditional Express Checkout
to redirect the customer
PayPal Payment Page, or choose
In-Context Express Checkout for a
PayPal
pop-up to appear for customers to complete payment.
From the
Payment Action
drop-down list, choose
Authorize Only
to check the account for validity, but
not charge until the order is approved and invoiced. Choose
Authorize
and Capture
to charge the PayPal account at the time the order
is submitted.
Configure which countries you will accept PayPal from:
ADDITIONAL INFORMATION
To accept payment from the default countries, in the
Payment
From Applicable Countries
field, leave the
Use system value
box checked.
To specify other countries, clear the
Use system
value
box and in the
Payment From Specific
Countries
box, choose the countries from where you want
to accept PayPa.
From the
Enable PayPal Credit
drop-down list, choose
Yes
to enable financing through PayPal Credit.
In the
PayPal Credit Title
box, enter the text customers
will see as the title of PayPal Credit payment option.
From the
Enable PayPal Billing Agreements
drop-down
list, choose
Yes
to allow registered customers to create
a billing agreement for faster purchases.
In the
Sort Order
box, enter a numeric value to place
this payment method amongst all the other
Adobe Commerce
payment methods.
Configuring Bank Transfers
Online banking services enable customers to pay for goods using direct online bank
transfers from their bank account to your
Adobe Commerce
merchant
account.
Click
Bank Transfer
to expand the section. In the
Store Name
field, enter the name you want customers to
see on their bank transfer invoices.
Configuring iDEAL
Follow these steps to configure an iDEAL payment:
Click
iDEAL
to expand the section.
In the
Enable
drop-down list, choose
Yes
to activate the iDEAL bank transfer (or
No
to deactivate iDEAL bank transfer.)
In
Title
box, enter the text to display to customers
on the checkout page.
In the
Use Default Merchant ID
field, leave
Yes
selected to use the merchant ID given in the
Web Service Configuration under General Settings page. Choose
No
to enter another merchant ID and transaction
key in the next two fields.
If you choose not to use the default merchant ID, enter your
Visa Acceptance Solutions
Merchant ID
in the
Merchant ID
field.
In the
Transaction Key
field, enter the transaction
key for the merchant ID you entered.
In the
Allowed Currencies
box, choose which
currencies you will accept payment.
In the
Sort Order
box, change the default module
sort order.
Configure which countries you will accept Klarna from:
ADDITIONAL INFORMATION
To accept payment from the default countries, in the
Payment From Applicable Countries
field,
leave the
Use system value
box checked.
To specify other countries, clear the
Use system
value
box and in the
Payment From
Specific Countries
box, choose the countries from
where you want to accept iDEAL.
Configuring Bancontact
Follow these steps to configure Bancontact bank transfer payments:
Click
Bancontact
to expand the section.
In the
Enable
drop-down list, choose
Yes
or
No
to activate or
deactivate Bancontact Bank Transfer.
In
Title
box, enter the text to display to customers
on the checkout page.
In the
Use Default Merchant ID
field, leave
Yes
selected to use the Merchant ID given in Web
Service Configuration under General Settings. Select
No
to enter another merchant ID and transaction
key in the next two fields.
If you choose not to use the default merchant ID, enter your
Visa Acceptance Solutions
merchant ID in the
Merchant ID
field.
In the
Transaction Key
field, enter the transaction
key for the merchant ID you entered.
In the
Allowed Currencies
box, choose the currencies
with which to accept payment.
In the
Sort Order
box, change the default module
sort order.
Configure which countries you will accept Klarna from:
ADDITIONAL INFORMATION
To accept payment from the default countries, in the
Payment From Applicable Countries
field,
leave the
Use system value
box checked.
To specify other countries, clear the
Use system
value
box and in the
Payment From
Specific Countries
box, choose the countries from
where you want to accept Bancontact.
Configuring WeChat Pay
WeChat Pay is a digital wallet that enable customers to make mobile payments and
online transactions. Customers who have provided bank account information can use
the app to pay bills, order goods and services, transfer money to other users, and
pay in stores if the stores have a WeChat payment option.
Follow these steps to configure WeChat Pay:
Click
WeChat Pay
to expand the section.
From the
Enable
drop-down list, choose
Yes
to activate or deactivate WeChat Pay (or
No
to deactivate WeChat Pay.)
In the
Sort Order
box, change the default module sort
order.
In
Title
box, enter the text to display to customers on
the checkout page.
In the
Use Default Merchant ID
field, leave
Yes
selected to use the merchant ID from the Web
Service Configuration section under General Settings. Choose
No
to enter another merchant ID and transaction key
in the next two fields.
If you choose not to use the default merchant ID, enter your
Visa Acceptance Solutions
merchant ID in the
Merchant ID
field.
In the
Transaction Key
field, enter the transaction key
for the merchant ID you entered.
In the
QR Code Expiration Time
field, enter an
expiration time in seconds for the WeChat pay QR code.
In the
Check Status Frequency
field, enter an interval
in seconds between transaction status checks.
In the
Max Status Requests
field, enter a limit for
transaction status checks.
Configure which countries you will accept WeChat Pay from:
ADDITIONAL INFORMATION
To accept payment from the default countries, in the
Payment
From Applicable Countries
field, leave the
Use system value
box checked.
To specify other countries, clear the
Use system
value
box and in the
Payment From Specific
Countries
box, choose the countries from where you want
to accept WeChat Pay.
In the
Success/Failure Message Delay
field, enter a
delay in seconds between the transaction check and redirection to the result
page.
In the
Check Status query Simulated Response
field,
choose a simulated status check response code for testing.
Click
Save Config
.
Configuring Taxes
Visa Acceptance Solutions
offers a service that calculates taxes to be charged on
orders. You must configure your settings in order to receive accurate results
Contact your
Visa Acceptance Solutions
representative to have this feature enabled.
This feature includes activation of sandbox capabilities as well.
Before configuring the Tax Calculation service, you must have the SOAP Web Service
configured. For more information, see Configuring Security Credentials.
To use the Tax Calculation Service, you must have the Product Tax Class codes and
has a setting for Tax Class.
This setting defines the product and how it should be taxed. Contact your
Visa Acceptance Solutions
representative for a list of available product tax class IDs
and your tax consultant for advice on which IDs you should use for products you
sell.
Follow these steps to set the product tax class IDs in
Adobe Commerce
:
Go the
Adobe Commerce
Admin console.
On the left panel, click
Stores
, and then click
Tax Classes
.
On the Tax Classes page, click
Add New
to create a new
tax class entry for each tax class ID that your representative provides.
In the
Tax Class Code
field, enter the code provided to
you.
From the
Tax Class Type
drop-down list, choose
Product
.
Click
Save
.
Complete these steps for each tax class ID.
Configuring
Visa Acceptance Solutions
Tax Services Settings
Follow these steps to configure
Visa Acceptance Solutions
Tax Services in the
Adobe Commerce Cloud
:
Go to the
Adobe Commerce Cloud
admin console, and in the left
panel, click
Stores
, and then click
Configuration
.
On the Configuration page, go to
Sales > Tax > Cybersource Tax
Services
.
From the
Tax Calculation
drop-down list, choose
Yes
to activate the
Visa Acceptance Solutions
Tax
Services per your business requirements.
In the
Nexus regions
box, select the regions where your
business has a physical presence in the U.S. or Canada.
In the
Customer countries to calculate Tax for
box,
choose the countries for which you will calculate tax.
In the
Customer Tax classes to exclude from Tax
calculation
box, choose the customer tax classes to exclude from
tax calculation.
In the
Ship From
fields, enter the city, postcode,
country, and region from which the orders are shipped.
In the
Acceptance
fields, enter the city, postcode,
country, and region in which you will accept or approve customers' orders.
In the
Origin
fields, enter the city, postcode, country,
and region of the point of origin from which the order is picked up.
In the
Merchant VAT
fields, enter the merchant VAT
seller registration number.
Click
Save Config
.
Calculating Taxes for Shipping Rates
You might have taxes calculated for shipping rates if your site offers dynamic
shipping rates from a carrier that is presented to the customer at checkout.
However, if you offer a flat-rate shipping charge, you might want to add taxes
to that flat rate.
Follow these steps to add taxes to flat shipping rates:
On the Configuration page, go to
Sales > Tax > Tax
Classes
.
From the
Tax Class for Shipping
drop-down list,
select the product tax code that references the taxes applied to shipping
services.
Click
Calculation Settings
.
In the
Shipping Prices
field, choose
Excluding Tax
when the shipping rates need to be
taxed. Select
Including Tax
when the shipping rates
already include taxes , and no taxes are applied through the
Visa Acceptance Solutions
tax service.
Click
Save Config
.
Configuring Transactional Emails
When an order is flagged for
Decision Manager
review, the customer is not
informed that their transaction was not fully accepted. If a manual review leads to
a rejection of the transaction, the customer is then informed that their order is no
longer active. You can configure the email sent to the customer.
Follow these steps to configure the transactional emails sent to the customers:
Go to the
Adobe Commerce
console.
On the left panel, choose
Marketing
.
Click
Email Templates
.
In the table, find the Template column, and click the
DM Fail
Transaction
template row. The Template Information page
opens.
On the Template Information page, complete the required information in the
template name, subject, and content text boxes.
Click
Save Template
.
Configuring Cron Settings
Follow these steps to configure Cron settings for
Decision Manager
:
In the
Adobe Commerce
console.
On the left panel, click
Stores
.
Go to
Configuration > Advanced
> System > Cron (Scheduled Tasks
).
Scroll down and click
Cron configuration options for
group:dm
.
Complete the required fields.
Click
Save Config
. For further instructions on how to configure
Cron settings, see Cron (scheduled tasks).
Configuring Tokens
When a customer is logged in and is checking out, their card data can be stored in a
secured
Visa Acceptance Solutions
data center. After the card data is saved, a token
is provided to you through this module. This token represents the customer record. When
a returning customer uses your checkout, they can opt to use a previously stored card so
they don't have to enter their card data again.
When a token is used, the customer is still redirected to the
Visa Acceptance Solutions
Hosted Payment page for payment confirmation. If a customer chooses to checkout as a
guest, the token system is not used.
Saving a Card for Later Use
To save the card, log in or register a new customer account. During the checkout
process, check the
Save for later use
box. After the order is
placed, the card information is securely saved with
Visa Acceptance Solutions
.
Managing the
Adobe Commerce
Tokens
Customers who are logged in can delete their tokens at any time. To do so, they must
visit the My Account section of the
Adobe Commerce
and choose
the
Stored Payment Methods
menu item. Customers can use the
delete links beside any stored tokens to remove a stored token.
Paying with Tokens
To pay the order with a stored card, the customer chooses it from the list at the top
of the Billing and review checkout page.
Multi-Shipping Feature
The plugin supports the multi-shipping feature only for the
Adobe Commerce
registered users when they place orders with stored credit
cards.
Node Implementation
The plugin does not support multiple-node implementation.
Support
If you require support with this software, create a support ticket at support and
provide this information:
Summary of the issue
Steps to reproduce the issue
Magento platform version
Visa Acceptance Solutions
plug-in version
Visa Acceptance Solutions merchant ID
Configuration screenshots
All the themes/additional extensions that are installed
Log files
To retrieve log files, navigate to this path in the root directory of Magneto:
Magento Folder Name\var\log
.
These log files are needed:
system.log
debug.log
cybs.log
exception.log
OpenCart
The plugin for OpenCart provides a payment solution for
merchants using OpenCart to manage their orders. This section describes the payment
methods and services the Plugin provides.
Supported payment methods
These are the supported payment methods for OpenCart:
Credit and debit cards
eCheck
Click to Pay
Supported payment services
These are the supported payment services available for OpenCart:
Payment acceptance services
Authorization only
Sale (bundled authorization and capture)
Electronic check debit (sale) for
eCheck
payment
method
Order management services
Capture an authorization
(not for
eCheck
)
Multiple partial captures (not for
eCheck
)
Standard and partial refunds
Standard and partial void captures
(not for
eCheck
)
Standard and partial void refunds
Full authorization reversal
(not for
eCheck
)
Token Management Service
(
TMS
) for credit and debit
cards 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 theses
Business Center
reports into OpenCart
:
Transaction Request Report
Payment Batch Detail Report
Conversion Detail Report
Release Information
This section provides information about the releases for the plugin.
Release Version
Release Date
Support End Date
Version 22.1.0
October 25, 2022
October 14, 2025
Version 23.1.0
December 8, 2023
December 7, 2026
Version 23.1.0 includes the following enhancements:
Updated authentication signature
Added DAV enable/disable button for admin configuration
Updated reCAPTCHA key generation tooltip URL
Fix for target origin issue for different domain in the flex form capture
context
Compatible with OpenCart versions 3.0.3.7 and 3.0.3.8
Version 22.1.0
Initial release.
Installation
Before you install the plugin, make sure that these requirements are met:
and browse to the file you downloaded to your local system.
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
click
Configure
to configure the Plugin.
Configuration Overview
This section describes how to set up the plugin.
The following table shows where to access the plugin configuration settings.
From the left navigation panel in
OpenCart
Back Office, select
Extensions
and follow the path indicated in the table for the configuration
settings you want to configure.
Configuration Settings
Settings
Path
General Configuration
Report Configuration
Order Status Configuration
Extensions > Extensions > Modules >
Visa Acceptance Solutions
Configuration
Unified Checkout
Payment Action
Payer Authentication
Status
Sort Order
Tokenization
Limit Saved Card Rate
Enforce SCA for Saving Card
Extensions > Extensions > Payments >
Visa Acceptance Solutions
Unified Checkout
eCheck
Status
Sort Order
Extensions > Extensions > Payments >
Visa Acceptance Solutions
eCheck
Enable Basic Configuration
This section describes the required and optional basic configuration settings for the
plugin.
To enable Basic Configuration, follow these steps:
In
OpenCart
Back office, navigate to
Extensions
>
Extensions
>
Modules
>
Visa Acceptance Solutions
Configuration
.
Click the
Edit
icon.
In the General Configuration tab of the Edit
Visa Acceptance Solutions
Configuration Module pane, from the drop down list or text box, select or enter
a setting.
Click the
Save
icon.
Repeat for each required setting and each optional setting you want to enable.
Required Settings
These settings are required for using the plugin:
Sandbox Mode
Set to
Enable
to operate in Sandbox (T) mode. You can
test new changes in this mode and no funds are affected.
Set to
Disable
to operate in Production (Live)
mode.
Merchant ID
Enter the
Business Center
Merchant ID or Organization ID, which is a
unique identifier for the merchant.
Merchant Key ID
Enter your REST Shared Secret Key generated from within the
Business Center
. This specific key authenticates and authorizes the
merchant's integration with the gateway.
Merchant Secret Key
Enter the complimentary Secret key that is generated at the same time as the
Merchant Key ID. It is used for secure communication between the merchant's
online store and a payment gateway.
reCAPTCHA Site key
For each request, this key returns a score based on the user interactions
with your site. Based on these scores, you can take appropriate actions for
your site, such as allowing or blocking users.
reCAPTCHA Secret key
This key authorizes communication between the plugin's backend and the
reCAPTCHA server to verify the user's response. The secret key should be
kept safe for security purposes.
Optional Settings
These settings are optional for using the plugin.
Fraud Management
Click
Enable
to enable merchants to identify and prevent fraudulent
activities.
Delivery Address Verification
Click
Enable
to enable merchants to verify the delivery address.
Device Fingerprint
Click
Enable
to enable merchants to identify and track devices accessing
an online store.
Developer ID
Identifier for the developer that helps integrate a partner solution with
Visa Acceptance Solutions
. This settings is only required for
Visa Acceptance Solutions
System Integrators.
Status
Click
Enable
for the
Visa Acceptance Solutions
integration to be active
and visible at checkout.
Payment Action
Click
Enable
to enable card payments for Authorize Only or Sale
(Authorization and Capture) for front office transactions.
Enhanced Logs
Click
Enable
to generate logs that can be accessed by selecting
Configure
>
Advanced
Parameters
>
Logs
.
Visa Acceptance Solutions
strongly recommends that you map your Order Status
responses to your preferred order status under the Order Status Configuration
section.
Enable
Unified Checkout
This section describes the required and optional configuration settings for
Unified Checkout
for the plugin.
To enable Card Payment follow these steps:
In
OpenCart
Back office, navigate to
Extensions >
Extensions > Payments >
Visa Acceptance Solutions
Unified Checkout
.
Click the
Edit
icon.
In the Edit
Visa Acceptance Solutions
Unified Checkout
pane, from the drop down list or text box, select
or enter the setting you want.
Click the
Save
icon.
Repeat for each required setting and each optional setting you want to set.
Follow these steps to enable Enforce Strong Customer Authentication:
Open
OpenCart
Back Office and select
Extensions
>
Extensions
>
Payments
>
Visa Acceptance Solutions
Unified Checkout
.
Select the
Edit
icon.
From the drop down menu next to Enforce SCA for Saving Card, select
Enable
.
Click the
Save
icon.
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:
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 a.m. and
10 a.m.
@reboot [command]
: Runs every time after the server
reboots.
*/5 * * * * [command]
: Runs every five minutes of every
day.
Setting Up Cron Scheduler for Linux
Open a Linux terminal.
Enter
crontab-e
to enter editor mode. For example:
root@OpencartQA4:/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:
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:
Order status is triggered and updated when transactions are processed. The plugin supports custom and default status states for
orders.
Custom order status states:
Cancel error
Canceled
Canceled Reversal
Chargeback
Complete
Denied
Expired
Failed
Order cancelled by merchant
Partial Refunded
Partial Voided
Payment error
Payment pending for review
Pending
Processed
Processing
Refund Error
Refunded
Reversal
Shipped
Void Error
Voided
Default order status states:
Processed
Canceled
Shipped
Delivered
Refunded
Only the shipped and delivered status states 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
OpenCart
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
OpenCart
Back Office and the order
status is
Pending
.
The merchant chooses one of these actions:
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 to
Order cancelled by
merchant
.
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 to
Processing
.
When the merchant initiates a full capture, the entire authorization amount is
captured and the order status is set to
Processed
.
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 selects one of these actions:
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 to
Payment cancelled
.
If
only a few quantities are captured, only the captured quantities are voided
and the order status is set to
Partial payment accepted
.
If the merchant initiates a standard refund
before
updating the order
status to
shipped
, the order status is set to
Partial 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 to
Refunded
.
When the merchant selects a refund
after
updating the order status to
shipped
, the order status is set to
Partial refunded (after
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 to
Refunded
.
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 chooses
Generate a voucher
for 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 chooses
Generate a voucher
and 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 chooses
Generate a credit
slip
for a standard refund, the sum of the items is
refunded.
When the merchant chooses both
Generate a credit
slip
and
Repay shipping costs
for a standard refund, the sum of the items and the shipping amount
are both refunded.
When the merchant chooses both
Generate a
voucher
and
Repay shipping
costs
for a standard refund, a voucher equal to the
sum of the items and shipping amount is generated.
When the merchant chooses both
Generate a
voucher
and
Generate credit
slip
for 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 processed
before
the order is shipped, the refund is
cancelled and the order status is set to
Voided
or
Partially Voided
.
When the refund is processed
after
the order is shipped, the refund is
cancelled and the order status is set to
Voided
or
Partially Voided
.
When the voided refund amount is equal to the refund amount, the refund is
cancelled and the order status is set to
Voided
or
Partially Voided
.
IMPORTANT
OpenCart
does not provide an option to return
Gift Certificates. For orders associated with Gift Certificates, the services mentioned
below are not available:
Front Office Cancel
Back Office Cancel
Void a Capture
Customer Tasks
Customers can use the
My Account
option on the merchant's
OpenCart
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
OpenCart
Front Office, customers can save their card
information during the checkout process, or they can add their card's information to
their registered
OpenCart
accounts using the
Visa Acceptance Solutions
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 during checkout.
The card information can also be saved using the
Visa Acceptance Solutions
My Cards page in
OpenCart
:
Open
OpenCart
Front Office.
Click
My Account > Managed Stored Credit Cards >
Visa Acceptance Solutions
My Cards > Add New 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 click
Save
.
If an address is already associated with the customer account, the customer
can select and use the address or add a new address.
When 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 (expiration month/year) for the card,
under
Saved Cards
the customer clicks the blue arrow
beneath
More
, then clicks either
Update
, or
Delete
to remove
the card from the account.
ADDITIONAL INFORMATION
Customers can only add 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 will be set as the default
card. In the
Visa Acceptance Solutions
My Cards page, the default card is
identified using an asterisk (*) that appears to the right of the card number.
To change the default card, the
customer follows these steps:
Open
OpenCart
Front Office.
Open the
Visa Acceptance Solutions
My Cards page. The page displays the saved
cards associated with the account.
Choose the card to set as the default card and select
More > SET AS
DEFAULT
. The card is set as the default card.
ADDITIONAL INFORMATION
The default card cannot be deleted unless all other saved cards from the
Visa Acceptance Solutions
My Cards section are deleted.
Cancelling an Order
This task describes the steps a customer takes to cancel an order. They cannot cancel
an order if the order is in review with the merchant. The Cancel option is also not
available in direct Settlement for Captured
and
eCheck
orders.
Open
OpenCart
Front Office.
Select
My Account > Order History
. The Order history
page displays the customer's orders.
Select the View icon for the order. The
Order details page
appears.
Click the
Cancel Order
icon to cancel the order. A
Cancel Order confirmation notice appears.
Click
Yes
on the Cancel Order confirmation notice to
cancel the order.
ADDITIONAL INFORMATION
Above the Order History, a notification appears stating
Success: Entire
order was successfully cancelled.
The order is cancelled and the order
status is set to
Canceled
.
If the order was a sales transaction or was captured, the cancellation is sent
to the merchant and the status is set to
Canceled
.
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 to
Refunded
. If the merchant rejects the
cancellation request, the order status is set to
Denied
.
Merchant Tasks
Merchants use
OpenCart
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
Cancelled
. Merchants can accept or reject an order that a
customer cancels.
Open
OpenCart
Back Office and select
Orders
from the Dashboard.
Click the box beside the order the customer cancelled.
Click the View icon. Under Order Details, the information for that order
displays.
Under
Add Order Status
, choose the order status that describes your processing of the cancellation.
Processing a Merchandise Return
When a customer requests to return merchandise, the information appears on the
Merchandise Returns page in
OpenCart
Back Office. Follow these
steps to process the return.
Open
OpenCart
Back Office and select
Sales >
Returns
. The Product Returns page displays and identifies the
order or orders for which customers have requested a return.
Click the box beside the order that you want to process the return and then
click the Edit icon. The Edit Product Return page displays.
In the Product Information and Reason for Return pane, choose one of these
options from the
Return Action
drop-down menu:
Credit issued
Refunded
Replacement Sent
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.
Select
Orders
from 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
Business Center
. You can apply fraud management functionality to transactions
when:
Fraud management is enabled in the plugin.
You have a fraud management profile in the
Business Center
.
Fraud screening includes these features:
Fraud Management Essentials (FME):
used to enforce the rules created by
Visa Acceptance Solutions
Machine Learning System (MLS). Fraud management is used
to define the merchant’s rules.
Fraud Management Rules:
When the decision status from the
Business Center
is
AUTHORIZED_PENDING_REVIEW or PENDING_REVIEW, the order is in review and the
order status is set to
Payment pending for review
.
When the decision status from the
Business Center
is
AUTHORIZED_RISK_DECLINED, the order is rejected and the order status is set
to
Order cancelled by merchant
.
The table below describes the possible decisions, outcomes, and timing Decision Manager
uses when an order is triggered for review.
IMPORTANT
When these 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 the
Business Center
. When the transaction is
settled in the
Business Center
, the follow-on services initiated from
OpenCart Back Office are impacted.
For sales:
The entire authorized amount should be settled in the
Business Center
when accepting the transaction. When the settlement
is not performed in the
Business Center
, the follow-on services
initiated from OpenCart Back Office fail.
A follow-on void capture does not trigger from OpenCart Back Office.
While accepting review transactions, merchants should not select the
settle option.
Decision Manager Decisions, Execution Timings, and Outcomes for Orders
Decision
Execution Timing
Outcome of Decision
Monitor
Before authorization
Authorization will be 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 will be 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 OpenCart
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 is 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 OpenCart:
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 the
Business Center
to ensure that updated orders are also
included in
OpenCart
. 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
OpenCart
. There are some Cron Job modules
available for
OpenCart
, such as the Cron Tab, that support
reporting. Merchants can use any Cron Job module that
OpenCart
supports, or any other online Cron service provider to generate reports.
The reports are processed and orders are updated in
OpenCart
using this workflow:
Orders with an
AUTHORIZED_PENDING_REVIEW
or
AUTHORIZED_RISK_DECLINED
status are included in the
ps_cybersourceofficial_order
table in the OpenCart database.
If a review is trigged for an order based on the profile rule in Decision
Manager, a
Payment pending for review
order status displays for that
order on the
OpenCart
Back Office Orders page.
The merchant uses the
Business Center
to accept the order that is in
review, and, if not already enabled, 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 the
Business Center
, is retrieved, and the new status is
updated as
AUTHORIZED
or
DECLINED
. The updated order status
displays in the
op_cybersourceofficial_order
table in the
OpenCart
database.
The original decision and the new decision are updated and displayed in the
op_cybersourceofficial_conversion_detail_report
table in the
OpenCart
database.
The order is updated as
Awaiting payment
status for the authorization
and displayed on the
OpenCart
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 OpenCart Back
Office:
After configuring the Plugin, complete this task to test the configuration using
OpenCart Front Office to place an order and OpenCart Back Office to manage the
order.
Open OpenCart Front Office to place an order.
At Checkout, enter any required personal information and select the payment
method you want to use to place the order.
Enter the card information you want to use to place the order and click
Confirm Order
. If the order is successful, an order
confirmation message displays.
Open OpenCart Back Office to manage the order.
Select
Orders
from the Dashboard. The Orders page
displays and lists all active orders.
Select the checkbox next to the order you processed in Step 1. Then click the
View icon. The order status for the order should display
Pending
.
Click
Capture
to capture the authorized amount, then
Yes
. The order status changes to
Processed
.
Click
Partial capture
to capture part of the authorized
amount. The order status changes to
Processing
.
Click
Cancel
to cancel the order. The order status
changes to
Order Cancelled by Merchant
.
ADDITIONAL INFORMATION
For more information about testing, including test cards, see
Upgrading
You can install a newer version of the plugin using
OpenCart
Back
Office.
To uninstall
Visa Acceptance Solutions
Payment, navigate to
Extensions > Extension Types > Payments
and then
uninstall all of the
Visa Acceptance Solutions
payment modules.
To uninstall
Visa Acceptance Solutions
Tax, under the same Extension
dropdown, select
Order Totals
and uninstall
Visa Acceptance Solutions
Tax.
To uninstall the
Visa Acceptance Solutions
Payment extension, under the
Extension dropdown, select
Modules
, and uninstall the
Visa Acceptance Solutions
Payment extension.
Navigate to the Extensions tab and click
Installer
, then
click
Delete
to remove the
Visa Acceptance Solutions
extension.
Navigate back to the Extensions tab and click
Modification
, then click
Refresh
.
To install the new
Visa Acceptance Solutions
Payment extension, follow the
steps mentioned in Installation.
These Visa Acceptance Solutions products are optional. If you choose to use any of
these products, they must be enabled and configured for your Merchant ID:
This information is a version history and release notes for the
Cybersource Official Plugin
PrestaShop extension.
Version 7.0.0
Enhancements:
PrestaShop 9 support
Hummingbird Theme compatibility
Replaced Microform with Unified Checkout
Apple Pay, Click to Pay, Google Pay, and ACH and eCheck were included in Unified
Checkout, removing individual components
Latin America processing logic was removed.
Version 6.3.1
Enhancements:
PrestaShop 8.2.3 support
Bug Fixes:
Installation error
Version 6.3.0
Enhancements:
Message Level Encryption
CVV capture for transactions with saved cards was removed.
PrestaShop 8.2.1 support
Support for PrestaShop 1.7.x was ended.
Earlier Versions
For a complete release history including versions 6.2.1, 6.2.0, 6.1.0, 5.1.0, 4.2.0,
4.1.0, 3.1.0, 2.10, and 1.x, refer to the complete release notes documentation.
Installation
Follow these steps to install the
Cybersource Official Plugin
extension for
PrestaShop.
Go to the PrestaShop Marketplace and download our extension.
Log into your PrestaShop back office.
Go to
Modules > Module Manager > Upload a module
.
Upload the module downloaded from the marketplace.
Configuration
This is the complete configuration guide for the
Cybersource Official Plugin
PrestaShop extension, including minimum and optional settings.
To configure the
Cybersource Official Plugin
extension for PrestaShop, go to
Modules > Module Manager
. Scroll down to
Visa Acceptance Solutions
Official and click
Configure
.
It is recommended to click
Save
after working on each
configuration tab.
Minimum Configuration
As a minimum to accept payments with
Visa Acceptance Solutions
, configure these
settings.
General Settings Tab
Payment Option Label
: This text is displayed on your
checkout page to your customers.
Sandbox Mode
:
Yes
: Choose for testing your
Visa Acceptance Solutions
test account.
No
Choose for live transactions.
Merchant ID
: The transacting Merchant ID (MID) that
Visa Acceptance Solutions
assigned to you.
Merchant Key ID
: The Key from your REST API Shared Secret
Key.
Merchant Secret Key
: The Shared Secret from your REST API
Shared Secret Key.
Accepted Card Types
: Choose the card brands to
accept.
Payment Settings Tab
Card Payments
: To enable, set to
Yes
.
Payment Action
:
Authorize
: Sends an authorization request and if
approved, you must manually request a capture.
Sale
: Captures the transaction automatically if
the authorization is approved.
In the Sale mode, if an authorization returns an
AVS Failed
error,
the merchant must manually review the transaction and decide whether to cancel or
accept the transaction. If the merchant accepts the transaction, the merchant must
manually capture the transaction.
Message Level Encryption
Message Level Encryption (MLE) uses certificates that ensure each message is securely
encrypted and tied to the sender's verified identity, without needing to share
secret keys in advance. MLE provides stronger authentication, easier key management,
and better protection against fraud or tampering.
A shared secret uses the same key for both sending and receiving messages, meaning
both parties must securely exchange and protect that key in advance. While MLE can
be simpler, it offers less identity verification and can be more vulnerable if the
key is compromised.
Save the file, reload your browser, and attempt installation again.
Upgrade
To upgrade to the latest version of the PrestaShop extension, go to
Modules > Module Manager
. Scroll down to
Visa Acceptance Solutions
Official and click
Upgrade
.
Appendix
This is additional information about report scheduling for the
Cybersource Official Plugin
Prestashop extension.
Report Scheduling
Schedulers for Linux and Mac systems are set up using a Cron Tab. The scheduler for a
Windows system is configured using the Windows Task Scheduler app.
When configuring a schedule for generating a specific report, use this format:
: All changes occur as a single atomic
operation. If any error occurs during the job, the system rolls
back all changes to maintain data consistency.
False
: No automatic rollback is applied.
Merchants must handle transaction logic manually. This is often
preferred for large batch jobs.
ExecuteScriptModule.TimeoutInSeconds
: Set the
function timeout value.
Device FingerPrint
Device FingerPrinting collects information about the device used when paying for an order and can assist in fraud screening decisions.
Go to
Merchant Tools > Site Preferences > Custom Preferences >
Cybersource_DeviceFingerprint
.
Enable the
Enable DeviceFingerprint Service
option.
In the
Organization ID
field, enter the Organization ID.
Contact support if you do not know this value.
In the
ThreatMetrix URL
field, enter the URL that points
to the JavaScript that generates and retrieves the fingerprint of the
device.
In the
TTL (Time to Live)
field, enter how many
milliseconds to wait before generating a new fingerprint for any given customer
session.
Delivery Address Verification
To verify the customers shipping address during checkout, configure Delivery Address
Verification services.
Go to
Merchant Tools > Site Preferences > Custom Preferences >
Visa Acceptance Solutions
_DeliveryAddressVerification
.
Enable the
Delivery Address Verification Services
option.
Tax Calculation
To calculate local taxes once the customer enters their address at checkout,
configure the Tax Calculation services.
Go to
Merchant Tools > Site Preferences > Custom Preferences >
Cybersource_TaxConfiguration
and set these options:
Enable the
Enable Tax Calculation
field.
Configure these tax settings:
ADDITIONAL INFORMATION
List of Nexus States
: List the states to
calculate tax for.
List of Nexus States to Exclude
: List the
states to not calculate tax for.
Merchants VAT Registration Number
: Enter
your VAT registration number if you have one.
Default Product Tax Code
: Enter the
default tax code to use for products in the basket without a tax
code.
Purchase Order Acceptance City
Purchase Order Acceptance State Code
Purchase Order Acceptance Zip Code
Purchase Order Acceptance Country
Code
Purchase Order Origin City
Purchase Order Origin State Code
Purchase Order Origin Zip Code
Purchase Order Origin Country Code
Ship From City
Ship From State Code
Ship From Zip Code
Ship From Country Code
RESULT
IMPORTANT
If you enable Tax Calculation and do not specify any states in
List of Nexus States or List of Nexus States to Exclude, Tax Calculation assumes
every state or province is taxable. You can leave either the
List of
Nexus States
or the
List of Nexus States to
Exclude
as empty, but both cannot be empty.
Message Level Encryption
Message Level Encryption (MLE) uses certificates to ensure each message is securely
encrypted and tied to the sender's verified identity, without needing to share secret keys
in advance.
MLE provides stronger authentication, easier key management, and better protection
against fraud or tampering.
A shared secret uses the same key for both sending and receiving messages, meaning
both parties must securely exchange and protect that key in advance. While MLE can
be simpler, it offers less identity verification and can be more vulnerable if the
key is compromised.
Administration > Operations > Private Keys and
Certificates
and importing the extracted
.crt
. Make a note of the
alias.
Enable Message Level Encryption, by going to
Merchant Tools > Site Preferences > Custom Preferences >
Cybersource_MLE
.
Enable the
Enable Message-Level Encryption
option.
In the
Alias of the Certificate
field, enter the Alias
from when the certificate was imported.
In the
Certificate Serial Number
field, enter the serial
number from the
Visa Acceptance Solutions
_SJC_US certificate.
Order Management
Salesforce
B2C Commerce does not natively support order management functions. This cartridge has functions that can be utilized to process captures and authorization reversals.
IMPORTANT
These functions must be customized before use in the
Salesforce
B2C Commerce user interface.
Capture
The capture function can be found in the script
scripts/http/capture.js
. A
working example is available in the ServiceFrameworkTest-TestCaptureService
controller.
Reference the capture.js object and make this request:
var captureObj = require("~/cartridge/scripts/http/capture.js");
var serviceResponse = captureObj.httpCapturePayment(requestID, merchantRefCode, paymentTotal, currency);
The resulting serviceResponse object contains the full response object generated by
the request. The contents of this object determine your logic in handling errors and
successes. These are the Capture request parameters:
The authorization reversal function can be found in the script called
scripts/http/authReversal.js
. A working example is in the
ServiceFrameworkTest-TestAuthReversal controller.
Reference the AuthReversal.js object and make this request:
var reversalObj = require("~/cartridge/scripts/http/authReversal.js");
var serviceResponse = reversalObj.httpAuthReversal(requestID, merchantRefCode, paymentTotal, currency);
The resulting serviceResponse object contains the full response object generated by
the request. The contents of this object determine your logic in handling errors and
successes. These are the Authorization reversal request parameters:
Authorization Reversal Request Parameters:
requestID: The
Visa Acceptance Solutions
Request ID from the initial
authorization.
merchantRefCode: The
Salesforce
Order Number
purchaseTotal: The reversal amount
currency: Currency Code
Customization
The
Visa Acceptance Solutions
cartridge for
Salesforce
B2C
Commerce has built-in custom hooks that can be utilized to customize the request data that
is sent to each service.
These hooks can send additional custom data, such as, if you want to include Merchant
Defined Data in your authorization requests.
How Custom Hooks Work
After a request for a particular service is built, there is a check for any code
registering to the hook
app.payment.modifyrequest
. If present, the
hook is called for that specific request and the request object is passed into the
hook. The return value of the hook is sent to
Visa Acceptance Solutions
as the
final request object. Through this process, you can inject your own data into the
request object from the custom code you write in a separate cartridge.
Implementation
To customize request objects, register the hook
app.payment.modifyrequest
in your cartridge's
hooks.json
file. An example would look like this, replacing the script path with your own
script:
script from this cartridge
into your own to use as a template for extending and modifying service request
objects. Note that every hook must return a valid request object for the given
service. Refer to the
Visa Acceptance Solutions
Developer Guide for information
about any field you want to customize or add.
Configuration screenshots: Provide screenshots of custom preference
configurations.
Log file and other relevant data: Download the logs from
Administration > Site Development > Development Setup > Log
files
.
Upgrade
To upgrade to a later version of our cartridge, follow these steps.
Download the code from the ISV Integration Toolkits section on GitHub.
Zip
payments_metadata
folder.
Go to
Administration > Site Development > Site Import &
Export
and upload
payments_metadata.zip
file.
Import the uploaded zip file.
Check release notes for any configuration parameters that might have
changed.
RESULT
The cartridge is successfully upgraded to the latest version.
Shopify
This section details the features, transaction types, and fraud solutions available
in
Shopify
.
The Cybersource app on
Shopify
provides commerce tools to start,
grow, market, and manage retail businesses. You can accept payments in multiple
currencies and get paid in your local currency. The Cybersource app on
Shopify
supports popular payment methods to meet your business needs.
The Cybersource app on
Shopify
supports these features:
3-D Secure
Apple Pay
Card payments
Google Pay
Fraud Management tools
Shopify Subscriptions
Cybersource supports these transaction types on
Shopify
:
Authorization (authorize only)
Sale (auth and capture)
Capture (capture only)
Payer Authentication
(3-D Secure)
Refund (credit)
Void (reversal)
The Cybersource app on
Shopify
supports the following fraud
solutions:
Decision Manager
(DM)
Fraud Management Essentials
(FME)
We recommend an accept/reject model only for fraud management.
Configuring Security Credentials
You must have a Cybersource
Business Center
account. If you do not have one,
you must create one before installing the Cybersource app on
Shopify
. You also must retrieve details from that account to install
the plugin.
Follow the email instructions that you received to activate your merchant
account.
Log in to the Business Center to complete the
registration process.
Installing the Cybersource App on
Shopify
You must enable the Cybersource app in your
Shopify
account
settings. You can install the Cybersource CAS app if you are using a sandbox
account, or the live app if you have completed the go live process.
Installing the Cybersource CAS App
Follow these steps to install the Cybersource CAS app:
View the Org Unit ID, API Identifier, and API Key to verify your
credentials.
Because you verified the
Payer Authentication
credentials and enabled the
3-D Secure
feature when you installed the Cybersource app, the
transactions will support
3-D Secure
flows.
Reference Information
This section contains reference information to help you use the
Visa Acceptance Solutions
app on
Shopify
.
Testing
You can test your integration before you start accepting payments. To test the
application before moving to the production environment, you must use the dedicated
the test app from
These extension settings must be configured to accept payments with
Visa Acceptance Solutions
:
Enable/Disable
Set to
enable
to allow the extension to take payments from your
WooCommerce
store. When the extension is enabled,
card payments are enabled by default.
Title
Enter the
title
text that you want to display for your customers on
the checkout and order received page.
Description
Enter the
description
text that you want to display during the
checkout process.
Transaction Type
Charge:
When this option is selected, the transaction is
automatically captured if the authorization is approved.
Authorization
: When this option is selected, the system only
sends an authorization request and if approved. If the authorization
is approved, you need to manually request a capture.
Charge Virtual-Only Orders
When this setting is selected, if the order is exclusively for digital or
virtual items, this the transaction is automatically captured if the
authorization is approved.
Capture Paid Order
When this setting is selected, if you mark an order as
Processing
or
Completed
, capture requests are automatically sent.
Environment
Set to
Test
for testing to your test account.
Set to
Production
for live transactions.
Merchant ID/Test Merchant ID
Enter the transacting merchant ID (MID) assigned to you when you set-up your
account.
API Key Detail/Test API Key Detail
Enter the key from your REST API shared secret key.
API Shared Secret Key/Test API Shared Secret Key
Enter the shared secret from your REST API shared secret key.
Accepted Card Types
Select the card brands you want to accept.
Message Level Encryption
Message-Level Encryption (MLE) enables you to store information or communicate with
other parties while helping to prevent uninvolved parties from understanding the
stored information. MLE is optional and supported only for payments services. A REST
certificate is required for MLE.
Follow these steps to enable MLE,:
Check
Message Level Encryption
.
Enter the
Key Directory Path
where you have stored the certificate in
your
WooCommerce
/WordPress environment.
Enter the
Key File Name
.
Enter the
Key Password
which you set when generating the REST
certificate.
Digital Payment Methods
Digital Payment Methods
: Choose from Apple Pay, Google Pay,
Click to Pay, and Paze.
Tokenization allows you to offer the ability for your customers to save their payment
cards securely for future payments.
Select
Tokenization
to enable this feature.
Select
Saved Card Verification
to request customers to enter their card
security code when paying with a saved card.
Payer Authentication/3-D Secure
Select
Payer Authentication/3-D Secure
to enable added payment security.
Some countries/regions mandate this feature.
Select
Strong Consumer Authentication
to force a 3-D Secure Challenge
when a customer chooses to save their card for future transactions.
Fraud Screening
Select
Fraud Screening
to enable
Decision Manager
or
Fraud Management Essentials
.
Configure your fraud screening profiles using the
Business Center
.
Debug Mode
Select one of these debugging mode options:
On:
enables the creation of detailed logs for
every transaction. This setting is recommended only for use in the test
environment or when troubleshooting issues in the production (live)
environment.
Off:
enables the creation of basic logs for
transactions.
Order Management
Orders are marked differently, depending on the selected transaction type:
Authorization:
if this option is selected, successful transactions are marked
as
On Hold
.
Charge
: if this option is selected, successful transactions are marked as
Processing
.
Fraud Screening
If fraud screening is enabled, transactions are marked as follows:
Approved orders are marked as
On Hold
or
Processing
, depending on
your transaction type setting.
Orders to review are marked as
On Hold
.
Rejected orders are marked as
Failed
or
Cancelled
.
Orders marked as
On Hold
need to be reviewed in the
Business Center
.
The extension checks for transaction status updates every 15 minutes. Rejected
transactions are marked as
Cancelled
.
Accepted transactions are marked according to your transaction type settings.
If you need to manually trigger the transaction update, follow these steps using the
WooCommerce
Dashboard:
Select
Tools > Scheduled Actions > Pending
.
Find and select
wc_payment_gateway_update_order
.
Click
Apply
.
Capture an Order
There are two ways to capture an order if you have the transaction type set to
Authorization
. Enter the order from the list of orders and choose one of
these actions:
Click the
Capture Charge
button.
Change the order status to
Processing
, then click
Apply
.
Refund an Order
To refund an order, enter the order from the list of orders and complete these
steps:
Click the
Refund
button.
Enter the refund amount.
Click
Refund via
Visa Acceptance Solutions
.
Void an Order
Voids can only be performed for transactions when the transaction type is set to
Authorization
and the transaction has not yet been captured.
To void an authorization, complete these steps:
Click the
Refund
button.
Enter the refund amount.
Click
Refund via
Visa Acceptance Solutions
.
Upgrade the Extension
Follow these steps to upgrade to a later version of the
WooCommerce
extension.
Select
Extensions > Installed Extensions
.
Locate the Visa Acceptance Solutions extension and click
Update
Now
.
Support and Troubleshooting
If you need support installing or using this extension, contact the Support Center to raise a case, and provide this information:
Summary of the issue
Steps needed to reproduce the issue
Platform version
Extension version
Platform merchant ID
Configuration screenshots
List of themes and additional extensions installed
Log file and any other data or screenshots related to the issue
Built by Our Partners
Explore solutions built by our industry-leading partners that offer real-time fraud
screening, account takeover protection, and comprehensive payment solutions. Our
partners provide potential use cases such as personalizing shopping experiences through
advanced analytic. Offer your customers a seamless omnichannel experience and improve
site performance for higher customer satisfaction. Benefit from the centralized
management of product information, automated order processing and fulfillment, and
real-time data synchronization between SAP Commerce Cloud and existing ERP systems.
Moreover, our partners' solutions offer scalable infrastructure, flexible integration
capabilities, advanced reporting tools, and enhanced visibility into supply chain and
inventory management.
Visa Acceptance Solutions Payments for Adobe Commerce User Guide
Recent Revisions to This Document
25.01
Initial release.
About this Guide
This section describes how to use this guide and where to find further information.
Audience and Purpose
This document outlines the configuration details for the Visa Acceptance Solutions
payment extension in the Adobe Commerce platform. The configuration steps are related
to payment acceptance, payment security, fraud management, and order management
services for
Unified Checkout
, including Payment Card, Google Pay, and
Click to Pay
. This guide also applies to Magento Open Source.
Adobe Commerce will be referenced throughout for simplicity.
Conventions
These statements appear in this document:
IMPORTANT
An
Important
statement contains information essential to successfully completing a task or learning a concept.
Customer Support
For support information about any service, visit the Support Center:
Before using the extension, ensure that you have done these prerequisites:
A Visa Acceptance Solutions account with
Unified Checkout
enabled.
Payer Authentication direct connection if
3-D Secure
is
required.
A Token Management Service if you allow customers to save their payment
cards on your website.
Contact support or your reseller if any of these prerequisites
are not completed.
If you do not yet have a Visa Acceptance Solutions account, you can create one
here. Demo accounts are created with
United States dollars as the default currency.
Refer to this article on how to create REST API keys in
the
Business Center
.
General Settings
This section provides General Settings Configuration details for the Visa
Acceptance Solutions extension in Adobe Commerce.
Serial Number
Settings
Description
1
Environment
Configure the sandbox or production environment by providing
the Merchant ID, API key detail, and API shared secret key. If
sandbox is chosen, the website is available for testing new
changes and experiments.
2
Merchant ID
Your Visa Acceptance Solutions Merchant ID
3
API Key
Refers to a specific key provided by a payment gateway to
authenticate and authorize the merchant's integration with the
gateway.
4
API Shared Secret
Refers to a confidential or private key used for secure
communication between the merchant's online store and a payment
gateway.
5
Debug Mode
Enabling debug mode provides an option to troubleshoot using
the Visa Acceptance Solutions logs, named visaacceptance.log.
The diagnostic information will be stored in log files in the
Adobe Commerce web server.
Configuration Details
To configure the Visa Acceptance Solutions extension, a merchant needs to log in
to the administration section of their Adobe Commerce website.
The
configuration panel can be accessed by navigating to the Payment Methods
screen:
On this screen, you can see the settings to configure
the Visa Acceptance Solutions extension.
Secure Payment Methods
This section provides the configuration details of the services supported by Visa Acceptance Solutions extension in Adobe Commerce for
Unified Checkout
.
Sl. No.
Settings
Description
1
Enable
Choose
Yes
to enable the Visa Acceptance
Solutions extension.
2
Title
Customers see the text saved here as the payment method
name.
3
Payment Action
Choose either
Authorize
or
Capture
to decide the payment action during
customer checkout.
4
Payment Card Types
Choose accepted payment card brands.
5
Allowed Payment Method
Choose payment methods through which customer can complete their
order.
6
Select Layout
Choose
Embedded
or
Side bar
as
the layout to display the
Unified Checkout
payment
widget.
7
Payment from Applicable Countries
By choosing
All Allowed Countries
, the payment
method will use the Adobe Commerce global settings for the
customer’s country. By choosing
Specific Countries
,
the merchant can manually choose the allowed countries for the
customer.
8
Payment from Specific Countries
Choosing countries in this setting allows the store owner to
specify which countries are allowed for our payment method.
9
Payer Authentication/
3-D Secure
Enabling this option adds an additional layer of security to
payments by authenticating the customer’s identity before
authorization.
10
Tokenization
Enabling this option allows customers to save their payment cards
for future payments.
11
Tokenization Title
This text specifies the title of the saved card payment
method.
12
Saved Card Verification
This option allows the merchant to configure whether saved card
transactions are processed with CVV.
13
Enforce Strong Customer Authentication
If enabled, the card holder will be
3-D Secure
challenged when saving a card.
Tokenization
This setting determines if registered customers can save cards securely to their
account.
IMPORTANT
To use this feature choose
Yes
in the tokenization setting in the admin configuration panel. If you want the
customer to enter CVV while using the saved card, choose
Yes
for Saved
Card Verification as well.
Payer Authentication
Visa Acceptance Solutions supports
3-D Secure
2.x services. To
process with
3-D Secure
, choose
Yes
in the Payer
Authentication/
3-D Secure
setting in the admin configuration
panel.
Strong Customer Authentication
Payer Authentication (
3-D Secure
) is used for Strong Consumer
Authentication (SCA) in e-commerce payments. Some card issuers require cardholders
to authenticate with a
3-D Secure
challenge when saving their card with
a merchant. If you operate in a region where this is common, you can enable this
setting to require a challenge each time a customer saves a card. To enforce SCA,
choose
Yes
in the
Enforce Strong Customer
Authentication
setting in the admin configuration panel.
If
SCA is not enforced and an issuer requires it, this extension replays the
transaction and requests the challenge.
Managing Orders
Merchants can manage follow-up order management services in Adobe Commerce Back
Office after placing an order from the Adobe Commerce Front Office.
The merchant side services in Adobe Commerce Back Office are:
Full authorization reversal
Authorization capture
or multiple partial captures
Standard refund and partial refund
Full Authorization Reversal
Merchants can perform a full authorization reversal after an authorization. To
cancel a completed order authorization, the merchant can click
Cancel
.
Capture an Authorization
While in authorize mode, the system will create an
order record, but not an invoice. Capturing funds for authorized transactions is
done implicitly when you prepare an invoice.
To create an invoice, navigate
to the below path in the administration section of Adobe Commerce:
Navigate
to
Sales > Orders >
choose an
Order Pending
invoice > then click
Invoice
.
The merchant can perform a full capture or multiple partial captures using the invoice button.
When creating an invoice, the merchant can do multiple partial captures by choosing
specific quantities. Alternatively, the merchant can do complete capture by choosing
the entire order.
To complete invoice creation and capture funds, click
Submit Invoice
.
Refund a Captured Order
You must create a credit memo to refund a captured order.
To refund an order, navigate to the administration section of your Adobe Commerce
website:
Sales > Orders >
open an invoiced order
>
click
Invoices
from the left panel
>
and click
View
.
Click
View
on an invoice to open
it. You can create a credit memo within the invoice record.
When creating a credit memo, you can refund all or part of an invoice. To issue a
partial refund, alter the numbers in the
Qty to Refund
column. Click the
Update Qty’s
button.
To complete the credit memo, click
Refund
.
Payment Methods and Services
This extension supports the following payment methods and services.
These
services can be enabled or disabled using the admin panel configuration:
Payment Card
Payment acceptance services
Payment security services
Fraud management services
Order management services
Google Pay
Payment acceptance services
Fraud management services
Order management services
Click to Pay
Payment acceptance services
Order management services
Appendix
Saving Card at Checkout
Customers can
choose
Save for later use
for payment cards only. Once the order is placed,
card information is securely stored in
Visa Acceptance Platform
.
Payment With a Saved Card
Customers can
make payments using previously saved cards under
Stored Cards
by choosing a
card to proceed with.
Deleting a Card
Customers can view their
stored cards under
My Account
in Adobe Commerce by navigating to
Stored
Payment Methods
. The customer has the option to delete their previously
saved cards by clicking
Delete
.
Unsupported Adobe Commerce Features
The following features are not supported by this module:
Multi-shipping
Multiple node implementation
Google reCAPTCHA
BigCommerce
BigCommerce
provides a software-as-a-service (SaaS) payment
platform where you can manage your online business.
BigCommerce
provides customizable functionality ready for you to build and integrate with
Visa Acceptance Solutions
. This section describes the payment methods and
services that the platform provides. These payment features and methods are
supported:
Card Payments
Apple Pay
Google Pay
3-D Secure
Token Management Service
Decision Manager
and
Fraud Management Essentials
OAuth for connecting your
BigCommerce
account with
Visa Acceptance Solutions
Release Information
This section provides information about the releases for
BigCommerce
.
Version 2 includes the following features:
Global availability in more than 190 countries
Transaction currency support in all available countries
Token Management Service (TMS): Removes your customer's stored card information
from your environment and exchanges sensitive payment data for tokens that
cannot be reversed. Contact to request that TMS be enabled to use the Stored credit cards feature on your
: Determines whether your store is in Test Mode.
When you are ready to take payments, set to
No
(Recommended)
.
Require CVV
(credit card security codes): Using this option
requires users to enter the CVV/CVV2/CVD code for their credit card during checkout.
Enabling this option adds extra security on credit card transactions.
Enable
3-D Secure
: This option enables an additional security layer that helps to
prevent unauthorized transactions. For more information, see
The Module Manager page opens.
The Upload a module pane appears.
Configureto configure the Plugin.
{ "http-basic": { "repo.magento.com": { "username": "Your_Public_Key", "password": "Your_Private_Key" } } }
