Introduction
Introduction
What OuiPay is, what the API covers, and how the platform is organized.
OuiPay is a licensed payment institution platform operating across West Africa. The platform holds customer balances on a double-entry ledger and exposes a REST API for building payment products on top of it.
What you can build
- Collections: accept card, bank transfer, and mobile money payments
- Payouts: send transfers to bank accounts and other OuiPay wallets
- Wallets: hold customer balances with holds, limits, and statements
- Exchange: convert between supported currencies at quoted rates
- Services: sell airtime, data, and bill payments through one API
Base URLs & Environments
| Environment | Base URL | Keys |
|---|---|---|
| Sandbox | https://api.ouipay.com/v1 | sk_test_ |
| Live | https://api.ouipay.com/v1 | sk_live_ |
Sandbox returns real response shapes with simulated providers. The same code path serves both modes: switch the key to go live.
Reading these docs
- How the API Works: pipeline request flow from intake to ledger posting and webhooks
- Getting Started: API credentials, authentication, first request, and test sandbox transactions
- API Reference: canonical HTTP contract per endpoint, with cURL, JavaScript, PHP, and Python code tabs
- Webhooks Engine: event catalogue, signature verification, retry policies, and replay security
- Transactions: status machine, idempotency keys, and requerying status
- Errors: HTTP status codes, machine-readable API error codes, and troubleshooting
- Guides: end-to-end integration workflows (accepting payments, sending payouts, cross-border FX)
- Resources: OpenAPI spec, Postman collections, and changelog