WooCommerce

Connect Peach Payments to your WooCommerce store.

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

Overview

ItemDescription
CountriesSouth Africa, Kenya, and Mauritius.
Recurring paymentsUse Woo Subscriptions for recurring or subscription payments.
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 WooCommerce store, you must have a Peach Payments account.

Install the plugin

The installation procedure differs depending on if you're installing it for the first time or if you're upgrading an existing installation.

New installation

If you aren't already using the Peach Payments plugin, install the plugin as follows:

  1. Log in to your WordPress administration dashboard.
  2. Go to Plugins.
  3. Click Add Plugin.
  4. Search for Peach Payments Gateway in the plugin search bar, wait for the plugin to appear, then click Install Now.
  5. When the installation completes, click Activate.

Upgrade

🚧

Upgrading from version 3? Version 4 is a new plugin with a different configuration. There is no rollback to version 3. Before upgrading on your live store, back up your website and test version 4 in a staging environment.

If you're already using an older version of the Peach Payments plugin, upgrade it to V4 as follows:

  1. Log in to your WordPress administration dashboard.
  2. Go to Plugins.
  3. Find the WooCommerce Peach Payments Gateway plugin and click update now.

The plugin is updated.

Configure the plugin

📘

To test before going live, use the sandbox Dashboard to get the sandbox credentials from the WooCommerce section. Use these credentials when completing the steps below and set Transaction Mode to Integrator Test.

🚧

The WooCommerce section only appears in the Connect section if it has been configured for your account. If you don't see the WooCommerce section, contact support to configure it for your account.

  1. To configure the plugin, go to WooCommerce > Settings > Payments.
  2. To have Peach Payments appear at the top of your checkout page, drag the Peach Payments row to the top of the list of payment providers.
  3. Click Manage next to Peach Payments to open the plugin settings.
  4. Select Enable/Disable to turn the plugin on or off.
  5. Set Transaction Mode to Integrator Test (sandbox) or Live (production).
  6. Configure the payment method's title, description, and redirect notice message if you don't like the defaults.
  7. In the Payment Logos field, select the payment method logos you want to display on your storefront. You must have activated these these payment methods on your account.
  8. Under API Keys, enter the credentials from the WooCommerce section of the Peach Payments Dashboard:
    • Entity ID
    • Access Token
    • Secret Token
    • Client ID
    • Client Secret
    • Merchant ID
  9. If you accept recurring or subscription payments, enter Recurring ID. If your recurring credentials are not available, contact support to request recurring payments.
  10. Configure your webhook URL in the WooCommerce section of the Peach Payments Dashboard. Use the format <your-domain>/?wc-api=wc_switch_webhook_peach_payments. If you use subscriptions, contact support to obtain the Card Webhook Decryption key and enter it in the relevant field.
  11. Select Enable Card Storage to allow logged-in customers to save their cards for future use. You must get permission from your customers before tokenising and storing their cards.
  12. Under Order Status, choose the order status to set for successful payments.
  13. Click Save changes.
  14. To add your domain to the Peach Payments allowlist, follow the instructions in the allowlist documentation.
📘

For more information on the Peach Payments WooCommerce plugin, see the WordPress plugin documentation.

Payment flow

After a customer chooses Peach Payments at checkout and places an order, the plugin redirects them to the Peach Payments Hosted Checkout to complete the payment. When payment is successful, the plugin redirects them back to the order confirmation page on your website. An order is created in your backend corresponding to the payment.

Gather and send logs

Sometimes, it might be necessary for you to gather logs to submit to Peach Payments for troubleshooting:

  1. Log in to your WordPress administration dashboard.
  2. Go to WooCommerce > Status and select the Logs tab.
  3. Select the applicable logs from the list, click the Bulk actions drop-down, select Download, and click Apply. Your computer downloads the logs.
  4. Send the logs to Peach Payments for troubleshooting.

FAQ

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

The WooCommerce plugin listing also features some FAQ.

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