OuiPay Documentation
Build payments, transfers, and exchange into your product with the OuiPay REST API.
OuiPay is a licensed payments institution platform. The API lets you accept payments, send transfers, hold wallet balances, and convert currencies with a double-entry ledger behind every movement of money.
Where to start
Get your API keys
Obtain sandbox credentials and set up your authentication headers.
First API Request
Create your first customer and payment in under five minutes.
Accept a payment
Collect money from cards, bank transfers, and mobile money.
Send money
Pay out to bank accounts, mobile money, and wallets.
API Reference
Canonical HTTP contract for every endpoint with multi-language code samples.
Webhooks Engine
Verify signatures, handle event delivery, and manage retry policies.
API conventions
Every request follows the same REST contract:
- Base URL:
https://api.ouipay.com/v1(see Base URLs & Environments) - Auth:
Authorization: Bearer sk_live_...(see Authentication) - Ids: ULIDs, e.g.
01M2S17G4A0N9MDMXYSCCX8SPS - Money: integer minor units plus ISO currency:
100000, "NGN"is ₦1,000.00 - Idempotency:
Idempotency-Keyheader required on all money-moving POSTs (see Implement Idempotency) - Errors: machine-readable:
{"error": {"code", "message", "request_id"}}(see API Error Codes) - Status: explicit state machine;
pendingis not posted. A provider timeout surfaces asunknown, never guessed.
Sandbox vs live
Use sk_test_ keys against https://api.ouipay.com/v1 sandbox mode. Test
keys never move real money; live keys always do.