---
title: "Ozow"
slug: "ozow"
updated: 2026-05-06T06:08:49Z
published: 2026-05-06T06:08:49Z
canonical: "docs.apcopay.com/ozow"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apcopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ozow

**Ozow** – A South African fintech platform offering instant, secure, card-free EFT payments, refunds, and payouts to businesses through seamless API and plug-in integrations.

## Supported Transaction Types

- [ ] Authorisation
- [ ] Capture
- [x] Purchase
- [x] Refund
- [x] Withdrawal
- [ ] Void

## Integrations Supported

- [x] Hosted Payment Page (For deposits)
- [x] Direct Connect ( server-to-server - For Refunds and Withdrawals)

## Currencies & Countries Supported

| Title | Description |
| --- | --- |
| **Currencies Supported** | ZAR |

## Additional attributes to process via Ozow

You must include the following JSON Attributes to the payload. These attributes inform us to proceed with the redirection to Ozow in order to finalise the payment process.

For more details on the integration, you can also refer to our API reference documentation [here](https://apcopay.redoc.ly/).

| Description | Hosted Payment Page |
| --- | --- |
| **Force Transaction Routing** | "Routing": { "ForcePayment": "OZOW" } |
| **Client Account Details*** | "Client" : { "Email": "Apco@Test.com", "FirstName": "Apco", "LastName": "Test", "Country": "ZA", "MobileNo": "3561234567", "Street": "Street", "City": "City", "ZIPCode": "12345", "State": "N/A", "IPAddress": "127.0.0.0" } |
| **Payment Destination***1 | "PaymentDestination": { "PaymentMethodData": { "BankBranchCode": "198765", "BeneficiaryAccountNumber": "1148172386", "**BankGroupId**": "bf0561fd-4203-4a0c-9174-cb26fcd87a60", "IsRTC": "true" } |
| **PaymentMethodData** | "PaymentMethodData" :{ "ClientIdentificationNumber":"12344", "BankBranchCode": "198765", "BeneficiaryAccountNumber": "1148172386", "BankAccountName": "Bank Account Name", "PayeeDisplayName": "John Doe" }, |
| **Test Indicator** (required in Sandbox Environment only) | "isTest”: true |

*1 This node has been provided as an example for a deposit with **BankGroupId.**

The allowed Payment Methods by the Provider can be retrieved by calling the [Get Payments Methods](https://apcopay.redoc.ly/#operation/GetPaymentMethods) call found at the following [link](https://apcopay.redoc.ly/#operation/GetPaymentMethods). The value of the **BankGroupId** will have to be one of the **PaymentMethodId**s representing the specific payment method.

Note: The **PaymentDestination** in the Payout is **Mandatory**.

**ClientIdentificationNumber** -* Required **only** for merchants classified as **high-risk**.

**Requirement**: Must be a **valid South African identity number**.

**Sample Get Payment Request and Response below**

Test Request: https://payments.apcopay.tech/merchanttools?currency=ZAR&country=ZA&PaymentProvider=OZOW&IsTest=true

Prod Request: https://payments.apcopay.tech/merchanttools?currency=ZAR&country=ZA&PaymentProvider=OZOW&IsTest=false

Test Response:

```json
 {
    "paymentMethods": [
        {
            "paymentMethodId": "3284a0ad-ba78-4838-8c2b-102981286a2b",
            "name": "ABSA",
            "channel": null,
            "group": null,
            "country": null,
            "currency": null,
            "branchCode": "632005"
        },
        {
            "paymentMethodId": "33a0840b-0cf4-4b8c-86e0-ec6c4be8c60e",
            "name": "African Bank",
            "channel": null,
            "group": null,
            "country": null,
            "currency": null,
            "branchCode": "430000"
        },
        {
            "paymentMethodId": "913999fa-3a32-4e3d-82f0-a1df7e9e4f7b",
            "name": "Capitec Bank",
            "channel": null,
            "group": null,
            "country": null,
            "currency": null,
            "branchCode": "470010"
        },
        {
            "paymentMethodId": "b8f152a2-8bd2-46c4-930f-4cd5b2b37ef9",
            "name": "Discovery Bank",
            "channel": null,
            "group": null,
            "country": null,
            "currency": null,
            "branchCode": "679000"
        }
    ],
    "isSuccess": true,
    "errorMessage": ""
}
```

**Sample Deposit Request below**

```json
{
  "TransactionType": "ORIGINALCREDIT",
  "Currency": "ZAR",
  "Amount": "1.00",
  "OrderReference": "MerchantOrder1",
  "RedirectionURL": "https://www.yourURLhere.com/Redirect",
  "CallBackURL": "https://www.yourURLhere.com/Listener",
  "FailRedirectionURL": "https://yourURLhere.com/FailRedirect/",
  "Language": "en",
  "IsTest": "False",
  "Routing": {
    "ForcePayment": "OZOW"
  },
  "Client" : {
    "Email": "Apco@Test.com",
    "ClientAccount": "testing",
    "FirstName": "Apco",
    "LastName": "Test",
    "Country": "ZA",
    "MobileNo": "3561234567",
    "Street": "Street",
    "City": "City",
    "ZIPCode": "ZIP",
    "State": "N/A",
    "IPAddress": "127.0.0.0"
  },
  "PaymentMethodData" :{
    "ClientIdentificationNumber":"12344",
    "BankBranchCode": "198765",
    "BeneficiaryAccountNumber": "1148172386",
    "BankAccountName": "Bank Account Name",
    "PayeeDisplayName": "John Doe"
  },
  "Configuration" : {
    "Profile": "showandedit"
  }
}
```

## Additional attributes are needed for Withdrawals - Direct Connect

| Description | Direct Connect |
| --- | --- |
| **Force Transaction Routing** | "Routing": { "ForcePayment": "OZOW" } |
| **Client Account Details*** | "Client" : { "Email": "Apco@Test.com", "ClientAccount": "testing", "FirstName": "Apco", "LastName": "Test", "Country": "ZA", "MobileNo": "3561234567", "Street": "Street", "City": "City", "ZIPCode": "ZIP", "State": "N/A", "IPAddress": "127.0.0.0" } |
| **Payment Destination***2 | "PaymentDestination": { "PaymentMethodData": { "BankBranchCode": "198765", "BeneficiaryAccountNumber": "1148172386", "**BankGroupId**": "bf0561fd-4203-4a0c-9174-cb26fcd87a60", "IsRTC": "true" } |
| **Test Indicator** (required in Sandbox Environment only) | "isTest”: true |

*2 This node has been provided as an example for a withdrawal with **BankGroupId.**

The allowed Payment Methods by the Provider can be retrieved by calling the [Get Payments Methods](https://apcopay.redoc.ly/#operation/GetPaymentMethods) call found at the following [link](https://apcopay.redoc.ly/#operation/GetPaymentMethods). The value of the **BankGroupId** will have to be one of the **PaymentMethodId**s representing the specific payment method.

Note: The **PaymentDestination** in the Payout is **Mandatory**.

Sample request below:

```json
{
  "TransactionType": "ORIGINALCREDIT",
  "Amount": "10",
  "Currency": "ZAR",
  "OrderReference": "Ozow payment",
  "PaymentDestination": {
    "PaymentMethodData": {
      "BankBranchCode": "198765",
      "BeneficiaryAccountNumber": "1148172386",
      "BankGroupId": "bf0561fd-4203-4a0c-9174-cb26fcd87a60",
      "IsRTC": "true"
    }
  },
  "Routing": {
    "ForcePayment": "OZOW"
  },
  "Client" : {
    "Email": "Apco@Test.com",
    "ClientAccount": "testing",
    "FirstName": "Apco",
    "LastName": "Test",
    "Country": "ZA",
    "MobileNo": "3561234567",
    "Street": "Street",
    "City": "City",
    "ZIPCode": "ZIP",
    "State": "N/A",
    "IPAddress": "127.0.0.0"
  },
  "RedirectionURL": "https://url/Redirect/",
  "CallBackURL": "https://url/Listener",
  "IsTest": "True"
}
```

## Attributes needed for Refunds - Direct Connect

| Description | Direct Connect |
| --- | --- |
| **Force Transaction Routing** | "Routing": { "ForcePayment": "OZOW" } |
| **Test Indicator** (required in Sandbox Environment only) | "isTest”: true |

Sample request below:

```json
{
  "TransactionType": "PARTIALREFUND",
  "Amount": "1",
  "Currency": "ZAR",
  "OrderReference": "Ozow - Refund",
  "RedirectionURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Redirect/",
  "CallBackURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Listener",
  "IsTest": false,
  "PspId": "8736335"
}
```
