Magento

Connect Peach Payments to your Magento store.

Peach Payments offers a plugin for Magento which allows you to accept online payments using all the payment methods offered by Checkout.

📘

Peach Payments offers two Magento payment extensions, one for Magento version 1 and another for version 2. The content on this page refers to the Magento 2 payment extension which has a number of benefits over version 1.

The Magento payment extension redirects to a payments page hosted by Peach Payments. One-click card payments and payment subscriptions are facilitated through a JavaScript widget that loads within your Magento store.

Overview

ItemDescription
CountriesSouth Africa, Kenya, and Mauritius.
SubscriptionsPayment subscriptions are supported through the paid-for ParadoxLabs Adaptive Subscriptions plugin. For more information on how to configure your platform to accept subscriptions, please see our support knowledge base.
RefundsSupports full or partial refunds. Certain payment methods must be refunded manually.
CurrenciesAll currencies that you are configured for.
PricingSee the Peach Payments website.
Account activationRequires review by Peach Payments South Africa. Our sales team is always here to help; 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. As part of your onboarding, you received live API credentials and access to the live Console. If you've lost access to the email or can't recall your API credentials, log in to the Console, navigate to Merchants, then click your merchant name. In the left-hand navigation, click Checkout > <your Magento Checkout name>, then select the Live Configuration tab and take note of the entity ID and secret token credentials in the Live Configuration and Test Configuration sections.
Magento API credentials.Magento API credentials.

Magento API credentials.

  1. If you would like to configure a webhook, send your webhook URL in the <https://{MAGENTO_BASE_URL}/pp-hosted/secure/webhook> format to support and list the notification types that you would like to receive.
  2. Install the Magento plugin by following the instructions in the public GitLab repository.
  3. Log in to your Magento admin dashboard and navigate to Stores > Configuration > Sales > Payment Methods.
Magento admin dashboard showing the **Stores** settings.Magento admin dashboard showing the **Stores** settings.

Magento admin dashboard showing the Stores settings.

  1. Configure the plugin:
    1. Set the Mode to Live 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 the payment methods that you want to enable.
    4. Click Save Config.
Plugin configuration options.Plugin configuration options.

Plugin configuration options.

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

🚧

  • If you receive a Merchant domain not whitelisted error when trying to make a payment, contact support to whitelist your domain.
  • If you would like to conduct payments testing on a test website, contact support to provide you with sandbox access. You can then use the sandbox credentials provided and Sandbox mode to conduct your testing.

FAQ

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

  1. For subscription payments with the ParadoxLabs Adaptive Subscriptions plugin, can I send confirmation emails and monthly invoices?
  2. For subscription payments with the ParadoxLabs Adaptive Subscriptions plugin, how can I notify customers that a billing attempt has failed and how can I notify them that their card is about to expire?

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