PrestaShop
Last updated: July 3, 2024
From downloading the plugin to requesting your first test payment, learn how to get started with the Checkout.com for PrestaShop plugin. This guide assumes that you have already installed PrestaShop.
Information
In order to use this plugin, the minimum required versions are:
- PrestaShop: 1.7.0
- Checkout.com's plugin: 2.3.5
- 3D Secure 2.0
- Apple Pay payments
- Deferred payments (authorization and capture as a two-step process) based on a time delay or an order status change
- Dynamic descriptors
- Frames
- Google Pay payments
- Invoice generation
- Manual capture, refund, and partial refund from the PrestaShop admin dashboard
- Multi-store / currency support
- Notifications (webhooks) for payment flow management
- Refund, void, capture, partial refund, and partial capture from the Dashboard
- Risk management
- Saved cards (stored credit cards)
To set up our PrestaShop plugin, you'll need 2 API keys: a secret key and a public key. You can create your secret and public keys in the Dashboard.
- Download the latest release of our plugin from GitHub.
- Sign in to your PrestaShop admin dashboard and go to Modules > Module Manager.
- Select Upload a module and drop the
.zipfile into the window that pops up. - If successful, you'll get a
Module installed!message. - Select Configure to start setting up the plugin.
- Sign in to your PrestaShop admin dashboard and go to Modules > Module Manager.
- Find the Checkout.com plugin and select Configure.
- Set Service to NAS.
- Select the Environment you want. Select Sandbox if you want to start testing payments.
- Enter your secret key and public key. If you're testing, make sure you use the API keys from your sandbox Dashboard account.
- Select Set webhook to automatically register your webhooks in the Dashboard, then select Save.
- Go the the CARD PAYMENTS tab and set Enable Card Payments to Yes.
- Select the Type of payment:
- With Immediate (Authorize and Capture), the charge is both authorized and captured (that is, the money due from the customer's account is moved into your account) at the same time.
- With Deferred (Authorize), the charge is only authorized. You'll either have to capture the payment manually or configure an event that will trigger the capture.
- Select Save.
That's it! You're ready to start testing card payments.
- Go to your storefront and add a product to your cart.
- Go to your cart and proceed to checkout.
- Enter the required billing details. We recommend using a real email address so you can receive the order confirmation.
- Select Pay by Card with Checkout.com.
- Enter the following card details:
- Number:
4242 4242 4242 4242 - Expiry date: any future date
- CVV:
100
- Number:
- Agree to the terms of service and select Order with an obligation to pay. You'll be redirected to an order confirmation page. If you entered a real email address in the billing details, you'll also receive an order confirmation email.
- Sign in to your PrestaShop admin dashboard and go to Order settings > Order settings. Your test order will be displayed there with a
Payment acceptedstatus, indicating that the payment was successfully captured. The transaction will also appear in the Payments section of your sandbox Dashboard account.
You can now either go live as-is or extend your configuration.
You'll find more test cards and a range of scenarios to trigger in our testing guide.
Note
If this test does not work, first check you have configured your webhooks correctly. If you have configured them properly, check your server: if it's password-protected or it restricts unfamiliar IP addresses, it may be blocking webhook notifications. Contact our Support team at [email protected] if you need help.
If you're happy with the outcome of your testing and want to start taking payments right away, please contact our Sales team in order to move to a live account.
Note
Before you go live, remember to:
- Switch the environment to Live in the plugin's settings.
- Update your secret and public API keys in the plugin's settings with the keys from your live Dashboard account.
You can extend your PrestaShop integration in multiple ways to suit all your business needs.
In this section, you'll learn how to:
- Add more payment methods
- Enable 3D Secure payments
- Configure card payment options
- Configure order statuses
Note
In order to start accepting an alternative payment method, we first need to enable it on your account. Please contact your Account Manager or our Sales team to get started.
We currently support the following payment methods on PrestaShop:
- Sign in to your PrestaShop admin dashboard and go to Modules > Modules Manager.
- Find the Checkout.com plugin and select Configure.
- Select the ALTERNATIVE PAYMENTS tab.
- Select the payment methods you want to support.
- Select Save.
- Sign in to your PrestaShop admin dashboard and go to Modules > Modules Manager.
- Find the Checkout.com plugin and select Configure.
- Select the APPLE PAY tab.
- Enter a Payment Option Title. For example,
Pay by Apple Pay with Checkout.com. - Set Enable Apple Pay to Yes.
- Enter your merchant ID. You can find this ID in your Apple Developer Account.
- Follow the Checkout.com guide to get the
.keyand a.pemcertificate file. - Select Save.
- Sign in to your PrestaShop admin dashboard and go to Modules > Modules Manager.
- Find the Checkout.com plugin and select Configure.
- Select the GOOGLE PAY tab.
- Enter a Payment Option Title. For example,
Pay by Google Pay with Checkout.com. This is the name of the payment option that will be displayed to the customer. - Set Enable Google Pay to Yes.
- Enter your
Merchant ID. You can find this in your Google payments profile. - Select Save.
- Sign in to your PrestaShop admin dashboard and go to Modules > Modules Manager.
- Find the Checkout.com plugin and select Configure.
- Select the CARD PAYMENTS tab.
- In the Advanced Settings, set Use 3D Secure to Yes.
- Select whether or not you want to Attempt non-3D Secure transactions. If you select Yes, any cards that do not support 3D Secure (3DS) will go through without a 3DS check. If you select No, cards that do not support 3DS will be blocked.
- Select Save.
Information
All orders in the PrestaShop admin dashboard are created after authorisation. In case 3D Secure authentication has failed, the transaction will be displayed in the Order Settings > Shopping Carts section.
- Sign in to your PrestaShop admin dashboard and go to Modules > Modules Manager.
- Find the Checkout.com plugin and select Configure.
- Select the CARD PAYMENTS tab.
- Set Enable Card Payments to Yes.
- Set Type of payment to Deferred (Authorize). This will only authorize the charge. You'll either have to capture the payment manually, or configure an event that will trigger the capture.
- Select Save.
- Sign in to your PrestaShop admin dashboard and go to Modules > Modules Manager.
- Find the Checkout.com plugin and select Configure.
- Select the CARD PAYMENTS tab.
- Make sure that Type of payment is set to Deferred (Authorize).
- Choose whether you'd like to trigger the payment capture based on a time delay or an order status change.
- If you've selected Delay, specify the delay before the payment is captured, in hours. For example, a delay value of
1.5means that the payment will be captured after 1 hour and 30 minutes. - If you've selected Order status, specify the order statuses that will trigger the capture.
- If you've selected Delay, specify the delay before the payment is captured, in hours. For example, a delay value of
- Select Save.
This is an extra field that you can send to the issuer, appearing on the customer's bank statement as an additional description of the payment.
- Sign in to your PrestaShop admin dashboard and go to Modules > Modules Manager.
- Find the Checkout.com plugin and select Configure.
- Scroll down and set Enable Dynamic Descriptor to Yes.
- Specify your Descriptor Name. This is the first line of the descriptor, usually your merchant name.
- Specify your Descriptor City. This is the second line of the descriptor, usually the city of your merchant address.
- Select Save.
This setting allows your customers to save their cards for future payments. They can then use the same card on your website without re-entering the details.
- Sign in to your PrestaShop admin dashboard and go to Modules > Modules Manager.
- Find the Checkout.com plugin and select Configure.
- Select the CARD PAYMENTS tab.
- In the Advanced Settings, set Save Card Option to Yes.
- Select Save.
These settings allow you to edit the order statuses in line with the status of the payment. They are automatically set to PrestaShop's default values, so it's unlikely you will need to edit them.
To find these settings, sign in to your PrestaShop admin dashboard and go to Modules > Modules Manager. Then, find the Checkout.com plugin, select Configure, and scroll down.