Introduction
Welcome to the Kiotapay user guide and API reference. Integrate mobile money and bank payments for collections, payouts and real-time transaction data.
The Kiotapay API is designed for seamless integration, whether you're facilitating collections, managing payouts, or accessing real-time transaction data. Our API architecture ensures scalability, security and efficiency, letting merchants integrate mobile money and bank payments with ease.
Disbursements
Our Disbursement APIs are optimized for mobile money and bank payouts, ensuring fast, secure and reliable fund transfers. These endpoints support businesses in transferring funds to individuals, whether via mobile money or directly to a bank account.
Use cases
- Mobile Money B2C — transfer funds to individual customers' mobile wallets in real time, for seamless payments for goods and services.
- Bank Payouts — make direct transfers to a customer's bank account, whether for salary payments or other disbursements.
- Mobile Money B2B Paybill — pay into a business mobile money paybill, essential for businesses that transact with other businesses over mobile money.
- Mobile Money B2B Till — transfer funds to a mobile money till, making bulk payments easier for organisations.
Mobile Money B2C
Transfer funds to a customer's mobile money wallet. Supports both local and cross-border transactions.
Bank Payouts
Transfer funds to a customer's bank account over Pesalink — salary disbursements, vendor payments and more.
Mobile Money B2B Paybill
Pay bills, utilities and service providers through a business mobile money paybill.
Mobile Money B2B Till
Transfer funds to a business mobile money till, streamlining payments for retail and wholesale operations.
Collections
Collections APIs streamline the process of receiving payments, whether for goods, services or subscriptions. With secure and efficient handling of both mobile and bank transactions, these endpoints help businesses automate payment reception.
Use cases
- Mobile Money C2B Paybill — accept payments directly from customers via mobile money paybills, across a variety of mobile wallets.
- Bank Collections — collect payments from customers via bank transfer. Ideal for service-based industries and recurring payments.
- Mobile Money C2B STK Push — a customer-initiated flow where the customer receives a prompt on their phone and confirms with their PIN.
Mobile Money C2B Paybill
Receive mobile payments from customers buying goods or services. Integrates with leading mobile wallets including M-Pesa and Airtel Money.
Bank Collections
Accept payments directly from your customers' bank accounts.
Mobile Money C2B STK Push
Trigger a prompt on the customer's phone so they can approve the payment with their PIN — a highly secure way to collect.
API architecture and design principles
The Kiotapay API is designed with simplicity, reliability and security at its core. Below is a breakdown of the principles that shape it.
1. Easy integration
The API is straightforward to integrate with your business operations. Whether you're a small business or a large enterprise, you'll find it intuitive and well-documented, so you can start processing payments quickly.
2. Secure transactions
Every interaction with the API is encrypted using TLS, ensuring transactions are protected from unauthorized access. Authentication uses OAuth 2.0, so only authorized users can move money.
3. Reliability
The API is built to be highly available so you can process payments 24/7 without interruption, and handles large volumes of requests during peak times while maintaining performance.
4. Real-time processing
Payments are processed in real time, so you can confirm transactions instantly — whether it's a mobile money payout, a bank transfer or a customer payment.
5. Versioning and backward compatibility
As we release new features, we maintain backward compatibility, so your integrations won't break. You'll always be able to adopt the latest features without disrupting your current setup.
6. Error handling and transparency
When something goes wrong, the API returns clear, actionable error messages. You'll know why a transaction failed and what to do about it. See the error reference for the full catalogue.
7. Rate limiting for fair use
Rate limits cap how many requests can be made in a given period. This prevents overloads and ensures fair usage across all merchants.
Why choose Kiotapay?
Our API is optimized for businesses of all sizes, from small merchants to large enterprises. Whether you're in retail, banking or any service-based industry, Kiotapay offers a reliable and secure solution for handling transactions, collections and disbursements.
Get in touch
For questions or support, email apps@kiotapay.com or visit the Kiotapay dashboard.
