Skip to main content

Intro K2 USSD API

Introduction​

Welcome to the K2 Telecom USSD API documentation. This API allows you to integrate USSD (Unstructured Supplementary Service Data) services into your applications for seamless mobile money transactions and USSD menu interactions.

What is USSD?​

USSD (Unstructured Supplementary Service Data) is a protocol used by mobile phones to communicate with a service provider's computers. It's commonly used for mobile banking, balance checking, and interactive menu systems.

Base URL​

https://www.k2-ussd-api.devlorde.xyz/

Getting Started​

To get started with the K2 Telecom USSD API, you'll need to:

  1. Obtain API Credentials: Contact K2 Telecom to get your API key and secret
  2. Set up Authentication: Use API key and secret headers for secure API access
  3. Make API Calls: Start integrating USSD functionality into your application

API Features​

The K2 Telecom USSD API provides endpoints for:

  • Authentication: Secure API key and secret authentication
  • USSD Sessions: Manage USSD session data and user interactions
  • Transactions: Process payments and check transaction status
  • Balance Queries: Check account balances
  • Menu Navigation: Handle USSD menu flows
  • Error Handling: Comprehensive error responses and status codes

Authentication​

All API requests require authentication using API key and secret headers:

x-api-key: <your_key_token>
x-api-secret: <your_sec_token>

Example Request​

curl -X GET https://www.k2-ussd-api.devlorde.xyz/data/collection \
  -H "x-api-key: <your_key_token>"
  -H "x-api-secret: <your_sec_token>"
  -H "Content-Type: application/json"

Response Format​

All API responses follow a consistent JSON format:

{
  "success": true,
  "data": {
    // Response data here
  },
  "message": "Operation successful"
}

Rate Limits​

  • 100 requests per minute per API key
  • 1000 requests per hour per API key

How to Use​

1. Authentication Guide​

Learn how to set up your API credentials and authenticate with the K2 Telecom USSD API.

Read the Authentication Guide →

2. Error Handling​

Understand how to handle errors properly and implement robust error management in your applications.

Check Error Handling →

Support​

For technical support or questions about the API, please contact:

Next Steps​