Initiate Payment

{
  "amount": 50.00,
  "currency": "USD",
  "payment_method": "mobile_money",
  "provider": "mpesa",
  "phone_number": "+255614853618"
}

{
  "success": true,
  "transaction": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "order_id": "ORD-1234567890",
    "amount": 50.00,
    "currency": "USD",
    "status": "pending",
    "payment_url": "https://payment.gateway.com/pay/xyz123",
    "expires_at": "2025-11-27T11:00:00Z"
  }
}

POST

api

billing

payments

initiate

{
  "amount": 50.00,
  "currency": "USD",
  "payment_method": "mobile_money",
  "provider": "mpesa",
  "phone_number": "+255614853618"
}

{
  "success": true,
  "transaction": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "order_id": "ORD-1234567890",
    "amount": 50.00,
    "currency": "USD",
    "status": "pending",
    "payment_url": "https://payment.gateway.com/pay/xyz123",
    "expires_at": "2025-11-27T11:00:00Z"
  }
}

Initiate a payment transaction.

number

required

Payment amount

string

required

Currency code (e.g., USD)

string

required

Payment method (mobile_money, card)

string

Payment provider (mpesa, tigopesa, etc.)

string

Phone number for mobile money payments

Requires authentication. Include the access token in the Authorization header.

Request Example

{
  "amount": 50.00,
  "currency": "USD",
  "payment_method": "mobile_money",
  "provider": "mpesa",
  "phone_number": "+255614853618"
}

Success Response (201)

boolean

Operation success status

object

Transaction object

string

Transaction ID

string

Order ID

float

Transaction amount

string

Currency code

string

Transaction status

string

Payment URL for redirect

string

Expiration timestamp (ISO 8601)

{
  "success": true,
  "transaction": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "order_id": "ORD-1234567890",
    "amount": 50.00,
    "currency": "USD",
    "status": "pending",
    "payment_url": "https://payment.gateway.com/pay/xyz123",
    "expires_at": "2025-11-27T11:00:00Z"
  }
}

Getting Started

Authentication

User Management

SMS Operations

Contact Management

Campaign Management

Template Management

Billing & Payments

Tenant Management

Notifications

Sender ID Management

Dashboard & Analytics

Error Handling

Request Example

Success Response (201)

​Request Example

​Success Response (201)

Request Example

Success Response (201)