SMS API Reference

Send transactional and promotional SMS messages globally through the CashPay sovereign network.

API Version

Introduction

The CashPay SMS API allows developers to programmatically send messages for notifications, One-Time Passwords (OTPs), and marketing alerts. Our network ensures high delivery rates by connecting directly to major operators.

Costs are debited in real-time from your partner fleet account balance. We recommend maintaining a sufficient balance to avoid delivery interruptions.

Authentication

All API requests must include your API Key in the Authorization header. This identifies your partner account and authorizes the debit.

Header Format

cURL

Authorization: Bearer <YOUR_API_KEY>

Detailed SMS Rates (USD)

Below are the current rates per SMS for the Democratic Republic of Congo and Kenya.

Democratic Republic of Congo (DRC)

MCC	MNC	Operator	Rate
630	*	All Operators	$0.0360
630	1	Vodacom Congo	$0.0360
630	2	Airtel Congo	$0.0360
630	3	Orange RDC	$0.0360
630	5	Africell RDC	$0.0360

Kenya

MCC	MNC	Operator	Rate
639	*	All Operators	$0.0300
639	0	Landline/Fixed	$0.0300
639	2	Safaricom PLC	$0.0300
639	3	Airtel Networks Kenya Ltd	$0.0300
639	4	Mobile Pay Ltd	$0.0300
639	6	Finserve Africa Ltd	$0.0300
639	7	Telkom Kenya Ltd	$0.0300
639	8	Webtribe Ltd	$0.0300
639	9	Homelands Media Ltd	$0.0300
639	10	Jamii Telecoms Ltd	$0.0300
639	11	Jambo Telcoms Ltd	$0.0300
639	12	Infura Ltd	$0.0300
639	13	Hidiga Investments Ltd	$0.0300

Bulk Pricing (per 1,000 SMS)

DR Congo Pack

$36.00 / 1,000 SMS

Vodacom, Orange, Airtel, Africell

Kenya Pack

$30.00 / 1,000 SMS

Safaricom, Airtel, Telkom, Jamii & more

API Integration

POST/api/v1/b2b/sms/send

Sends a single SMS message. Requires your API key in the header.

Node.js using Fetch

JavaScript

const apiKey = 'YOUR_API_KEY';
const url = 'https://api.cashpay-all.com/api/v1/b2b/sms/send';

const data = {
  to: "+243812345678",
  message: "Your CashPay verification code is 123456",
  senderId: "CashPay"
};

fetch(url, {
    method: 'POST',
    headers: {
        'Authorization': `Bearer ${apiKey}`,
        'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)
})
.then(res => res.json())
.then(result => console.log(result))
.catch(err => console.error(err));

Quick Browser Testing

For debugging, you can also use a simple GET request directly in your browser. This is useful for verifying that your API key is active.

URL Pattern

https://api.cashpay-all.com/api/v1/b2b/sms/send?apiKey=YOUR_KEY&to=PHONE&message=TEXT&senderId=NAME

Response Models

Success (200 OK)

JSON

{
  "success": true,
  "messageId": "msg_9988776655",
  "status": "SENT",
  "cost": 0.036,
  "currency": "USD"
}

Error (401/400)

JSON

{
  "success": false,
  "error": "Insufficient balance",
  "code": "ERR_BALANCE_LOW"
}

Ready to start?

Get your API keys from your developer dashboard and ensure your fleet account is funded to start sending messages.

Get My API Keys