Skip to main content
POST
/
payment
/
mpesa-stk-push
Start M-Pesa STK Push
curl --request POST \
  --url https://sandbox.kulmipay.com/api/v1/payment/mpesa-stk-push \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "phone_number": "<string>",
  "api_ref": "<string>",
  "wallet_id": "<string>"
}
'
{
  "invoice": {
    "value": "<string>",
    "invoice_id": "<string>",
    "charges": "<string>",
    "net_amount": "<string>",
    "currency": "<string>",
    "account": "<string>",
    "api_ref": "<string>",
    "clearing_status": "<string>",
    "mpesa_reference": "<string>",
    "host": "<string>",
    "retry_count": -1,
    "failed_reason": "<string>",
    "failed_code": "<string>",
    "failed_code_link": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "customer": {
    "customer_id": "<string>",
    "phone_number": "<string>",
    "email": "jsmith@example.com",
    "first_name": "<string>",
    "last_name": "<string>",
    "country": "<string>",
    "zipcode": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "payment_link": {
    "title": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_active": true,
    "redirect_url": "<string>",
    "amount": 0,
    "usage_limit": 0,
    "qrcode_file": "<string>",
    "url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_comment": "<string>",
  "refundable": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://developers.kulmipay.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
default:ISSecretKey_test_xxxxxxxxxxxxxxxx
required

Use your KulmiPay secret key as the Bearer token.

Body

application/json
​
amount
string<decimal>
required
​
phone_number
string
required
Minimum string length: 1
​
api_ref
string | null
​
wallet_id
string | null

Response

200 - application/json
​
invoice
object
required
​
customer
object
required
​
payment_link
object
required
​
id
string<uuid>
​
customer_comment
string | null
Pattern: ^[a-zA-Z0-9-_ ]+$
​
refundable
string
read-only
​
created_at
string<date-time> | null
read-only
​
updated_at
string<date-time> | null
read-only