Track our API evolution — from the first public launch to the latest versions.
​
23 August 2025
APIcaph
caph.2025-08-23
OpenAPI file

​
🚀 Added

  • Receipts management: Two resource operations were introduced for payment receipt management:
    • GET /v1/receipts/{orderNumber} → Retrieve full receipt details.
    • POST /v1/receipts/{orderNumber}/redeem → Redeem entitlements (full or partial).
  • USD support for Checkout Sessions: Checkout Sessions now accept collections in USD, expanding beyond local currency support.

​
💡 Common Use Cases

  • Verify a purchase – Retrieve a receipt by order number to confirm items, status, and timestamp.
  • Redeem event tickets or vouchers – Mark entitlements as redeemed at point of entry.
  • Partial redemption – Consume part of a multi-item receipt (e.g., ride credits, vouchers).
  • Full redemption – Mark a receipt as fully consumed to prevent reuse.
  • Checkout in USD – Allow merchants to receive funds in U.S. dollars.

​
❌ Breaking Changes

  • ✅ None. Fully backward-compatible with caph.2025-06-20.

​
Upgrade Guide — caph.2025-06-20 → caph.2025-08-23

  • No migration required.
  • All existing integrations remain valid.
This release extends the caph line into post-payment fulfillment (Receipts) and broadens checkout session supports with USD collections.
​
20 June 2025
APIcaph
caph.2025-06-20

​
🔄 Major Expansion — First caph Version

This version officially launched the caph release line, introducing versioned endpoints (/v1/...) and establishing the foundation for stable, long-term growth.OpenAPI file

​
🚀 Added

  • POST /v1/payments → Unified payment initiation.
  • GET /v1/financial-accounts, /v1/financial-transactions → Accounts and ledger-style transaction history.
  • POST /v1/checkout-sessions → Hosted checkout for e-commerce & embedded flows.
  • POST /v1/internal-transfers → Secure transfers between accounts.
  • POST /v1/ussd-otps → OTP generation & validation.
  • GET /v1/provider-kyc/{providerId} → Standardized provider KYC.

​
🏗️ New Resources

  • Payment, CheckoutSession, FinancialAccount, FinancialTransaction, InternalTransfer, UssdOtp, ProviderKYC.

​
❌ Breaking Changes (from 2024-08-01)

  • All endpoints moved under /v1/... namespace.
  • Enumerated values for fields changed from camelCase to snake_case.
  • Schema migration: The schema of all previous resources has been updated, fields renamed, dropped, or added.
  • Legacy unversioned endpoints (/banks, /momos, /countries, /payment-codes, /payouts, /webhooks) are no longer supported.

​
Upgrade Guide — 2024-08-01 → caph.2025-06-20

If you’re upgrading from the 2024-08-01 version, follow these steps:
  1. Switch to /v1/... endpoints.
  2. Replace the schema of all old resources with the new ones.
  3. Re-register webhooks under /v1/webhooks.
  4. Validate new flows (payments, checkout, accounts).
✅ After this migration, you are on the caph release track, ensuring compatibility with all future updates.
​
1 August 2024
APIDeprecated
2024-08-01

​
🎉 Public API Launch

This release marked the public debut of our API, giving developers their first programmable entry point into the platform.OpenAPI file

​
Operations

  • /banks, /momos, /countries → Provider and country lookups.
  • /payment-codes → Generate short-lived collection codes.
  • /payouts → Disburse funds externally.
  • /kyc-verifications/{providerCode} → Provider-level KYC checks.
  • /webhooks → Subscribe to basic events.

​
🏗️ Base Schemas

  • Bank, Country, Momo, PaymentCode, Payout, Webhook, KYCVerification.