M-PESA STK Push
POST /api/payments/stk-push
Collect funds from a phone number
Header Parameters
- api-key string required
- api-secret string required
- application/json
Request Body required
- balanceId int64 required
Balance Id being collected into
- amount double required
Amount being collected
- phoneNumber string required
Phone number collecting from
- reference string required
Your reference for the transaction
Responses
- 200
- 401
STK Push was sucessful
- */*
- Schema
- Example (from schema)
Schema
- paymentId uuid required
Unique identifier for the payment
- success boolean required
Was the payment successful?
- detail string required
Details of the payment
- reference string required
Reference provided for the payment
{
"paymentId": "f9eb1b23-4f78-495c-968c-9dfdfc89a16d",
"success": true,
"detail": "Payment processed successfully",
"reference": "TESTREF1"
}
API keys not valid
- */*
- Schema
- Example (from schema)
Schema
- detail string
Detail of the message.
- status string
Possible values: [
SUCCESS,FAILED,API_KEYS_INVALID,INSUFFICIENT_FUNDS,NOT_FOUND,MALFORMED_URL,INTERNAL_ERROR,NOT_SUPPORTED,CURRENCY_NOT_SUPPORTED,MOBILE_MONEY_NOT_WHOLE_NUMBER,BALANCE_NOT_FOUND,BALANCE_NOT_AUTHORISED,BALANCE_NOT_NUMERIC,WEB_HOOK_NOT_SPECIFIED_FOR_OTP]
{
"detail": "API key not valid or Insufficient funds",
"status": "SUCCESS"
}
Loading...