Skip to content

PrestaShop

Last updated: April 29, 2022

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.

Minimum requirements

In order to use this plugin, the minimum required versions are:

  • PrestaShop: 1.7.0
  • Checkout.com's plugin: 2.3.0

Supported features

  • Refund, void, capture, partial refund, and partial capture from the Dashboard
  • Manual capture from the PrestaShop admin
  • Frames
  • Saved cards (stored credit cards)
  • Invoice generation
  • 3D Secure 2.0
  • Risk management
  • Multi-store / currency support
  • Notifications (webhooks) for payment flow management
  • Dynamic descriptors
  • Deferred payments (authorization and capture as a 2-step process) based on a time delay or an order status change

Before you start

Get your API keys

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.


Install the plugin

  1. Download the latest release of our plugin from GitHub.
  2. Sign in to your PrestaShop admin dashboard and go to Modules > Module Manager.
  3. Select Upload a module and drop the .zip file into the window that pops up.
  4. If successful, you'll get a Module installed! message.
  5. Select Configure to start setting up the plugin.

Configure the plugin

  1. Sign in to your PrestaShop admin dashboard and go to Modules > Module Manager.
  2. Find the Checkout.com plugin and select Configure.
  3. Set Service to NAS.
  4. Select the Environment you want. Select Sandbox if you want to start testing payments.
  5. Enter your secret key and public key. If you're testing, make sure you use the API keys from your sandbox Dashboard account.
  6. Select Set webhook to automatically register your webhooks in the Dashboard, then select Save.
  7. Go the the CARD PAYMENTS tab and set Enable Card Payments to Yes.
  8. 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.
  9. Select Save.

That's it! You're ready to start testing card payments.


Test your integration

  1. Go to your storefront and add a product to your cart.
  2. Go to your cart and proceed to checkout.
  3. Enter the required billing details. We recommend using a real email address so you can receive the order confirmation.
  4. Select Pay by Card with Checkout.com.
  5. Enter the following card details:
    • Number: 4242 4242 4242 4242
    • Expiry date: any future date
    • CVV: 100
  6. 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.
  7. Sign in to your PrestaShop admin dashboard and go to Order settings > Order settings. Your test order will be displayed there with a Payment accepted status, 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.

Troubleshooting

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 support@checkout.com if you need help.

Further testing

You'll find more test cards and a range of scenarios to trigger in our testing guide.


Go live

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.

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.

Extend your configuration

You can extend your configuration to add more payment methods, use 3D Secure payments, and more.