South Africa

Supported payment methods and integration details for South Africa

Country Details

Country ID: 15 • Country Code: 27 • Currency: ZAR (South African Rand)

Supported Payment Methods & Payload Requirements

Channel	Flow	`payment_method_type`	Required Payload Array / Fields	Destination / Operator	API Reference
EFT Bank Transfer	Deposit	`"bank_eft"`	`bank_code`, `successful_url`, `failure_url`	South African Banks (Redirect URL)	Collections API
Capitec Pay	Deposit	`"capitec"`	`id_number` (13 digits), `successful_url`, `failure_url`	Capitec Bank (App Prompt)	Collections API
Bank Transfer	Payout	`"bank"`	`bank: [{"bank_name": "...", "bank_code": "...", "branch_name": "...", "account_name": "...", "account_number": "..."}]`	South African Commercial Banks (RTC / EFT)	Payments API

Payment Flow: How It Works

Deposits (Collections)

1. EFT Bank Collections (`payment_method_type: "bank_eft"`)

Initiation: Send a POST request to the Unified Collections endpoint with payment_method_type: "bank_eft", country_id: 15, currency: "ZAR", bank_code, successful_url, and failure_url.
Customer Redirection: Niobi returns an authorization_url in the initial response (payment_step: 1). Redirect the customer to this URL to log into their bank portal and approve the transfer. This URL is single-use and expires once opened, do not open it yourself to preview or test it, only the customer should open it, and only once they’re ready to pay. If it expires unused, you’ll need to initiate a new request to get a fresh one.
Completion & Callback: Once the customer approves or cancels the transfer on their bank’s portal, they’re redirected to your successful_url or failure_url accordingly, and Niobi delivers an asynchronous webhook callback (payment_step: 2) to your callback_url.

South Africa EFT bank selection page — The customer selects their bank on the authorization_url page before approving the transfer.

Supported South African Banks for EFT Collections:

ABSA (0001)
First National Bank (FNB) (0002)
Investec (0003)
Nedbank (0004)
Standard Bank (0005)
Bidvest Bank (0006)
TymeBank (0007)

2. Capitec Collections (`payment_method_type: "capitec"`)

Initiation: Send a POST request to the Unified Collections endpoint with payment_method_type: "capitec" and the customer’s 13-digit South African ID number in id_number.
In-App Approval: The customer receives a prompt on their Capitec banking app to approve the debit.
Callback Delivery: Niobi delivers an asynchronous webhook callback (payment_step: 2) to your callback_url.

Payouts (Disbursements)

Initiation: Send a POST request to the Unified Payments endpoint with payment_method_type: "bank".
Recipient Details: Include the recipient’s bank name, bank code, branch name, account name, and account number.
Settlement: Funds are routed via Real Time Clearing (RTC) or Electronic Funds Transfer (EFT).
Callback Delivery: Niobi delivers a terminal webhook callback (payment_step: 2) once funds clear.

Sample Requests & Responses

EFT Deposit Request

{
    "client_id": "YOUR_CLIENT_ID",
    "params": {
        "amount": 500,
        "bank_code": "0001",
        "callback_url": "https://example.com/callback",
        "country_id": 15,
        "currency": "ZAR",
        "failure_url": "https://example.com/payment-failed",
        "mobile": "2763456789",
        "name": "John Doe",
        "payment_method_type": "bank_eft",
        "successful_url": "https://example.com/payment-success",
        "third_party_reference_1": "TX-ZAR-DEP-1001",
        "third_party_reference_2": "CUST-301"
    },
    "salt": "random_salt_12345",
    "sender": "YOUR_INTEGRATION_NAME",
    "timestamp": 1724835600,
    "signature": "a1b2c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0"
}

EFT Deposit Response (Initiation)

{
    "success": true,
    "message": "Payment process initiated successfully.",
    "data": {
        "amount": 500,
        "authorization_url": "https://auth.bank-gateway.example.com/session/12345",
        "currency": "ZAR",
        "depositId": "dep_12345678",
        "payment_step": 1,
        "status": "success",
        "third_party_reference_1": "TX-ZAR-DEP-1001"
    },
    "status_code": "000000"
}

Redirect the user to authorization_url to complete authentication with their bank.

Capitec Deposit Request

{
    "client_id": "YOUR_CLIENT_ID",
    "params": {
        "amount": 500,
        "callback_url": "https://example.com/callback",
        "country_id": 15,
        "currency": "ZAR",
        "failure_url": "https://example.com/payment-failed",
        "id_number": "9001015800083",
        "mobile": "27600000000",
        "name": "John Doe",
        "payment_method_type": "capitec",
        "successful_url": "https://example.com/payment-success",
        "third_party_reference_1": "TX-CAP-DEP-1002",
        "third_party_reference_2": "CUST-302"
    },
    "salt": "random_salt_12345",
    "sender": "YOUR_INTEGRATION_NAME",
    "timestamp": 1724835600,
    "signature": "a1b2c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0"
}

Payout Request (Bank Transfer)

