getting-started
Kyshi MoR gives businesses one API for collections, virtual accounts, transfers, payment links, plans, subscriptions, and reconciliation.
Use these guides when you are deciding which product flow to build. Use the API Reference when you need exact endpoint paths, required fields, response examples, generated code samples, or the Try It console.
How To Integrate Safely
- Start in test mode with your test secret key.
- Pick the product flow that matches your use case.
- Build the server-side API calls from your backend.
- Configure webhooks before you go live.
- Verify important events from your server before giving value.
- Reconcile periodically with list and history endpoints.
Choose The Right Flow
| Goal | Start Here |
|---|---|
| Collect a checkout payment | Transactions |
| Collect by bank transfer into a virtual account | Virtual Accounts |
| Send money to a bank account | Transfers |
| Send NGN payouts from the virtual-account rail | Virtual Account Transfer |
| Share a customer-specific checkout link | Payment Links |
| Share a reusable checkout link | General Payment Links |
| Bill customers on a schedule | Plans and Subscriptions |
| Check FX/rate data | Miscellaneous or Rates in the API Reference |
Response Basics
Kyshi responses are JSON. Successful responses use this envelope:
{
"status": true,
"message": "Success",
"code": 200,
"data": {}
}Errors use the same structure with status: false. Your integration should check both the HTTP status code and the status field.
Currency Basics
Send currency codes as uppercase strings such as NGN, KES, GHS, XOF, ZAR, or USD, depending on the endpoint and what is enabled for your business.
Send request amounts as numbers in major currency units, for example 1000 for 1000 NGN. Where an endpoint supports amountCurrency, use local when the amount is already in the customer's local currency and settlement when Kyshi should calculate the local amount from your settlement currency.
Updated 2 days ago
