This document provides an overview of Integration between Content Providers (Partners) and HML Aggregator System . The Partner can set up and manage products while the Aggregator manages subscriptions and sends notifications to Partner via configured webhooks.
\nHost URL for MTN: http://91.109.117.92:8001/api/v1
\nHost URL for Airtel and Ninemobile: http://78.110.161.243:8001/api/v1
\nUpon creating an account an a live API key and a sandbox API Key will be assigned to you. The live API key will be used for live transactions while the sandbox API key will be used for test transactions to get acquainted with the API.
\nAuthenticate your API calls by including your API key in the Authorization header of every request you make.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"}],"owner":"14135488","collectionId":"5f192590-c471-45ac-a17f-c15e97e978a0","publishedId":"UVysywKd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-04-04T12:42:25.000Z"},"item":[{"name":"Partner APIs","item":[{"name":"Products","item":[{"name":"list","id":"42361db1-1128-4560-a5ac-42b515839f30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/product/","description":"Get a list of all the products configured on the system.
\nRequest: {{host}}/product/
\nSample response:
\n{
\"status\": true,
\"status_code\": 0,
\"message\": \"List of products\",
\"data\": [
{
\"id\": 1,
\"user_id\": 1,
\"name\": \"USSD and SMS Story\",
\"identity\": \"PD-16460855111000\",
\"webhook\": \"http://www.partner.com/webhook\",
\"test_webhook\": \"http://www.partner.com/test-webhook\",
\"webhook_key\": null,
\"type\": \"WEBHOOK\",
\"amount\": 0,
\"subscription_type\": null,
\"status\": \"DRAFT\",
\"created_at\": \"2022-02-28T21:58:31.000000Z\",
\"updated_at\": \"2022-02-28T23:33:14.000000Z\"
},
{
\"id\": 2,
\"user_id\": 1,
\"name\": \"SMS Jokes\",
\"identity\": \"PD-16460856371000\",
\"webhook\": null,
\"test_webhook\": null,
\"webhook_key\": null,
\"type\": \"WEBHOOK\",
\"amount\": 56,
\"subscription_type\": null,
\"status\": \"DRAFT\",
\"created_at\": \"2022-02-28T22:00:37.000000Z\",
\"updated_at\": \"2022-02-28T22:55:30.000000Z\"
},
]
}
View full details of a product.
Request: {{host}}/product/:product_id
Sample response:
{
\"status\": true,
\"status_code\": 0,
\"message\": \"Successful\",
\"data\": {
\"id\": 1,
\"user_id\": 1,
\"name\": \"USSD and SMS Story\",
\"identity\": \"PD-16460855111000\",
\"webhook\": \"http://www.partner.com/webhook\",
\"test_webhook\": \"http://www.partner.com/test-webhook\",
\"webhook_key\": null,
\"type\": \"SUBSCRIPTION\",
\"amount\": 2000,
\"subscription_type\": \"ONETIME_AND_RECURRING\",
\"status\": \"LIVE\",
\"created_at\": \"2022-02-28T21:58:31.000000Z\",
\"updated_at\": \"2022-03-01T02:05:39.000000Z\",
\"mtn_config\": {
\"id\": 1,
\"product_id\": 1,
\"subscription_provider_id\": \"CSM\",
\"subscription_id\": \"1356\",
\"node_id\": \"Comviva\",
\"subscription_name\": \"Comvi_TestN_1356\",
\"subscription_description\": \"P_Comvi_TestN_1003\",
\"subscription_amount\": \"2000\",
\"status\": \"LIVE\",
\"created_at\": \"2022-03-01T13:39:23.000000Z\",
\"updated_at\": \"2022-03-01T13:39:42.000000Z\"
},
\"shortcode\": [
{
\"id\": 65,
\"product_id\": 129,
\"telco\": \"MTN\",
\"type\": \"SMS\",
\"shortcode\": \"7117\",
\"keyword\": null,
\"shortcode_subscription_id\": null,
\"details\": null,
\"created_at\": \"2022-06-08T21:47:09.000000Z\",
\"updated_at\": \"2022-06-08T21:47:09.000000Z\",
\"optin_keyword\": \"_7117#\",
\"optout_keyword\": \"on demand\"
}
],
\"ussd_shortcode\": [
{
\"id\": 1,
\"product_id\": 129,
\"telco\": \"MTN\",
\"shortcode\": \"_7117#\",
\"menu_hosted_by\": \"EXTERNAL\",
\"menu_url\": \"https://hordecall.net/DPR/index.php\",
\"details\": null,
\"created_at\": \"2022-06-10T11:04:59.000000Z\",
\"updated_at\": \"2022-06-10T15:58:08.000000Z\"
}
]
}
}
Update the webhook for the product
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This collection contain all the apis necessary to create and manage products.
\n","event":[{"listen":"prerequest","script":{"id":"aa0246a0-7bda-438a-98fc-e8628929e35b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d0764e13-b23a-4a23-840c-6dc7bee4da3d","type":"text/javascript","exec":[""]}}],"_postman_id":"226696cd-f822-4299-9c64-61196bbeb4dd","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The data object in the response is for diagnoses only and it is subject to change for different request
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This collection contains api for sending Mobile Terminating (MT) sms or USSD flash messages to subscribers
\n","_postman_id":"cfd8ebb2-12ec-4d46-90d7-f976ac9c4a4c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"If product is draft, no actual subscription will be made. Error response with status code 80 will be returned.
\nIf product is test, a sample success response will be returned. But no actual subscription will be made
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"If product is draft, no actual subscription will be made. Error response with status code 80 will be returned.
\nIf product is test, a sample success response will be returned. But no actual subscription will be made
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Partners can initiate subscription and unsubscribe a user from a product
\n","_postman_id":"0474c539-567e-4a13-805e-99e8d91fcc16","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get subscription summary within given dates
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get subscription summary within given dates
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"optional. If not provided, all the partner products is queried.
\n","type":"text/plain"},"key":"product_id","value":"2"}],"variable":[]}},"response":[{"id":"ac13eb61-da06-4373-b464-9e47aee6b12a","name":"active-count","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{host}}/partner/report/subscribers/active-count?product_id=2","host":["{{host}}"],"path":["partner","report","subscribers","active-count"],"query":[{"key":"product_id","value":"2","description":"optional. If not provided, all the partner products is queried."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 16 Aug 2023 09:13:36 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"Report\",\n \"data\": {\n \"active_subscribers\": 39152,\n \"product_count\": 1\n }\n}"},{"id":"3e575a47-534f-4d7d-9d46-95cfc52da2e7","name":"active-count","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{host}}/partner/report/subscribers/active-count","host":["{{host}}"],"path":["partner","report","subscribers","active-count"],"query":[{"key":"product_id","value":"2","description":"optional. If not provided, all the partner products is queried.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 16 Aug 2023 09:18:12 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"Report\",\n \"data\": {\n \"active_subscribers\": 39122,\n \"product_count\": 5\n }\n}"}],"_postman_id":"af756ca1-9c28-41a2-a746-4e82ee80409d"},{"name":"active-list","id":"6edd1569-c974-43d8-b23f-a10accc28696","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/partner/report/subscribers/active-list?product_id=2&phone=2349166345251","description":"Get subscription summary within given dates
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Required
\n","type":"text/plain"},"key":"product_id","value":"2"},{"key":"phone","value":"2349166345251"}],"variable":[]}},"response":[{"id":"e5bd219b-f5e6-4ba6-8086-07fa41905e36","name":"active-list","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{host}}/partner/report/subscribers/active-list?product_id=2&phone=2349166345251","host":["{{host}}"],"path":["partner","report","subscribers","active-list"],"query":[{"key":"product_id","value":"2","description":"Required"},{"key":"phone","value":"2349166345251"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 16 Aug 2023 09:20:52 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"Report\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 337128,\n \"product_id\": 2,\n \"phone\": \"0703000000\",\n \"telco\": \"MTN\",\n \"amount\": 10000,\n \"start_at\": \"2023-08-09 09:21\",\n \"end_at\": \"2023-08-16 09:21\",\n \"is_renewal\": 1,\n \"channel\": \"system-renewal\",\n \"auto_renewal\": 1,\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"216906979286359683097\",\n \"notify_successful\": 1,\n \"notification_url\": \"\",\n \"notification_number_of_try\": 0,\n \"notification_last_at\": null,\n \"created_at\": \"2023-08-09T09:21:00.000000Z\",\n \"updated_at\": \"2023-08-09T09:21:00.000000Z\"\n },\n {\n \"id\": 337136,\n \"product_id\": 2,\n \"phone\": \"0703000001\",\n \"telco\": \"MTN\",\n \"amount\": 10000,\n \"start_at\": \"2023-08-09 09:21\",\n \"end_at\": \"2023-08-16 09:21\",\n \"is_renewal\": 1,\n \"channel\": \"system-renewal\",\n \"auto_renewal\": 1,\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"216897480631859975433\",\n \"notify_successful\": 1,\n \"notification_url\": \"\",\n \"notification_number_of_try\": 0,\n \"notification_last_at\": null,\n \"created_at\": \"2023-08-09T09:21:10.000000Z\",\n \"updated_at\": \"2023-08-09T09:21:10.000000Z\"\n },\n {\n \"id\": 337137,\n \"product_id\": 2,\n \"phone\": \"0703000002\",\n \"telco\": \"MTN\",\n \"amount\": 10000,\n \"start_at\": \"2023-08-09 09:21\",\n \"end_at\": \"2023-08-16 09:21\",\n \"is_renewal\": 1,\n \"channel\": \"system-renewal\",\n \"auto_renewal\": 1,\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"216903547795629696899\",\n \"notify_successful\": 1,\n \"notification_url\": \"\",\n \"notification_number_of_try\": 0,\n \"notification_last_at\": null,\n \"created_at\": \"2023-08-09T09:21:10.000000Z\",\n \"updated_at\": \"2023-08-09T09:21:10.000000Z\"\n },\n {\n \"id\": 337138,\n \"product_id\": 2,\n \"phone\": \"0703000003\",\n \"telco\": \"MTN\",\n \"amount\": 10000,\n \"start_at\": \"2023-08-09 09:21\",\n \"end_at\": \"2023-08-16 09:21\",\n \"is_renewal\": 1,\n \"channel\": \"system-renewal\",\n \"auto_renewal\": 1,\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"216903547847410273352\",\n \"notify_successful\": 1,\n \"notification_url\": \"\",\n \"notification_number_of_try\": 0,\n \"notification_last_at\": null,\n \"created_at\": \"2023-08-09T09:21:11.000000Z\",\n \"updated_at\": \"2023-08-09T09:21:11.000000Z\"\n },\n {\n \"id\": 337146,\n \"product_id\": 2,\n \"phone\": \"0703000004\",\n \"telco\": \"MTN\",\n \"amount\": 10000,\n \"start_at\": \"2023-08-09 09:21\",\n \"end_at\": \"2023-08-16 09:21\",\n \"is_renewal\": 1,\n \"channel\": \"system-renewal\",\n \"auto_renewal\": 1,\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"216908747040700475929\",\n \"notify_successful\": 1,\n \"notification_url\": \"\",\n \"notification_number_of_try\": 0,\n \"notification_last_at\": null,\n \"created_at\": \"2023-08-09T09:21:20.000000Z\",\n \"updated_at\": \"2023-08-09T09:21:20.000000Z\"\n },\n {\n \"id\": 337147,\n \"product_id\": 2,\n \"phone\": \"0703000005\",\n \"telco\": \"MTN\",\n \"amount\": 10000,\n \"start_at\": \"2023-08-09 09:21\",\n \"end_at\": \"2023-08-16 09:21\",\n \"is_renewal\": 1,\n \"channel\": \"system-renewal\",\n \"auto_renewal\": 1,\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"216903606846199768369\",\n \"notify_successful\": 1,\n \"notification_url\": \"\",\n \"notification_number_of_try\": 0,\n \"notification_last_at\": null,\n \"created_at\": \"2023-08-09T09:21:22.000000Z\",\n \"updated_at\": \"2023-08-09T09:21:22.000000Z\"\n }\n ],\n \"first_page_url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=1\",\n \"from\": 1,\n \"last_page\": 79,\n \"last_page_url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=79\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=5\",\n \"label\": \"5\",\n \"active\": false\n },\n {\n \"url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=6\",\n \"label\": \"6\",\n \"active\": false\n },\n {\n \"url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=7\",\n \"label\": \"7\",\n \"active\": false\n },\n {\n \"url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=8\",\n \"label\": \"8\",\n \"active\": false\n },\n {\n \"url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=9\",\n \"label\": \"9\",\n \"active\": false\n },\n {\n \"url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=10\",\n \"label\": \"10\",\n \"active\": false\n },\n {\n \"url\": null,\n \"label\": \"...\",\n \"active\": false\n },\n {\n \"url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=78\",\n \"label\": \"78\",\n \"active\": false\n },\n {\n \"url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=79\",\n \"label\": \"79\",\n \"active\": false\n },\n {\n \"url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list?page=2\",\n \"path\": \"https://api.msrvas.com/api/v1/partner/report/subscribers/active-list\",\n \"per_page\": 500,\n \"prev_page_url\": null,\n \"to\": 500,\n \"total\": 39105\n }\n}"}],"_postman_id":"6edd1569-c974-43d8-b23f-a10accc28696"}],"id":"3ef4a755-fafa-4bbe-8e9b-5f7281b1d874","_postman_id":"3ef4a755-fafa-4bbe-8e9b-5f7281b1d874","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get subscription summary within given dates
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YYYY-MM-DD
\n","type":"text/plain"},"key":"from","value":"2022-06-01"},{"key":"to","value":"2022-08-01"}],"variable":[]}},"response":[{"id":"4c0a4a06-b883-4241-974b-98b0b72b14f8","name":"summary-by-dates","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{host}}/partner/report/summary/range?from=2022-06-01&to=2022-08-01","host":["{{host}}"],"path":["partner","report","summary","range"],"query":[{"key":"from","value":"2022-06-01","description":"YYYY-MM-DD"},{"key":"to","value":"2022-08-01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Aug 2023 06:45:19 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips mod_wsgi/4.5.18 Python/3.6 PHP/7.3.33"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"Report\",\n \"data\": {\n \"total_count\": 0,\n \"total_amount\": 0,\n \"unique_subscribers\": 0,\n \"renewal_count\": 0,\n \"renewal_amount\": 0,\n \"unsubscription_count\": 0,\n \"product_count\": 4,\n \"server_code\": \"1\"\n }\n}"}],"_postman_id":"1358d10d-071d-4fc0-96dc-4b8d95aa6fe1"},{"name":"summary-by-type","id":"b06db8f6-11f7-4c5d-b382-fa3b10cbe349","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/partner/report/summary/type/:type","description":"Get summary for a predefined time period.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"yesterday, 7_days, 30_days
\n","type":"text/plain"},"type":"any","value":"30_days","key":"type"}]}},"response":[{"id":"d64e63b7-1e37-4560-a11d-fa1b95769296","name":"summary-by-type","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{host}}/partner/report/summary/type/:type","host":["{{host}}"],"path":["partner","report","summary","type",":type"],"variable":[{"key":"type","value":"30_days","description":"yesterday, 7_days, 30_days"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Aug 2023 06:46:04 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips mod_wsgi/4.5.18 Python/3.6 PHP/7.3.33"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"Report\",\n \"data\": {\n \"total_count\": 3,\n \"total_amount\": \"7000\",\n \"unique_subscribers\": 2,\n \"renewal_count\": \"1\",\n \"renewal_amount\": \"5000\",\n \"unsubscription_count\": 1,\n \"product_count\": 4,\n \"server_code\": \"1\"\n }\n}"},{"id":"29b1c02d-8204-4019-b286-8863db9de60b","name":"summary-by-type - old","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{host}}/partner/report/summary/type/:type","host":["{{host}}"],"path":["partner","report","summary","type",":type"],"variable":[{"key":"type","value":"30_days","description":"yesterday, 7_days, 30_days"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 01 Jun 2023 11:27:26 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips mod_wsgi/4.5.18 Python/3.6 PHP/7.3.33"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"500"},{"key":"X-RateLimit-Remaining","value":"499"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"Report\",\n \"data\": {\n \"total_count\": 179463,\n \"total_amount\": \"888076000\",\n \"product_count\": 8,\n \"server_code\": \"1\"\n }\n}"}],"_postman_id":"b06db8f6-11f7-4c5d-b382-fa3b10cbe349"},{"name":"product-summary-by-date","id":"87ca038f-f51d-4e60-bb3f-55c9a82c4a24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/partner/report/product/summary?from=2023-05-01&to=2023-05-01&product_id=249","description":"Get summary for a given product within a period of time
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YYYY-MM-DD
\n","type":"text/plain"},"key":"from","value":"2023-05-01"},{"key":"to","value":"2023-05-01"},{"key":"product_id","value":"249"}],"variable":[]}},"response":[{"id":"ebd27d6c-22a4-4a8d-81ee-fdc429d52a54","name":"product-summary-by-date","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{host}}/partner/report/product/summary?from=2023-05-01&to=2023-05-01&product_id=162","host":["{{host}}"],"path":["partner","report","product","summary"],"query":[{"key":"from","value":"2023-05-01","description":"YYYY-MM-DD"},{"key":"to","value":"2023-05-01"},{"key":"product_id","value":"162"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Aug 2023 06:46:33 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips mod_wsgi/4.5.18 Python/3.6 PHP/7.3.33"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"Report\",\n \"data\": {\n \"total_count\": 2,\n \"total_amount\": \"2000\",\n \"unique_subscribers\": 2,\n \"renewal_count\": \"2\",\n \"renewal_amount\": \"2000\",\n \"unsubscription_count\": 0,\n \"server_code\": \"1\"\n }\n}"},{"id":"c3f04627-4bd6-4041-aaf7-0f817f8ac5f8","name":"product-summary-by-date - old","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{host}}/partner/report/product/summary?from=2022-06-01&to=2022-08-01&product_id=9","host":["{{host}}"],"path":["partner","report","product","summary"],"query":[{"key":"from","value":"2022-06-01","description":"YYYY-MM-DD"},{"key":"to","value":"2022-08-01"},{"key":"product_id","value":"9"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Mon, 08 Aug 2022 14:33:55 GMT"},{"key":"Date","value":"Mon, 08 Aug 2022 14:33:55 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.5"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"500"},{"key":"X-RateLimit-Remaining","value":"499"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"Report\",\n \"data\": {\n \"total_count\": 3,\n \"total_amount\": \"3000\"\n }\n}"}],"_postman_id":"87ca038f-f51d-4e60-bb3f-55c9a82c4a24"},{"name":"products-summary","id":"96ce78da-9adb-499f-888f-b89cb1a3646b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/partner/report/products/summary?from=2023-06-03&to=2023-07-01","description":"Get summary for all the products within a given period
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YYYY-MM-DD
\n","type":"text/plain"},"key":"from","value":"2023-06-03"},{"description":{"content":"YYYY-MM-DD
\n","type":"text/plain"},"key":"to","value":"2023-07-01"}],"variable":[]}},"response":[{"id":"084a3069-26fc-473d-b427-c5a6bb12f4ca","name":"products-summary","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{host}}/partner/report/products/summary?from=2023-06-03&to=2023-07-01","host":["{{host}}"],"path":["partner","report","products","summary"],"query":[{"key":"from","value":"2023-06-03","description":"YYYY-MM-DD"},{"key":"to","value":"2023-07-01","description":"YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Aug 2023 06:47:33 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips mod_wsgi/4.5.18 Python/3.6 PHP/7.3.33"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"Report\",\n \"data\": {\n \"total_count\": 2,\n \"total_amount\": 2000,\n \"product_count\": 4,\n \"unique_subscribers\": 1,\n \"renewal_count\": 0,\n \"renewal_amount\": 0,\n \"unsubscription_count\": 0,\n \"server_code\": \"1\",\n \"products\": [\n {\n \"product\": {\n \"id\": 249,\n \"name\": \"My Product Daily\"\n },\n \"data\": {\n \"total_count\": 0,\n \"total_amount\": 0,\n \"unique_subscribers\": 0,\n \"renewal_count\": 0,\n \"renewal_amount\": 0,\n \"unsubscription_count\": 0,\n \"server_code\": \"1\"\n }\n },\n {\n \"product\": {\n \"id\": 250,\n \"name\": \"My Product Weekly\"\n },\n \"data\": {\n \"total_count\": 0,\n \"total_amount\": 0,\n \"unique_subscribers\": 0,\n \"renewal_count\": 0,\n \"renewal_amount\": 0,\n \"unsubscription_count\": 0,\n \"server_code\": \"1\"\n }\n },\n {\n \"product\": {\n \"id\": 251,\n \"name\": \"My Product Monthly\"\n },\n \"data\": {\n \"total_count\": 0,\n \"total_amount\": 0,\n \"unique_subscribers\": 0,\n \"renewal_count\": 0,\n \"renewal_amount\": 0,\n \"unsubscription_count\": 0,\n \"server_code\": \"1\"\n }\n },\n {\n \"product\": {\n \"id\": 268,\n \"name\": \"USSD Search\"\n },\n \"data\": {\n \"total_count\": 2,\n \"total_amount\": \"2000\",\n \"unique_subscribers\": 1,\n \"renewal_count\": \"0\",\n \"renewal_amount\": \"0\",\n \"unsubscription_count\": 0,\n \"server_code\": \"1\"\n }\n }\n ]\n }\n}"},{"id":"c87d9d0a-d9c7-45ac-b7c8-aa5784618f4c","name":"products-summary - old","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{host}}/partner/report/products/summary?from=2022-06-01&to=2022-08-01","host":["{{host}}"],"path":["partner","report","products","summary"],"query":[{"key":"from","value":"2022-06-01","description":"YYYY-MM-DD"},{"key":"to","value":"2022-08-01","description":"YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Mon, 08 Aug 2022 14:10:05 GMT"},{"key":"Date","value":"Mon, 08 Aug 2022 14:10:05 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.5"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"500"},{"key":"X-RateLimit-Remaining","value":"498"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"Report\",\n \"data\": {\n \"total_count\": 6,\n \"total_amount\": 7000,\n \"product_count\": 4,\n \"products\": [\n {\n \"product\": {\n \"id\": 1,\n \"name\": \"USSD and SMS Story\"\n },\n \"data\": {\n \"total_count\": 3,\n \"total_amount\": \"4000\"\n }\n },\n {\n \"product\": {\n \"id\": 2,\n \"name\": \"SMS Jokes\"\n },\n \"data\": {\n \"total_count\": 0,\n \"total_amount\": null\n }\n },\n {\n \"product\": {\n \"id\": 9,\n \"name\": \"HML On-demand\"\n },\n \"data\": {\n \"total_count\": 3,\n \"total_amount\": \"3000\"\n }\n },\n {\n \"product\": {\n \"id\": 13,\n \"name\": \"test Ussd Products\"\n },\n \"data\": {\n \"total_count\": 0,\n \"total_amount\": null\n }\n }\n ]\n }\n}"}],"_postman_id":"96ce78da-9adb-499f-888f-b89cb1a3646b"},{"name":"products-subscribers-list","id":"5d4ff26c-4700-49f7-86a8-c0ad0db97729","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/partner/report/products/details?from=2023-06-20&to=2023-07-20&product_id=268","description":"Get the list of all the subscribers of a product
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YYYY-MM-DD
\n","type":"text/plain"},"key":"from","value":"2023-06-20"},{"description":{"content":"YYYY-MM-DD
\n","type":"text/plain"},"key":"to","value":"2023-07-20"},{"key":"product_id","value":"268"}],"variable":[]}},"response":[{"id":"8d2804b1-6a17-4610-ab39-fd562cef1694","name":"products-subscribers-list","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{host}}/partner/report/products/details?from=2023-06-20&to=2023-07-20&product_id=268","host":["{{host}}"],"path":["partner","report","products","details"],"query":[{"key":"from","value":"2023-06-20","description":"YYYY-MM-DD"},{"key":"to","value":"2023-07-20","description":"YYYY-MM-DD"},{"key":"product_id","value":"268"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Aug 2023 06:49:50 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips mod_wsgi/4.5.18 Python/3.6 PHP/7.3.33"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"Report\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 8993737,\n \"product_id\": 268,\n \"phone\": \"2348032008456\",\n \"telco\": \"MTN\",\n \"amount\": 1000,\n \"start_at\": \"2023-06-26 20:24\",\n \"end_at\": null,\n \"cancelled_at\": null,\n \"is_renewal\": 0,\n \"channel\": \"USSD\",\n \"auto_renewal\": 0,\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"126778899000146\",\n \"notify_successful\": 1,\n \"notification_url\": \"\",\n \"notification_number_of_try\": 0,\n \"notification_last_at\": null,\n \"created_at\": \"2023-06-26T20:24:43.000000Z\",\n \"updated_at\": \"2023-06-26T20:24:43.000000Z\"\n },\n {\n \"id\": 8994077,\n \"product_id\": 268,\n \"phone\": \"2348032008456\",\n \"telco\": \"MTN\",\n \"amount\": 1000,\n \"start_at\": \"2023-06-26 22:05\",\n \"end_at\": null,\n \"cancelled_at\": null,\n \"is_renewal\": 0,\n \"channel\": \"SMS\",\n \"auto_renewal\": 0,\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"126778899000144\",\n \"notify_successful\": 1,\n \"notification_url\": \"\",\n \"notification_number_of_try\": 0,\n \"notification_last_at\": null,\n \"created_at\": \"2023-06-26T22:05:00.000000Z\",\n \"updated_at\": \"2023-06-26T22:05:00.000000Z\"\n }\n ],\n \"first_page_url\": \"http://91.109.117.92:8001/api/v1/partner/report/products/details?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"http://91.109.117.92:8001/api/v1/partner/report/products/details?page=1\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://91.109.117.92:8001/api/v1/partner/report/products/details?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": null,\n \"path\": \"http://91.109.117.92:8001/api/v1/partner/report/products/details\",\n \"per_page\": 100,\n \"prev_page_url\": null,\n \"to\": 2,\n \"total\": 2\n }\n}"}],"_postman_id":"5d4ff26c-4700-49f7-86a8-c0ad0db97729"}],"id":"4e64ea99-12f2-4143-80ce-3f73549f441f","description":"This collection defines endpoints to query reports and statistics from the system
\n","_postman_id":"4e64ea99-12f2-4143-80ce-3f73549f441f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint is used to ge the ussd menu during a ussd session.
\nsample request:
\n{ \"telco\": \"AIRTEL\", \"shortcode\": \"*123#\", \"product_id\": 1, \"phone\": \"2347034481876\", \"input\": \"\", \"session_id\": \"1122339999UUJ0011\"}
\nResponse: {\"continue\":true,\"message\":\"Hello, welcome to this service:\\n1. Subscribe\\n2. Check status\\n3. Create Account\"}
\nThe continue parameter must be a boolen. It is used to indicate if an imput is required from the user. If true, a user can pass an input. If false, the ussd session is terminated after displaying the messsage to the user.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Thus notification is sent when the aggregator receives sms on the partner shortcode and the sms message is mapped to one of the partner's keywords. Information about the matching product is included.
\nThe notification type is SMS and the action is:
1. PROCESSED: Aggregator took action such as initiating a subscription or unsubscription
2. NONE: No action is taken by the aggregator.
The details object includes:
\nSample notification:
\n{ \"type\": \"SMS\", \"telco\": \"MTN\", \"action\": \"PROCESSED\", \"shortcode\": \"123123\", \"product\": { \"id\": 1, \"name\": \"USSD and SMS Story\", \"identity\": \"PD-16460855111000\", \"type\": \"SUBSCRIPTION\", \"subscription_type\": \"ONETIME_AND_RECURRING\", \"status\": \"LIVE\" }, \"details\": { \"message\": \"mobid\", \"phone\": \"2347034481876\", \"date\": \"2022-09-03 09:31:06\" }}
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Aggregator will notify the Partners webhook whenever a user successfully subscribes to a product and is charged for the subscription.
\nNew subscription notification comes with \"type\": \"SYNC_NOTIFICATION\".
\nThe difference between on demand and subscription products/purchase is the expiry date. This field is null for on demand.
\nSample of the body of the post notification is:
\n{
\n\"type\": \"SYNC_NOTIFICATION\",
\n\"telco\": \"MTN\",
\n\"action\": \"NONE\",
\n\"shortcode\": null,
\n\"product\": {
\n\"id\": 1,
\n\"name\": \"USSD and SMS Story\",
\n\"identity\": \"PD-16460855111000\",
\n\"type\": \"SUBSCRIPTION\",
\n\"subscription_type\": \"ONETIME_AND_RECURRING\",
\n\"status\": \"LIVE\"
\n},
\n\"details\": {
\n\"phone\": \"2348065477209\",
\n\"amount\": 1000,
\n\"channel\": \"SMS\",
\n\"date\": \"2022-03-30 08:26\",
\n\"expiry\": \"2022-03-31 08:26\",
\n\"auto_renewal\": true,
\n\"telco_status_code\": \"0\",
\n\"telco_ref\": \"12346780567809\"
\n}
\n}
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Aggregator will notify the Partners webhook whenever a user successfully renews his subscription.
\nRenewal notification comes with \"type\": \"RENEWAL_NOTIFICATION\". Other than the type, it has same content as subscription notification.
\nSample of the body of the post notification is:
\n{
\n\"type\": \"RENEWAL_NOTIFICATION\",
\n\"telco\": \"MTN\",
\n\"action\": \"NONE\",
\n\"shortcode\": null,
\n\"product\": {
\n \"id\": 1,\n \"name\": \"USSD and SMS Story\",\n \"identity\": \"PD-16460855111000\",\n \"type\": \"SUBSCRIPTION\",\n \"subscription_type\": \"ONETIME_AND_RECURRING\",\n \"status\": \"LIVE\"\n\n},
\n\"details\": {
\n \"phone\": \"2348065477209\",\n \"amount\": 1000,\n \"channel\": \"SMS\",\n \"date\": \"2022-03-30 08:26\",\n \"expiry\": \"2022-03-31 08:26\",\n \"auto_renewal\": true,\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"12346780567809\"\n\n}
\n}
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Aggregator will notify the Partners webhook whenever a user cancels or unsubscribes from a product.
\nRenewal notification comes with \"type\": \"UNSUBSCRIPTION_NOTIFICATION\". It does not have expiry or auto_renewal fields.
\nSample of the body of the post notification is:
\n{
\n\"type\": \"UNSUBSCRIPTION_NOTIFICATION\",
\n\"telco\": \"MTN\",
\n\"action\": \"PROCESSED\",
\n\"shortcode\": null,
\n\"product\": {
\n \"id\": 1,\n \"name\": \"USSD and SMS Story\",\n \"identity\": \"PD-16460855111000\",\n \"type\": \"SUBSCRIPTION\",\n \"subscription_type\": \"ONETIME_AND_RECURRING\",\n \"status\": \"LIVE\"\n\n},
\n\"details\": {
\n \"phone\": \"2347030000000\",\n \"date\": \"2022-03-09T11:09:37.000000Z\"\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"12346780567809\"\n\n}
\n}
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Aggregator will notify the Partners webhook whenever a user cancels or unsubscribes from a product.
\nRenewal notification comes with \"type\": \"UNSUBSCRIPTION_NOTIFICATION\". It does not have expiry or auto_renewal fields.
\nSample of the body of the post notification is:
\n{
\n\"type\": \"UNSUBSCRIPTION_NOTIFICATION\",
\n\"telco\": \"MTN\",
\n\"action\": \"PROCESSED\",
\n\"shortcode\": null,
\n\"product\": {
\n \"id\": 1,\n \"name\": \"USSD and SMS Story\",\n \"identity\": \"PD-16460855111000\",\n \"type\": \"SUBSCRIPTION\",\n \"subscription_type\": \"ONETIME_AND_RECURRING\",\n \"status\": \"LIVE\"\n\n},
\n\"details\": {
\n \"phone\": \"2347030000000\",\n \"date\": \"2022-03-09T11:09:37.000000Z\"\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"12346780567809\"\n\n}
\n}
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Aggregator will notify the Partners webhook whenever a user cancels or unsubscribes from a product.
\nRenewal notification comes with \"type\": \"UNSUBSCRIPTION_NOTIFICATION\". It does not have expiry or auto_renewal fields.
\nSample of the body of the post notification is:
\n{
\n\"type\": \"UNSUBSCRIPTION_NOTIFICATION\",
\n\"telco\": \"MTN\",
\n\"action\": \"PROCESSED\",
\n\"shortcode\": null,
\n\"product\": {
\n \"id\": 1,\n \"name\": \"USSD and SMS Story\",\n \"identity\": \"PD-16460855111000\",\n \"type\": \"SUBSCRIPTION\",\n \"subscription_type\": \"ONETIME_AND_RECURRING\",\n \"status\": \"LIVE\"\n\n},
\n\"details\": {
\n \"phone\": \"2347030000000\",\n \"date\": \"2022-03-09T11:09:37.000000Z\"\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"12346780567809\"\n\n}
\n}
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Aggregator will notify the Partners webhook whenever a user cancels or unsubscribes from a product.
\nRenewal notification comes with \"type\": \"UNSUBSCRIPTION_NOTIFICATION\". It does not have expiry or auto_renewal fields.
\nSample of the body of the post notification is:
\n{
\n\"type\": \"UNSUBSCRIPTION_NOTIFICATION\",
\n\"telco\": \"MTN\",
\n\"action\": \"PROCESSED\",
\n\"shortcode\": null,
\n\"product\": {
\n \"id\": 1,\n \"name\": \"USSD and SMS Story\",\n \"identity\": \"PD-16460855111000\",\n \"type\": \"SUBSCRIPTION\",\n \"subscription_type\": \"ONETIME_AND_RECURRING\",\n \"status\": \"LIVE\"\n\n},
\n\"details\": {
\n \"phone\": \"2347030000000\",\n \"date\": \"2022-03-09T11:09:37.000000Z\"\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"12346780567809\"\n\n}
\n}
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Aggregator will notify the Partners webhook whenever a user cancels or unsubscribes from a product.
\nRenewal notification comes with \"type\": \"UNSUBSCRIPTION_NOTIFICATION\". It does not have expiry or auto_renewal fields.
\nSample of the body of the post notification is:
\n{
\n\"type\": \"UNSUBSCRIPTION_NOTIFICATION\",
\n\"telco\": \"MTN\",
\n\"action\": \"PROCESSED\",
\n\"shortcode\": null,
\n\"product\": {
\n \"id\": 1,\n \"name\": \"USSD and SMS Story\",\n \"identity\": \"PD-16460855111000\",\n \"type\": \"SUBSCRIPTION\",\n \"subscription_type\": \"ONETIME_AND_RECURRING\",\n \"status\": \"LIVE\"\n\n},
\n\"details\": {
\n \"phone\": \"2347030000000\",\n \"date\": \"2022-03-09T11:09:37.000000Z\"\n \"telco_status_code\": \"0\",\n \"telco_ref\": \"12346780567809\"\n\n}
\n}
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Aggregator will notify the Partners webhook whenever there is an event on the Partner product. The events for notifications are:
\nNew Sms received on partner’s shortcode
\nNew Subscription Notification
\nRenewal Subscription Notification
\nCancel Subscription Notification
\nOther syn events
\nThe general structure of the notification request is:
\n{
\n\"type\": \"TYPE\",
\n\"telco\": \"TELCO\",
\n\"shortcode\": \"123412\",
\n\"action\": \"action taken by aggregator\",
\n\"product\": {
\n \"id\": 1,\n \"name\": \"Product name\",\n \"identity\": \"Product Identity\",\n \"type\": \"Product type\",\n \"subscription_type\": \"Product subscription type\",\n \"status\": \"product status\"\n\n},
\n\"details\": {
\n//details associated with the notification
\n}
\n}
\nSamples of notifications sent to partners are fund in the attached examples
\n","_postman_id":"fe5c3590-31d1-479f-9422-2707564226fa","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"On-Demand USSD Menu Service Use Cases
\nIntroduction:
This documentation guides partners through the steps required to implement and use the On-Demand USSD Menu Service.
Steps:
\nStep 1: Configure the Service
\nAccess the admin panel to configure the service.
\nReceive credentials, including the Product ID, from the admin.
\nStep 2: Configure the USSD
\nFlow:
\nUser Dials USSD Shortcode:
\nThe user dials the USSD shortcode.
\nThe request is proccessed by the Telco and forwared to the Aggregator
\nAggregator Receives Request:
\nThe aggregator receives the request from the user and forwards it to the partner via the configured USSD Menu URL.
\nSample of this request can be found under the Partner Notifications Sample collection.
\nPartner Manages Subscription:
\nThe partner checks if the user has an active subscription.
\nIf the user does not have an active subscription, the partner can subscribe the user using the Initiate Subscription ({{host}}/product/subscription/initiate) endpoint found in the Postman documentation under Partner APIs, within the Subscription collection.
After calling the endpoint, the partner waits for sync notifications from the aggregator.
\nSync Notifications:
\nAfter calling the Initiate Subscription endpoint, partners await sync notifications from the aggregator. These notifications can be categorized into three types:
New Subscription Notification:
\nRenewal Notification:
\nOther Notifications:
\nIncludes notifications such as balance insufficiency, internal errors, or load errors and can be identified by their various types.
\nPartners can find sample notifications under the Partner Notifications Sample collection.
\n