DEVELOPER FIRST PLATFORM

Build Payments in Minutes, Not Days

Integrate mobile money payments with a few lines of code. Our developer-friendly API, comprehensive SDKs, and detailed documentation help you go from zero to production in record time.

Lightning Fast

Integrate in minutes with our simple API

Enterprise Security

Bank-grade encryption and compliance

Global Scale

Handle millions of transactions seamlessly

Get Started in Minutes

Follow these simple steps to integrate ZOPAY into your application

Create Account

Get API Keys

Generate your sandbox and production API keys from the dashboard

Get Keys

Integrate

Use our SDKs or API to start accepting payments in your app

View Docs

Go Live

Test in sandbox, then switch to production for real transactions

Go Live

Comprehensive Documentation

Everything you need to integrate and scale with ZOPAY

Getting Started

Quick start guide, authentication, and your first integration

Learn more

Collections

Accept payments from customers via mobile money

Learn more

Disbursements

Send money to customers, suppliers, and employees

Learn more

Webhooks

Real-time event notifications and signature verification

Learn more

Authentication

API keys, HMAC signatures, and security best practices

Learn more

API Reference

Complete reference for all API endpoints and parameters

Learn more

Choose Your Integration Method

Select the integration approach that best fits your development workflow and platform requirements

JavaScript SDK Example

javascript

<script src="https://cdn.zopay.com/js/zopay.min.js"></script>
<script>
  const zopay = new ZoPay({
    publicKey: 'YOUR_PUBLIC_KEY',
    onSuccess: (response) => {
      console.log('Payment successful:', response);
    },
    onError: (error) => {
      console.error('Payment failed:', error);
    }
  });
  
  zopay.openPaymentModal({
    amount: 10000,
    currency: 'XAF',
    email: 'customer@example.com',
    reference: 'TXN-' + Date.now()
  });
</script>

Key Features

Popup modal for seamless checkout experience
Event callbacks for success/error handling
Customizable styling and branding options

Getting Started

1. Get Your API Keys

2. Choose Your Method

Select the integration method that best fits your platform and requirements

3. Test in Sandbox

Use test mode to simulate payments without charging real money

4. Go Live

Switch to production keys and start accepting real payments

Request Parameters

The following parameters can be sent through HTTP GET or POST request to the payment URL

Parameter	Type	Required	Description	Example
`public_key`	string		Your public API key from the dashboard	`pk_live_a1b2c3d4e5f6g7h8`
`amount`	integer		Transaction amount in XAF (minimum 100 XAF)	`10000`
`currency`	string		Currency code (currently XAF)	`XAF`
`email`	string		Customer email address	`customer@example.com`
`reference`	string		Unique transaction reference (alphanumeric, max 50 chars)	`TXN-20240526-001`
`first_name`	string	—	Customer first name	`John`
`last_name`	string	—	Customer last name	`Doe`
`phone`	string	—	Customer phone number	`+237671234567`
`description`	string	—	Transaction description/purpose	`Online store purchase`
`metadata`	object	—	Custom data as JSON object (max 1KB)	`{"order_id":"12345","user_id":"67890"}`
`redirect_url`	string	—	URL to redirect after successful payment	`https://yoursite.com/success`
`payment_method`	string	—	Preferred payment method (mobile_money, card, bank_transfer, international)	`mobile_money`
`api_version`	string	—	API version to use	`v1`

HTTP GET Request

All parameters are appended to the URL as query strings:

GET https://pay.zopay.com/pay?public_key=YOUR_KEY&amount=10000&...

HTTP POST Request

Send parameters in the request body as form data:

POST https://pay.zopay.com/pay
Content-Type: application/x-www-form-urlencoded

Important Notes

⚠Always use HTTPS for production. HTTP is only for development/testing.
⚠Special characters in parameters should be URL-encoded
⚠Reference must be unique for each transaction. Duplicate references will be rejected.
⚠Never expose your secret API key in client-side code

SDKs & Libraries

Official SDKs for popular programming languages

⚡

Node.js/JavaScript

Official SDK for Node.js and JavaScript environments

npm install @zopay/sdk

View Docs

🐍

Python

Python SDK for server-side integration

pip install zopay

