# Magento

> Accept Ozow payments on Magento 2.4.x with the standard payment gateway module, plus modules for Capitec Pay, Voucher and Buy Now Pay Later.

Source: https://hub.ozow.com/integration-methods/plugins-and-platforms/magento/

Accept Ozow payments on your Magento store. Ozow provides a standard payment gateway module for
Magento 2.4.x, as well as additional payment-specific modules for Capitec Pay, Voucher, and Buy Now
Pay Later (Happy Pay).

> ℹ️ **Older versions**: Modules for older versions of Magento are available on request. Contact
> [support@ozow.com](mailto:support@ozow.com) or your account manager if you need a module for an
> older Magento version.

## Before you start

- You need an active Ozow merchant account. If you don't have one, sign up at [ozow.com/merchants](https://ozow.com/merchants).
- You need a working Magento 2.4.x installation.
- Ozow only accepts payments in South African Rand (ZAR). You will need to add ZAR as a currency in
  your Magento store before activating the module.
- You will need command line (CLI) access to your Magento server to complete the installation.

## Ozow Gateway for Magento

The standard Ozow gateway enables your customers to pay using any Ozow-supported payment method at checkout.

[Download Ozow Gateway for Magento](https://ozow-live-cdn.s3.eu-west-1.amazonaws.com/plugins/Magento.zip)

### Installation

**Step 1: Add ZAR as a currency**

1. In your Magento admin panel, navigate to **Stores** → **Configuration** → **General** →
   **Currency Setup**
2. Add ZAR under Currency Symbols and Rates

**Step 2, Upload the module**

1. Download the plugin using the link above
2. Extract the zip file
3. Upload the `Ozow` folder into your Magento directory at `magentorootfolder/app/code/`

> ℹ️ **Note**: This will not override any existing files on your system.

**Step 3: Run the installation commands**

Run the following commands in order from your Magento root directory:

```bash
php bin/magento module:enable Ozow_Ozow
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento indexer:reindex
php bin/magento cache:clean
```

**Step 4, Configure the module**

1. Log in to your Magento admin panel
2. Navigate to **Stores** → **Configuration** → **Sales** → **Payment Methods**
3. Click on **Ozow**
4. Enter your merchant credentials, your API key, private key, and site code are available in your
   [Ozow Dashboard](https://dash.ozow.com)
5. Click **Save Config**

### Credentials

You will need the following from your [Ozow Dashboard](https://dash.ozow.com):

| Credential | Where to find it |
|---|---|
| API key | Merchant Details section |
| Private key | Merchant Details section |
| Site code | Site section |

## Payment-specific modules

In addition to the standard gateway, Ozow provides dedicated modules for specific payment methods.
These can be installed alongside the standard gateway to offer additional payment options at
checkout. The installation process for each follows the same pattern as the standard gateway.

### Capitec Pay via Ozow

Enables Capitec Pay as a standalone payment method at checkout.

[Download Capitec Pay via Ozow](https://ozow-live-cdn.s3.eu-west-1.amazonaws.com/plugins/magento-capitec-pay-via-ozow-v1.zip)

**Installation**

**Step 1: Add ZAR as a currency** (skip if already done)

In your Magento admin panel, navigate to **Stores** → **Configuration** → **General** → **Currency
Setup** and add ZAR under Currency Symbols and Rates.

**Step 2, Upload the module**

1. Download the plugin using the link above
2. Extract the zip file
3. Upload the `Ozow` folder into your Magento directory at `magentorootfolder/app/code/`

**Step 3: Run the installation commands**

```bash
php bin/magento module:enable Ozow_OzowCapitec
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento indexer:reindex
php bin/magento cache:clean
```

**Step 4, Configure the module**

1. In your Magento admin panel, navigate to **Stores** → **Configuration** → **Sales** → **Payment Methods**
2. Click on **Capitec Pay via Ozow**
3. Enter your merchant credentials
4. Click **Save Config**

---

### Voucher via Ozow

Enables Cash Voucher redemption as a standalone payment method at checkout.

[Download Cash Voucher via Ozow](https://ozow-live-cdn.s3.eu-west-1.amazonaws.com/plugins/magento-cash-voucher-pay-via-ozow-v1.zip)

**Installation**

**Step 1: Add ZAR as a currency** (skip if already done)

In your Magento admin panel, navigate to **Stores** → **Configuration** → **General** → **Currency
Setup** and add ZAR under Currency Symbols and Rates.

**Step 2, Upload the module**

1. Download the plugin using the link above
2. Extract the zip file
3. Upload the `Ozow` folder into your Magento directory at `magentorootfolder/app/code/`

**Step 3: Run the installation commands**

```bash
php bin/magento module:enable Ozow_OzowVoucher
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento indexer:reindex
php bin/magento cache:clean
```

**Step 4, Configure the module**

1. In your Magento admin panel, navigate to **Stores** → **Configuration** → **Sales** → **Payment Methods**
2. Click on **Cash Voucher via Ozow**
3. Enter your merchant credentials
4. Click **Save Config**

---

### Buy Now Pay Later: Happy Pay via Ozow

Enables Buy Now Pay Later (Happy Pay) as a standalone payment method at checkout.

[Download Buy Now Pay Later: Happy Pay via Ozow](https://ozow-live-cdn.s3.eu-west-1.amazonaws.com/plugins/happy-pay-via-ozow-magento.zip)

> ℹ️ **Note**: The Happy Pay module requires the Happy Pay widget to be displayed on your product
> pages. See the [Buy Now Pay Later](https://hub.ozow.com/payment-products/payin/buy-now-pay-later.md) product page
> for widget implementation guidance.

**Installation**

**Step 1: Add ZAR as a currency** (skip if already done)

In your Magento admin panel, navigate to **Stores** → **Configuration** → **General** → **Currency
Setup** and add ZAR under Currency Symbols and Rates.

**Step 2, Upload the module**

1. Download the plugin using the link above
2. Extract the zip file
3. Upload the `Ozow` folder into your Magento directory at `magentorootfolder/app/code/`

**Step 3: Run the installation commands**

```bash
php bin/magento module:enable Ozow_OzowHappyPay
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento indexer:reindex
php bin/magento cache:clean
```

**Step 4, Configure the module**

1. In your Magento admin panel, navigate to **Stores** → **Configuration** → **Sales** → **Payment Methods**
2. Click on **Happy Pay via Ozow**
3. Enter your merchant credentials
4. Click **Save Config**

## Support

For assistance with your Magento integration contact [support@ozow.com](mailto:support@ozow.com) or
reach out to your account manager.