Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kwugwo.africa/llms.txt

Use this file to discover all available pages before exploring further.

One API for all PSPs. Wire up Kwugwo once and accept payments through every Payment Service Provider you can plug into your workspace — Paystack today, more soon. You configure the PSPs and the routing rules from the dashboard; the API stays the same. Customers pay through local mediums — bank transfers, mobile money, and USSD — and Kwugwo routes each charge to the right PSP behind the scenes. This reference documents the merchant-facing REST API under the /v1 namespace. Every request is authenticated with a secret API key that you generate from your dashboard.

Environments

Kwugwo runs two completely isolated environments. Use sandbox while you build — its transactions never settle real money — and flip to live when you’re ready to take real payments.
EnvironmentBase URLWhen to use
Sandboxhttps://sandbox-api.kwugwo.africaDevelopment, automated tests, and exploring the API. Settles against PSP test mode.
Livehttps://api.kwugwo.africaReal customers, real money.
Each environment has its own API keys, its own workspaces, and its own ledger of customers, ugwos, and webhooks — data does not cross the boundary. A sandbox ugwo uid is not fetchable with a live key and vice versa. See Authentication for how each key tier maps to an environment.
Every example on this site uses the live base URL for readability. To run a snippet against sandbox, swap api.kwugwo.africa for sandbox-api.kwugwo.africa and use your sandbox key.

Start here

Embed our checkout (recommended)

Drop the Kwugwo overlay onto your site in five lines of JavaScript — no PCI scope, no iframe plumbing, every payment medium we support without writing any new client code. This is the fastest path to a working integration.
Prefer to build your own checkout UI? Use the API directly:

Charge customers

Create an ugwo (a payment request) and process it against a medium of your choice.

Manage customers

Store and update customer records (onye) and attach metadata, references, and billing addresses.

Read your checkouts

Read the checkout configurations you built in the dashboard and surface the supported mediums to your customers.

Track activities

Every charge on an ugwo is recorded as an activity that you can poll until it reaches a terminal state.

A note on naming

Kwugwo borrows a few terms from African languages. They are short, distinct, and easy to grep for in your codebase:
TermMeaning
UgwoA payment request — what you charge.
OnyeA customer / payer.
NzubeA workspace (your merchant account).
Kwugwo”Pay the debt” — the brand.
See Concepts for the full glossary and how the resources relate.

Where to go next

Authentication

How to send your secret key and what each key tier can do.

Webhook deliveries

How Kwugwo notifies you when an ugwo or activity changes — and how to verify the signature.