Skip to navigation
Sare Core APIWallet

Deposit Via M-Pesa (STK Push)

View as Markdown

Amount must be a whole KES value (no fractional cents). Triggers an STK push to phoneNumber.

Path parameters

walletIdstringRequired

Headers

AuthorizationstringOptional
X-Device-IdstringOptional

Required on non-GET requests to non-public paths (DeviceSignatureFilter), skipped for GET/whitelisted/multipart requests and in the local profile.

X-SignaturestringOptional

Base64 ECDSA signature over sha256(body) + timestamp + requestId, signed with the device's registered private key.

X-TimestampstringOptional

Unix epoch seconds; must be within 5 minutes of server time.

X-Request-IdstringOptional

Unique per request - reused values are rejected as replays.

Idempotency-KeystringOptional

Request

This endpoint expects an object.
amountintegerOptional
mobileMoneyProviderstringOptional
phoneNumberstringOptionalformat: "utc-millisec"

Response

200 OK
codeintegerOptional
messagestringOptional
dataobjectOptional