Actions12
- Account Actions
- B2B Actions
- B2C Actions
- C2B Actions
- Identity Actions
- Pull API Actions
- STK Push Actions
Account → Balance
AI-generatedSummary
Query the M-Pesa account balance using the given credentials and account details.
Inputs
- Initiator Name (required) — The username of the API operator as set on the M-Pesa portal.
- Sender Shortcode (Party A) (required) — Your organization shortcode initiating the transaction.
- Remarks (required) — Comments sent along with the transaction.
- Queue Timeout URL (required) — URL to receive notification if the request times out.
- Result URL (required) — URL to receive the transaction result callback.
- Identifier Type (required) — Type of identifier for the account; options are Shortcode (Paybill or Business shortcode), Phone Number (MSISDN), or Till Number.
Output shape
a single JSON response object per input item
Returns the API response from the M-Pesa account balance query endpoint asynchronously via the specified callback URLs. Multiple input items are accepted, and errors can be optionally handled per item.
Examples
Example 1: Check account balance for given account details
Set required fields: Initiator Name, Sender Shortcode (Party A), Identifier Type, Remarks, queue timeout URL, and result URL.