Skip to Content
Getting Started with KisPayOverview

Overview

The KisPay Developer Platform provides comprehensive tools and APIs for integrating secure, efficient payment processing into your websites, mobile apps, or e-commerce platforms. Whether you’re building a simple checkout flow or a sophisticated direct payment system, our APIs are designed to be flexible, reliable, and developer-friendly, drawing inspiration from industry standards like Stripe and Chapa.

Key Features

  • Multiple Payment Methods: Support for popular Ethiopian payment options including Telebirr, CBE Birr (mobile money), and standard card payments like Visa.
  • Checkout Options:
    • Redirect Checkout: Seamlessly redirect users to a hosted KisPay payment page for easy integration.
    • Direct Checkout: Process payments directly within your application without redirects for a smoother user experience.
  • Real-Time Updates: Use webhooks, Server-Sent Events (SSE), or polling to handle payment status changes asynchronously.
  • Security and Compliance: API key authentication, webhook signature verification, and best practices for handling sensitive data.
  • Testing Environment: Dedicated test mode with sample credentials to simulate transactions without real funds.

Get Started

  1. Sign Up and Get API Keys: Create an account on the KisPay Merchant Dashboard and generate your API keys (live and test).

  2. Choose Your Integration: - For quick setup: Use the Redirect Checkout API. - For embedded experience: Implement the Direct Checkout flow.

  3. Implement Payment Flow: - Create checkout sessions. - Handle payments and verifications. - Set up webhooks for notifications.

  4. Test and Go Live: Thoroughly test in sandbox mode before switching to production.

Authentication

All API requests require your API key in the x-api-key header. Use test keys for development:

x-api-key: KPG_TEST-249f4db141ac4da785c0112137091825
Important: Never expose API keys in client-side code. Always handle them securely on your server.

Available Payment Methods

Fetch available methods dynamically via:

GET /api/checkout/payment_methods

Example Response:

response
{ "statusCode": 200, "message": "Payment methods retrieved", "body": { "methods": [ { "id": "telebirr", "name": "Telebirr", "logoUrl": "https://cdn.kispay.et/logos/telebirr.svg" }, { "id": "cbe", "name": "CBE Birr", "logoUrl": "https://cdn.kispay.et/logos/cbe.svg" }, { "id": "visa", "name": "Visa", "logoUrl": "https://cdn.kispay.et/logos/visa.svg" } ] }, "timestamp": "2023-10-10T15:30:45Z" }

Base URLs

  • Production: https://api.kispay.et

If you need assistance, contact our support team at developers@kispay.et or support@kispay.et.

Last updated on