View Docs

🐘

PHP

PHP SDK for Laravel, WordPress, and other frameworks

composer require zopay/sdk

View Docs

☕

Java

Java SDK for enterprise applications

gradle: com.zopay:sdk:latest

View Docs

🔵

Go

Go SDK for high-performance applications

go get github.com/zopay/go-sdk

View Docs

💎

Ruby

Ruby SDK for Rails and Ruby applications

gem install zopay

View Docs

API Reference

Comprehensive API documentation with examples for all endpoints, including authentication, transactions, webhooks, and more.

Developer FAQ

Common questions about integration and API usage

Need More Help?

Our developer support team is here to help. Check out our detailed documentation or reach out through our support channels.

Need Help?

Our team is here to help you succeed

Developer Support

Get help from our technical team

Contact Support

Documentation

Browse our comprehensive guides

View Docs

API Status

Check system status and uptime

Check Status

Build Payments in Minutes, Not Days

Integrate mobile money payments with a few lines of code. Our developer-friendly API, comprehensive SDKs, and detailed documentation help you go from zero to production in record time.

Lightning Fast

Integrate in minutes with our simple API

Enterprise Security

Bank-grade encryption and compliance

Global Scale

Handle millions of transactions seamlessly

<script src="https://cdn.zopay.com/js/zopay.min.js"></script> <script> const zopay = new ZoPay({ publicKey: 'YOUR_PUBLIC_KEY', onSuccess: (response) => { console.log('Payment successful:', response); }, onError: (error) => { console.error('Payment failed:', error); } }); zopay.openPaymentModal({ amount: 10000, currency: 'XAF', email: 'customer@example.com', reference: 'TXN-' + Date.now() }); </script>

Parameter

Type

Required

Description

Example

public_key

string

Your public API key from the dashboard

pk_live_a1b2c3d4e5f6g7h8

amount

integer

Transaction amount in XAF (minimum 100 XAF)

10000

currency

string

Currency code (currently XAF)

XAF

email

string

Customer email address

customer@example.com

reference

string

Unique transaction reference (alphanumeric, max 50 chars)

TXN-20240526-001

first_name

string

—

Customer first name

John

last_name

string

—

Customer last name

Doe

phone

string

—

Customer phone number

+237671234567

description

string

—

Transaction description/purpose

Online store purchase

metadata

object

—

Custom data as JSON object (max 1KB)

{"order_id":"12345","user_id":"67890"}

redirect_url

string

—

URL to redirect after successful payment

https://yoursite.com/success

payment_method

string

—

Preferred payment method (mobile_money, card, bank_transfer, international)

mobile_money

api_version

string

—

API version to use

v1

Build Payments in Minutes, Not Days

Lightning Fast

Enterprise Security

Global Scale

Get Started in Minutes

Create Account

Get API Keys

Integrate

Go Live

Comprehensive Documentation

Getting Started

Collections

Disbursements

Webhooks

Authentication

API Reference

Choose Your Integration Method

JavaScript SDK

Inline Embed

Payment Link

REST API

Key Features

Getting Started

1. Get Your API Keys

2. Choose Your Method

3. Test in Sandbox

4. Go Live

Request Parameters

HTTP GET Request

HTTP POST Request

Important Notes

SDKs & Libraries

Node.js/JavaScript

Python

PHP

Java

Go

Ruby

API Reference

Developer FAQ

How do I get my API keys?

What is the difference between public and secret keys?

Which payment methods do you support?

How do I handle payment webhooks?

What is the transaction fee structure?

How long does it take for funds to settle?

Do you support refunds?

What security measures are in place?

How do I test the integration?

What are the minimum and maximum transaction amounts?

Need More Help?

Need Help?

Developer Support

Documentation

API Status

Build Payments in Minutes, Not Days

Lightning Fast

Enterprise Security

Global Scale

Get Started in Minutes

Create Account

Get API Keys

Integrate

Go Live

Comprehensive Documentation

Getting Started

Collections

Disbursements

Webhooks

Authentication

API Reference

Choose Your Integration Method

JavaScript SDK

Inline Embed

Payment Link

REST API

Key Features

Getting Started

1. Get Your API Keys

2. Choose Your Method