Welcome to the MPESA for Appgini Plugin. This plugin will enable you easily integrate MPESA into your Appgini application. It has easy to use and well documented APIs, to use across your hosted application.
\nNB: This is a third party plugin not provided by or endorsed by BigProf Software.
\nAfter purchasing the plugin you will have to extract it inside the plugins folder of your Appgini application, you must have at least one official plugin from Appgini installed for you to have the plugins folder .
\nAfter extracting the plugin, inside the mobilemoney folder, find a folder named credentials in this folder you will find two JSON files named b2c.json and c2b.json
\nIn the above named files you will find JSON fields to provide the required MPESA API credentials for each file. Your credentials are safe and can not be directly accessed from the browser.
\nIn each of the files you will find a field called callback_secret
\nYou will have to provide a unique secret of your choice that will be used when initiating your APIs as shown in the documantations.
\nFor all endpoint URLS provided here, you will have to replace http://localhost/nwapp/ With your actual application URL path.
\nIncase of any challanges Reach out to me via +254708344101 or ronniengoda@gmail.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8153370","collectionId":"9a42ecaf-c8a9-4097-a520-901ddb3063c8","publishedId":"2s8YszQqfv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-11-30T13:09:37.000Z"},"item":[{"name":"C2B: Register URLs","id":"344e46c1-d6c5-4dc1-a3b5-8e29a9058660","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost/nwapp/plugins/mobilemoney/c2b.php?action=register&callback_secret=Your Callback Secret","description":"Use this API to register your C2B URLs, simply hit your endpoint URL and provide the action parameter and the callback_secret.
\nThe required URLS are saved in credentials/c2b.json
\nYou will have to provide correct URLS.
\nBelow is a guide for the c2b URLs:
\nThis you will have it pointed to : {yourapplicationURL}/plugins/mobilemoney/c2b.php?action=validate
\nReplace: {yourapplicationURL} with your actual application path URL
\n2. confirmation_url
\nThis you will have it pointed to : {yourapplicationURL}/plugins/mobilemoney/c2b.php?action=confirm
\nReplace: {yourapplicationURL} with your actual application path URL
\n3. callback_url
\nThis you will have it pointed to : {yourapplicationURL}/plugins/mobilemoney/c2bcallback.php
\nReplace: {yourapplicationURL} with your actual application path URL
\n4. timeout_url
\nThis you will have it pointed to : {yourapplicationURL}/plugins/mobilemoney/c2b.php?action=timeout
\nReplace: {yourapplicationURL} with your actual application path URL
\n5. results_url
\nThis you will have it pointed to : {yourapplicationURL}/plugins/mobilemoney/c2bcallback.php
\nReplace: {yourapplicationURL} with your actual application path URL
\n","urlObject":{"path":["mobilemoney","c2b.php"],"host":["http://localhost/nwapp/plugins"],"query":[{"key":"action","value":"register"},{"key":"callback_secret","value":"Your Callback Secret"}],"variable":[]}},"response":[],"_postman_id":"344e46c1-d6c5-4dc1-a3b5-8e29a9058660"},{"name":"C2B: Send STK Push Request","id":"648f2e35-7eb8-4344-98bb-30af1243cbdc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost/nwapp/plugins/mobilemoney/c2b.php?action=push&callback_secret=Your callback secret&phone=0700000000&amount=10&reference=123456","description":"Use this API to initiate MPESA STK push request to a customer registered phone number.
\nSimply provide:
\n","urlObject":{"path":["mobilemoney","c2b.php"],"host":["http://localhost/nwapp/plugins"],"query":[{"key":"action","value":"push"},{"key":"callback_secret","value":"Your callback secret"},{"key":"phone","value":"0700000000"},{"key":"amount","value":"10"},{"key":"reference","value":"123456"}],"variable":[]}},"response":[],"_postman_id":"648f2e35-7eb8-4344-98bb-30af1243cbdc"},{"name":"C2B: Simulation Request","id":"11fa2b00-b3ca-467a-8581-f36c1f1e701b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost/nwapp/plugins/mobilemoney/c2b.php?action=simulate&callback_secret=your callback secret&phone=0700000000&amount=10&reference=1738","description":"Use this API to simulate a C2B request. Simply hit the endpoint and provide the following parameters.
\n","urlObject":{"path":["mobilemoney","c2b.php"],"host":["http://localhost/nwapp/plugins"],"query":[{"key":"action","value":"simulate"},{"key":"callback_secret","value":"your callback secret"},{"key":"phone","value":"0700000000"},{"key":"amount","value":"10"},{"key":"reference","value":"1738"}],"variable":[]}},"response":[],"_postman_id":"11fa2b00-b3ca-467a-8581-f36c1f1e701b"},{"name":"B2C: Send Money","id":"f95ece76-a6a3-45e0-b1c4-8c3e4aeaa0f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost/nwapp/plugins/mobilemoney/b2c.php?action=send&callback_secret=your callback secret&phone=0700000000&amount=200","description":"Use this API to initiate a b2c request. B2C enables an organization to send money to a registered customer.
\nSimply hit the endpoint and provide the following parameters.
\nNB: In the credentials folder inside the b2c.json file you can provide {yourApplicationURL}/plugins/mobilemoney/b2ccallback.php as the value for:
\nconfirmation_url parameter replace {yourApplicationURL} with your actual application URL path.
\nEndFragment
\n","urlObject":{"path":["mobilemoney","b2c.php"],"host":["http://localhost/nwapp/plugins"],"query":[{"key":"action","value":"send"},{"key":"callback_secret","value":"your callback secret"},{"key":"phone","value":"0700000000"},{"key":"amount","value":"200"}],"variable":[]}},"response":[],"_postman_id":"f95ece76-a6a3-45e0-b1c4-8c3e4aeaa0f5"},{"name":"B2C: Balance Inquiry","id":"0f7f5f55-887c-421b-9ad7-0478f17a9c79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost/nwapp/plugins/mobilemoney/b2c.php?action=balance&callback_secret=your callback secret","description":"Use this API if you want to query your organization B2C account balances.
\nSimply hit the endpoint and provide the following parameters:
\nThis will trigger a request and you will receive a response in your b2c provided confirmation URL.
\n","urlObject":{"path":["mobilemoney","b2c.php"],"host":["http://localhost/nwapp/plugins"],"query":[{"key":"action","value":"balance"},{"key":"callback_secret","value":"your callback secret"}],"variable":[]}},"response":[],"_postman_id":"0f7f5f55-887c-421b-9ad7-0478f17a9c79"},{"name":"B2C: Transaction Status","id":"97ab0ca6-8769-4f0a-bb66-0a421ef782a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost/nwapp/plugins/mobilemoney/b2c.php?action=status&callback_secret=your callback secret&TransactionID=QKU9YK8WBJ","description":"Use this API to query the status of a transaction.
\nSimply hit the endpoint and provide the following parameters.
\n","urlObject":{"path":["mobilemoney","b2c.php"],"host":["http://localhost/nwapp/plugins"],"query":[{"key":"action","value":"status"},{"key":"callback_secret","value":"your callback secret"},{"key":"TransactionID","value":"QKU9YK8WBJ"}],"variable":[]}},"response":[],"_postman_id":"97ab0ca6-8769-4f0a-bb66-0a421ef782a2"}],"event":[{"listen":"prerequest","script":{"id":"734a6a3d-047d-410f-82d1-a973851e797f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"645342b7-c434-4a45-bf8a-324fa11df5ef","type":"text/javascript","exec":[""]}}],"variable":[{"key":"base_url","value":"http://localhost/nwapp/","type":"string"}]}