Magento

Connect Peach Payments to your Magento store.

Peach Payments offers two Magento plugins, a traditional plugin and a progressive web application (PWA) plugin, which allow you to accept online payments using all the payment methods offered by Checkout.

The Magento payment extensions redirect to a payments page hosted by Peach Payments. Recurring and one-click card payments occur through a JavaScript widget that loads in your Magento store.

Merchants that have a custom front-end and a Magento back-end must use the PWA plugin.

Overview

ItemDescription
CountriesSouth Africa, Kenya, and Mauritius.
Recurring paymentsSupports recurring payments through the paid-for ParadoxLabs Adaptive Subscriptions plugin; for plugin version support, see the compatibility matrix. For more information on how to configure your platform to accept recurring payments, see the support knowledge base.
RefundsSupports full or partial refunds. You must refund certain payment methods manually.
CurrenciesAll currencies configured for your account.
PricingSee the Peach Payments website.
Account activationRequires review by Peach Payments South Africa. Contact support for assistance.

Register account

To connect Peach Payments to your Magento store, you must have a Peach Payments account.

Install and configure the plugin

  1. Log in to the Peach Payments Dashboard and retrieve your Magento sandbox and live credentials.

  2. To configure a webhook, follow the instructions in the webhook documentation using the https://{MAGENTO_BASE_URL}/pp-hosted/secure/webhook URL format.

  3. To add your domain to the Peach Payments allowlist, follow the instructions in the allowlist documentation.

  4. Install the Magento plugin by following the instructions in one of the public GitLab repositories:

    1. Traditional plugin.
    2. PWA plugin or example implementation using the Venia Magento theme.
  5. Log in to your Magento administration dashboard and go to Stores > Configuration > Sales > Payment Methods.

    Magento admin dashboard showing the **Stores** settings.

    Magento admin dashboard showing the Stores settings.

  6. If the Peach Payments module is not visible in the list of available payment methods, go to System > Cache Management and click Flush Magento Cache.

  7. Go back to Stores > Configuration > Sales > Payment Methods and click Configure next to the Peach Payments payment method to expand the available settings.

  8. Configure the plugin:

    1. Set the Mode to Production to accept live payments or Sandbox for testing.

    2. Depending on the mode you've selected, enter the live or sandbox API credentials you retrieved in step 1.

    3. Select Yes for Enable Consolidated Payments.

    4. You can redirect to the Peach Payments checkout page, embed the checkout experience on your website, or offer both options.

      • To redirect to the Peach Payments checkout page, select Yes for Enable Redirect Payment Methods.
      • To embed the checkout experience on your website, select Yes for Enable Embedded Checkout.

        🚧

        Embedded Checkout does not support certain payment methods.

    5. If you enabled the redirect payment methods, select the payment methods that you want to enable.

    6. Click Save Config.

      Plugin configuration options.

      Plugin configuration options.

📘

To learn more about PHP compatibility, available events, and GraphQL, see the plugin documentation in the public GitLab repository.

You should see Peach Payments as a payment option on checkout. Execute purchases to check the integration.

🚧

If you receive a Merchant domain not whitelisted error when trying to make a payment, contact support to add your domain to the allowlist.

FAQ

If you run into any issues with the Magento payment extension, check the support knowledge base for the issue and solution:

  1. For recurring payments with the ParadoxLabs Adaptive Subscriptions plugin, can I send confirmation emails and regular invoices?
  2. For recurring payments with the ParadoxLabs Adaptive Subscriptions plugin, how can I tell customers that a billing attempt has failed and how can I tell them that their card is about to expire?
  3. How do I show a ZeroPay or Mobicred instalment calculator on my store? For ZeroPay, use this file. For Mobicred, follow their documentation.

If you can't find the issue, contact support for assistance.