{
    "client_id": "YOUR_CLIENT_ID",
    "params": {
        "amount": 1000,
        "client_callback_url": "https://example.com/callback",
        "country_id": 15,
        "currency": "ZAR",
        "email": "customer@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "mobile": "2768856789",
        "payment_method_type": "bank",
        "payment_reference": "YOUR-PAYOUT-REF",
        "third_party_reference_1": "TX-ZAR-DISB-2001",
        "bank": [
            {
                "bank_name": "ABSA",
                "bank_code": "0001",
                "branch_name": "Sandton",
                "account_name": "John Doe",
                "account_number": "4081234567"
            }
        ]
    },
    "salt": "random_salt_12345",
    "sender": "YOUR_INTEGRATION_NAME",
    "timestamp": 1724835600,
    "signature": "a1b2c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0"
}

Webhook/Callback Examples

Successful Deposit Callback

{
    "client_id": "YOUR_CLIENT_ID",
    "salt": "random_salt_12345",
    "sender": "YOUR_INTEGRATION_NAME",
    "timestamp": 1724835600,
    "signature": "a1b2c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0",
    "params": {
        "amount": 500,
        "currency": "ZAR",
        "depositId": "dep_12345678",
        "email": "customer@example.com",
        "mobile": "2763456789",
        "name": "John Doe",
        "payment_step": 2,
        "status": "success",
        "status_code": "000000",
        "third_party_reference_1": "TX-ZAR-DEP-1001",
        "third_party_reference_2": "CUST-301"
    }
}

Successful Payout Callback

{
    "client_id": "YOUR_CLIENT_ID",
    "salt": "random_salt_12345",
    "sender": "YOUR_INTEGRATION_NAME",
    "timestamp": 1724835600,
    "signature": "a1b2c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0",
    "params": {
        "account": "4081234567",
        "amount": 1000,
        "currency": "ZAR",
        "fee": 10,
        "message": "Payment was transferred successfully.",
        "mobile": "2768856789",
        "payee": "John Doe",
        "payment_channel": "EFT",
        "payment_reference": "YOUR-PAYOUT-REF",
        "payment_step": 2,
        "payoutId": "bd8f51a2-xxxx-xxxx-xxxx-xxxxx9a",
        "ref": "ref_98765432",
        "status": "success",
        "statusCode": "000000",
        "third_party_reference_1": "TX-ZAR-DISB-2001",
        "third_party_reference_2": null,
        "transaction_date": "2026-08-28 12:30:00",
        "transaction_detail": "Disbursement made through EFT",
        "type": "Pay out"
    }
}

Try it

Try it: POST /api/v4/niobi-unified-collections

Collections API reference for South Africa deposits.

Try it: POST /api/v4/niobi-unified-payments

Payments API reference for South Africa payouts.

Transaction Limits

For the full list of minimum and maximum transaction limits for South Africa (ZAR) collections and payouts, please see the Transaction Limits for South Africa section on the Transaction Limits page.

Get Started with Niobi

API Authentication

Collecting Payments

Making Payments

Transaction Status

Supporting Documentation

South Africa | Supported Payment Methods & Corridors

South Africa

Supported Payment Methods & Payload Requirements

Payment Flow: How It Works

Deposits (Collections)

1. EFT Bank Collections (`payment_method_type: "bank_eft"`)

Supported South African Banks for EFT Collections:

2. Capitec Collections (`payment_method_type: "capitec"`)

Payouts (Disbursements)

Sample Requests & Responses

EFT Deposit Request

EFT Deposit Response (Initiation)

Capitec Deposit Request

Payout Request (Bank Transfer)

Webhook/Callback Examples

Successful Deposit Callback

Successful Payout Callback

Try it

Try it: POST /api/v4/niobi-unified-collections

Try it: POST /api/v4/niobi-unified-payments

Transaction Limits

​South Africa

​Supported Payment Methods & Payload Requirements

​Payment Flow: How It Works

​Deposits (Collections)

​1. EFT Bank Collections (payment_method_type: "bank_eft")

​Supported South African Banks for EFT Collections:

​2. Capitec Collections (payment_method_type: "capitec")

​Payouts (Disbursements)

​Sample Requests & Responses

​EFT Deposit Request

​EFT Deposit Response (Initiation)

​Capitec Deposit Request

​Payout Request (Bank Transfer)

​Webhook/Callback Examples

​Successful Deposit Callback

​Successful Payout Callback

​Try it

Try it: POST /api/v4/niobi-unified-collections

Try it: POST /api/v4/niobi-unified-payments

​Transaction Limits

South Africa

Supported Payment Methods & Payload Requirements

Payment Flow: How It Works

Deposits (Collections)

1. EFT Bank Collections (`payment_method_type: "bank_eft"`)

Supported South African Banks for EFT Collections:

2. Capitec Collections (`payment_method_type: "capitec"`)

Payouts (Disbursements)

Sample Requests & Responses

EFT Deposit Request

EFT Deposit Response (Initiation)

Capitec Deposit Request

Payout Request (Bank Transfer)

Webhook/Callback Examples

Successful Deposit Callback

Successful Payout Callback

Try it

Transaction Limits