💳 Ozow Flutter SDK

The easiest way to accept payments in South Africa using Flutter.

🚀 3 lines to get started 🔐 Production-ready architecture 🔥 Firebase integration included

Get Started • Production Setup • Example App

🎥 Demo

Watch the plugin in action:

👉 https://youtube.com/shorts/H1KOdCjFCEk?feature=share

This demo shows:

  • Payment flow
  • Ozow checkout UI
  • Result handling (success / cancel / error)

ozow_payment_plugin

pub.dev Flutter Platform Production Ready License

A production-ready Flutter SDK for the Ozow payment gateway, built for African developers.

Accept Card, Pay by Bank, PayShap, and Voucher payments with minimal setup, secure backend support, and Firebase-ready architecture.

⚡ Built for startups, fintech apps, marketplaces, and ride-hailing platforms.

✨ Features

  • ✅ 3 lines of code to start accepting payments
  • ✅ Secure WebView checkout (Ozow hosted page)
  • ✅ All payment methods — Card, Pay by Bank, PayShap, Vouchers
  • ✅ SHA512 signing support
  • ✅ Result callbacks — success, cancelled, error, pending
  • ✅ Bank-branded UI buttons
  • ✅ PCI compliant — no card data handled by your app
  • ✅ Firebase-ready architecture
  • ✅ Android, iOS & Web support

🚀 Quick Start (Testing Only)

final result = await OzowPaymentPlugin.startPayment(
  context: context,
  config: OzowConfig(
    siteCode: 'YOUR_SITE_CODE',
    privateKey: 'YOUR_PRIVATE_KEY',
    apiKey: 'YOUR_API_KEY',
    amount: 150.00,
    transactionReference: 'ORDER-001',
    bankReference: 'My Store',
  ),
);

⚠️ This method is for testing only — do NOT use in production

🔐 Production Integration (Recommended)

In production:

  • Private keys stay on your backend
  • Hash is generated securely
  • Flutter app never exposes secrets
final paymentData = await MyBackend.createPayment();

final result = await OzowPaymentPlugin.startPayment(
  context: context,
  config: OzowConfig(
    siteCode: paymentData.siteCode,
    privateKey: '',
    apiKey: paymentData.apiKey,
    amount: paymentData.amount,
    transactionReference: paymentData.reference,
    bankReference: 'My Store',
    hashCheck: paymentData.hash,
  ),
);

🏗️ Architecture (Production)

Flutter App ⬇ Firebase Cloud Function / Backend ⬇ Secret Manager / Environment Variables ⬇ Ozow API

🔐 Production Backend Setup (Firebase)

Follow these steps to securely integrate Ozow in production.

1️⃣ Install Node.js

Download and install Node.js (LTS).

Verify:

node -v
npm -v

2️⃣ Install Firebase CLI

npm install -g firebase-tools
firebase --version

3️⃣ Login to Firebase

firebase login

4️⃣ Initialize Firebase Functions

From your project root:

firebase init functions

Select:

  • JavaScript
  • Your Firebase project
  • Install dependencies

5️⃣ Add your Cloud Function

Inside functions/index.js:

const functions = require("firebase-functions");
const crypto = require("crypto");

exports.createOzowPayment = functions.https.onRequest((req, res) => {
  const { amount, reference } = req.body;

  const siteCode = process.env.OZOW_SITE_CODE;
  const privateKey = process.env.OZOW_PRIVATE_KEY;

  const data = `${siteCode}${reference}${amount}${privateKey}`;

  const hash = crypto
    .createHash("sha512")
    .update(data)
    .digest("hex");

  res.json({
    siteCode,
    apiKey: process.env.OZOW_API_KEY,
    amount,
    reference,
    hash,
    bankReference: "My Store",
    isTest: true
  });
});

6️⃣ Install dependencies

cd functions
npm install firebase-admin firebase-functions

7️⃣ Add environment variables

Create functions/.env:

OZOW_SITE_CODE=YOUR_SITE_CODE
OZOW_API_KEY=YOUR_API_KEY
OZOW_PRIVATE_KEY=YOUR_PRIVATE_KEY

8️⃣ Protect your secrets

Add to .gitignore:

functions/.env

9️⃣ Deploy your functions

From project root:

firebase deploy --only functions

🔟 Use your backend URL

After deployment, Firebase will give you:

https://YOUR_REGION-YOUR_PROJECT.cloudfunctions.net/createOzowPayment

Use this in your Flutter app.

🧪 Optional: Test before deploy

cd functions
node -e "require('./index.js'); console.log('OK')"

⚠️ Common Errors

npm not recognized → Install Node.js and restart terminal

404 from backend → Check your function URL is correct

Cannot find module → Check folder structure and file names

🔥 Firebase Integration

Remote Config (Safe Usage)

Use Remote Config for:

  • Feature toggles
  • Payment enable/disable
  • Test vs live mode
final isTest = remoteConfig.getBool('ozow_is_test');

⚠️ Never store secrets in Remote Config

📦 Result Handling

if (result.isSuccess) {
  // Payment successful
} else if (result.isCancelled) {
  // User cancelled
} else if (result.isError) {
  // Payment failed
} else if (result.isPending) {
  // Processing
}

🎯 Use Cases

  • Ride-hailing apps
  • E-commerce platforms
  • Wallet systems
  • Subscription apps
  • Fintech products

🏦 Supported Payments

  • 💳 Card (Visa / Mastercard)
  • 🏦 Pay by Bank (EFT)
  • ⚡ PayShap
  • 🎫 Vouchers

🔐 Security

  • Hosted checkout (Ozow)
  • No card data handled in-app
  • SHA512 request signing
  • TLS encryption
  • Backend-secured secrets

⚠️ Important

Never store your Ozow private key in your Flutter app.

🤝 Contributing

Pull requests are welcome.

📞 Support

  • GitHub Issues
  • Ozow Support

Built with ❤️ by Tilly Legodi for the African Flutter community 🇿🇦

Libraries

ozow_payment_plugin