{"id":"6396efd5-de10-4b04-adec-128f54349614","name":"MpesaExpressAPIService","description":"The service lets you trigger the Mpesa STK Push","context":"/mm/api/request/1.0.0","version":"1.0.0","provider":"super_admin","apiDefinition":"{\n  \"openapi\" : \"3.0.0\",\n  \"info\" : {\n    \"title\" : \"MpesaExpressAPIService\",\n    \"description\" : \"Mpesa Express Checkout API\",\n    \"version\" : \"1.0.0\"\n  },\n  \"servers\" : [ {\n    \"url\" : \"https://virtserver.swaggerhub.com/\",\n    \"description\" : \"SwaggerHub API Auto Mocking\"\n  } ],\n  \"security\" : [ {\n    \"default\" : [ ]\n  } ],\n  \"paths\" : {\n    \"/stkpush\" : {\n      \"post\" : {\n        \"tags\" : [ \"Express Checkout Request\" ],\n        \"parameters\" : [ {\n          \"name\" : \"Access-Control-Allow-Origin\",\n          \"in\" : \"header\",\n          \"required\" : false,\n          \"style\" : \"simple\",\n          \"explode\" : false,\n          \"schema\" : {\n            \"maxLength\" : 1,\n            \"type\" : \"string\",\n            \"example\" : \"*\"\n          },\n          \"x-internal\" : true,\n          \"x-hidden\" : true\n        }, {\n          \"name\" : \"routeCode\",\n          \"in\" : \"header\",\n          \"required\" : true,\n          \"style\" : \"simple\",\n          \"explode\" : false,\n          \"schema\" : {\n            \"maxLength\" : 64,\n            \"type\" : \"string\",\n            \"description\" : \"Provider System Code eg MPESA\",\n            \"example\" : \"207\"\n          }\n        }, {\n          \"name\" : \"operation\",\n          \"in\" : \"header\",\n          \"required\" : true,\n          \"style\" : \"simple\",\n          \"explode\" : false,\n          \"schema\" : {\n            \"maxLength\" : 64,\n            \"type\" : \"string\",\n            \"example\" : \"STKPush\"\n          }\n        }, {\n          \"name\" : \"messageId\",\n          \"in\" : \"header\",\n          \"required\" : true,\n          \"style\" : \"simple\",\n          \"explode\" : false,\n          \"schema\" : {\n            \"maxLength\" : 32,\n            \"type\" : \"string\",\n            \"description\" : \"This is the unique alphanumeric request ID from your system\",\n            \"example\" : \"232323_KCBOrg_8875661561\"\n          }\n        } ],\n        \"requestBody\" : {\n          \"description\" : \"Express Checkout Request Body\",\n          \"content\" : {\n            \"application/json\" : {\n              \"schema\" : {\n                \"$ref\" : \"#/components/schemas/STKPushRequest\"\n              }\n            }\n          },\n          \"required\" : true\n        },\n        \"responses\" : {\n          \"200\" : {\n            \"description\" : \"OK\",\n            \"content\" : {\n              \"application/json\" : {\n                \"schema\" : {\n                  \"$ref\" : \"#/components/schemas/STKPushResponse\"\n                }\n              }\n            }\n          }\n        },\n        \"security\" : [ {\n          \"default\" : [ ]\n        } ],\n        \"x-auth-type\" : \"Application & Application User\",\n        \"x-throttling-tier\" : \"Unlimited\",\n        \"x-codegen-request-body-name\" : \"STKPush Request\"\n      }\n    }\n  },\n  \"components\" : {\n    \"schemas\" : {\n      \"STKPushRequest\" : {\n        \"required\" : [ \"amount\", \"callbackUrl\", \"invoiceNumber\", \"orgPassKey\", \"orgShortCode\", \"phoneNumber\", \"sharedShortCode\", \"transactionDescription\" ],\n        \"type\" : \"object\",\n        \"properties\" : {\n          \"phoneNumber\" : {\n            \"maxLength\" : 12,\n            \"type\" : \"string\",\n            \"description\" : \"The phone number sending money. The parameter expected is a Valid Safaricom Mobile Number that is M-PESA registered in the format 2547XXXXXXXX\",\n            \"example\" : \"254722000000\"\n          },\n          \"amount\" : {\n            \"maxLength\" : 18,\n            \"type\" : \"string\",\n            \"description\" : \"Decimal values are not permitted\",\n            \"example\" : \"10\"\n          },\n          \"invoiceNumber\" : {\n            \"maxLength\" : 24,\n            \"type\" : \"string\",\n            \"description\" : \"This is an Alpha-Numeric parameter that is defined by your system as an Identifier of the transaction for CustomerPayBillOnline transaction type.Along with the business name, this value is also displayed to the customer in the STK Pin Prompt message. Maximum of 12 characters.\",\n            \"example\" : \"1234567-INV001\"\n          },\n          \"sharedShortCode\" : {\n            \"type\" : \"boolean\",\n            \"description\" : \"If you set this parameter to true, Paramaters OrgShortCode, OrgPassKey will be replaced with internal values.\",\n            \"example\" : true\n          },\n          \"orgShortCode\" : {\n            \"maxLength\" : 12,\n            \"type\" : \"string\",\n            \"description\" : \"The organization receiving the funds. The parameter expected is a 5 to 6 digit\",\n            \"example\" : \"\"\n          },\n          \"orgPassKey\" : {\n            \"type\" : \"string\",\n            \"description\" : \"This is the password used for encrypting the request sent.\",\n            \"example\" : \"\"\n          },\n          \"callbackUrl\" : {\n            \"type\" : \"string\",\n            \"description\" : \"A CallBack URL is a valid secure URL that is used to receive notifications from M-Pesa API. It is the endpoint to which the results will be sent by M-Pesa API.\",\n            \"example\" : \"https://posthere.io/f613-4b7f-b82b\"\n          },\n          \"transactionDescription\" : {\n            \"maxLength\" : 13,\n            \"type\" : \"string\",\n            \"description\" : \"This is any additional information/comment that can be sent along with the request from your system. Maximum of 13 Characters.\",\n            \"example\" : \"school fee payment\"\n          }\n        }\n      },\n      \"STKPushResponse\" : {\n        \"required\" : [ \"header\", \"response\" ],\n        \"type\" : \"object\",\n        \"properties\" : {\n          \"header\" : {\n            \"type\" : \"object\",\n            \"properties\" : {\n              \"statusCode\" : {\n                \"type\" : \"string\",\n                \"description\" : \"Status Code of the request, 0 - success\",\n                \"example\" : \"1|0\"\n              },\n              \"statusDescription\" : {\n                \"type\" : \"string\",\n                \"description\" : \"Status Code description\",\n                \"example\" : \"Success\"\n              }\n            }\n          },\n          \"response\" : {\n            \"required\" : [ \"CheckoutRequestID\", \"CustomerMessage\", \"MerchantRequestID\", \"ResponseCode\", \"ResponseDescription\" ],\n            \"type\" : \"object;\",\n            \"properties\" : {\n              \"MerchantRequestID\" : {\n                \"type\" : \"string\",\n                \"description\" : \"This is a global unique Identifier for any submitted payment request.\",\n                \"example\" : \"16813-1590513-1\"\n              },\n              \"CheckoutRequestID\" : {\n                \"type\" : \"string\",\n                \"description\" : \"This is a global unique identifier of the processed checkout transaction request.\",\n                \"example\" : \"ws_CO_271020211535314658\"\n              },\n              \"CustomerMessage\" : {\n                \"type\" : \"string\",\n                \"description\" : \"This is a message that your system can display to the Customer as an acknowledgement of the payment request submission.\",\n                \"example\" : \"Success. Request accepted for processing\"\n              },\n              \"ResponseCode\" : {\n                \"type\" : \"integer\",\n                \"description\" : \"This is a Numeric status code that indicates the status of the transaction submission. 0 means successful submission and any other code means an error occurred.\",\n                \"example\" : 0\n              },\n              \"ResponseDescription\" : {\n                \"type\" : \"string\",\n                \"description\" : \"Response description is an acknowledgment message from the API that gives the status of the request submission usually maps to a specific ResponseCode value. It can be a Success submission message or an error description\",\n                \"example\" : \"Accept the service request successfully.\"\n              }\n            }\n          }\n        }\n      }\n    },\n    \"securitySchemes\" : {\n      \"default\" : {\n        \"type\" : \"oauth2\",\n        \"flows\" : {\n          \"implicit\" : {\n            \"authorizationUrl\" : \"https://test.com\",\n            \"scopes\" : { }\n          }\n        }\n      }\n    }\n  }\n}","wsdlUri":null,"lifeCycleStatus":"PUBLISHED","isDefaultVersion":false,"type":"HTTP","transport":["http","https"],"operations":[],"authorizationHeader":"Authorization","securityScheme":["basic_auth","api_key","oauth_basic_auth_api_key_mandatory","oauth2"],"tags":["Mpesa"],"tiers":[{"tierName":"Unlimited","tierPlan":"FREE","monetizationAttributes":null}],"hasThumbnail":false,"additionalProperties":[],"monetization":{"enabled":false},"endpointURLs":[{"environmentName":"UAT","environmentDisplayName":"UAT","environmentType":"hybrid","URLs":{"http":"http://uat.buni.kcbgroup.com:-1/mm/api/request/1.0.0","https":"https://uat.buni.kcbgroup.com/mm/api/request/1.0.0","ws":null,"wss":null},"defaultVersionURLs":{"http":null,"https":null,"ws":null,"wss":null}}],"businessInformation":{"businessOwner":"Buni","businessOwnerEmail":"buni@kcbgroup.com","technicalOwner":null,"technicalOwnerEmail":null},"environmentList":[],"scopes":[],"avgRating":"4.137931","advertiseInfo":{"advertised":false,"apiExternalProductionEndpoint":null,"apiExternalSandboxEndpoint":null,"originalDevPortalUrl":null,"apiOwner":null,"vendor":"WSO2"},"isSubscriptionAvailable":true,"categories":["Move_Money"],"keyManagers":["all"],"createdTime":"2025-04-29 11:17:07.621","lastUpdatedTime":null,"gatewayVendor":"wso2","asyncTransportProtocols":[]}