Which method should I use?
The happy path
Every charge method follows the same five beats.1
Pick the method
Choose the charge method that matches the checkout experience you want.
2
Initiate the charge
Call the endpoint with a unique
externalReference. You get back a transactionId.3
Show the customer their next action
A temporary account, an STK prompt, or a redirect URL — depending on the method.
4
Wait for the outcome
Listen for webhooks, or poll
Get Transaction.
5
Provide value
Only once the final transaction status is
successful.Mid-charge steps
Charges do not always complete in one call. When a transaction needs the customer to do something else, the response or webhook carries astepRequired field.
After any of these, the transaction keeps processing in the background. Wait for the final
successful or failed webhook.
Refunds
A previously successful mobile money deposit can be refunded through Refund Deposit. This is useful for customer refunds and for correcting erroneous charges.Refunds are available for mobile money transactions only.
Before you build
Supported countries & limits
Check the corridors you need are live, and what the per-transaction limits are.
Mobile money operators
Operator codes by country — required for every currency except
KES.