The Kyshi MoR API lets you collect payments, create virtual accounts, send transfers, manage subscriptions, and reconcile transactions from your own backend.
This Reference is to be used when you need exact methods, paths, parameters, request bodies, response examples, and code samples.
How The Reference Is Organized
| Section | Use It For |
|---|---|
| Transactions | Card checkout, bank-transfer charges, verification, and transaction history. |
| Virtual Accounts | Creating collection accounts, checking wallet balances, verifying credits, and test-mode credit simulation. |
| Transfers | Standard bank payouts to saved or inline beneficiaries. |
| VA Transfer | NGN virtual-account-funded payouts to Nigerian bank accounts. |
| Payment Links | Customer-specific hosted checkout links. |
| General Payment Links | Reusable payment links where the customer checks out later. |
| Plans | Recurring billing plan setup. |
| Subscriptions | Creating, charging, retrying, and managing recurring billing. |
| Rates | Public and business-specific exchange-rate lookup. |
Recommended Integration Order
- Create or confirm your Kyshi business and integration settings in the dashboard.
- Get your test secret key.
- Configure your test webhook URL.
- Build your first flow using the relevant guide.
- Use this API Reference for exact endpoint details and Try It requests.
- Verify every payment or transfer from your server before updating your customer-facing state.
- Switch to your live key only after test-mode reconciliation is working.
Guides vs API Reference
Use Guides when you are deciding which flow to build and what order to call things in.
Use API Reference when you already know the endpoint and need exact fields, enum values, request examples, response shape, or generated language samples.