Check the Change Log here.
"},{"location":"#introduction","title":"Introduction","text":"Khalti is the new generation Payment Gateway, Digital Wallet and API provider for various services. We provide a dashboard where you will be able to see your available balance, list of services, commissions and real-time status of services consumed. We also provide dlr callback for all the requests, so that your system gets updated with the live status.
We provide REST API for consumption of services. Our single API serves all the services.
"},{"location":"#live-environment","title":"Live Environment","text":"This document describes the API for adding passenger information after booking a bus ticket. The API allows users to provide details such as boarding points and passenger information before proceeding to payment.
"},{"location":"Bus/add-info/#api-endpoint","title":"API Endpoint","text":"Request URL: {{base_url}}/api/servicegroup/addinfo-v2/bus/ Request Method: POST
\n{\n \"token\": \"{{token}}\",\n \"session_id\": \"{{session_id}}\",\n \"bus_id\": \"{{bus_id}}\",\n \"ticket_serial_no\": \"{{ticket_serial_no}}\", // Optional: Do not send if not obtained in Book Bus API\n \"mobile_number\": \"9843223423\",\n \"boarding_point\": \"{{boarding_point}}\",\n \"email\": \"test@okay.com\",\n \"name\": \"TEST\",\n \"seats\": \"[{\\\"seat\\\":\\\"{{seat1}}\\\",\\\"fullName0\\\":\\\"test trest A\\\",\\\"nationality\\\":\\\"nepali\\\",\\\"age0\\\":\\\"25\\\"},{\\\"seat\\\":\\\"{{seat2}}\\\",\\\"fullName0\\\":\\\"test trest A\\\",\\\"nationality\\\":\\\"nepali\\\",\\\"age0\\\":\\\"25\\\"}]\"\n}\n\n{\n \"status\": true,\n \"detail\": \"Now you can proceed to the payment.\",\n \"ticket_serial_no\": \"\"\n}\nThis API allows clients to add passenger information necessary for completing the bus booking process. Ensure all provided parameters are valid for successful processing before proceeding to payment.
"},{"location":"Bus/bus-booking/","title":"Bus Booking API Documentation","text":""},{"location":"Bus/bus-booking/#overview","title":"Overview","text":"This document describes the API for booking a bus ticket. The API allows users to specify their seat preferences and provides details about the booking confirmation.
"},{"location":"Bus/bus-booking/#api-endpoint","title":"API Endpoint","text":"Request URL: {{url}}/api/servicegroup/book-v2/bus/
Request Method: POST
"},{"location":"Bus/bus-booking/#request-parameters","title":"Request Parameters","text":"\n{\n \"token: \"{{live_token}}\",\n \"session_id\": \"{{session_id}}\",\n \"bus_id\": \"{{bus_id}}\",\n \"seats\": \"[\"{{seat1}}\", \"{{seat2}}\"] (array of selected seats)\"\n}\n\n{\n \"status\": true,\n \"detail\": {\n \"boarding_point\": [\n \"Gongabu Bus Park(06:00 AM)\",\n \"Basundhara(06:15 AM)\",\n \"Chabahil(06:30 AM)\",\n \"Gaushala(06:45 AM)\",\n \"Koteshwor(07:00 AM)\",\n \"Jadibutti(07:05 AM)\",\n \"Kasaultar(07:10 AM)\",\n \"Thimi(07:25 AM)\",\n \"Jagati(07:45 AM)\",\n \"Banepa(08:00 AM)\",\n \"Dhulikhel(08:15 AM)\"\n ],\n \"ticket_serial_no\": \"5115799-B\"\n }\n}\nThis API allows clients to book bus tickets by specifying their seat preferences. Ensure all provided parameters are valid for successful booking confirmation.
"},{"location":"Bus/payment/","title":"Commit Bus Booking API Documentation","text":""},{"location":"Bus/payment/#overview","title":"Overview","text":"This document describes the API for committing a bus booking transaction. The API finalizes the booking process and returns transaction details.
"},{"location":"Bus/payment/#api-endpoint","title":"API Endpoint","text":"Request URL: {{base_url}}/api/servicegroup/commit-v2/bus/ Request Method: POST
{{token}}{{session_id}}\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": {\n \"bus_no\": \"\",\n \"message\": \"Booking Successfully Done\",\n \"ticket_serial_number\": \"810610-101576400\",\n \"contact_info\": [\n \"Counter: \",\n \"Contact Number: \"\n ]\n }\n}\nThis API allows clients to finalize their bus booking transaction and provides essential details regarding the booking. Ensure all provided parameters are valid for successful completion.
"},{"location":"Bus/route/","title":"Bus Routes API Documentation","text":""},{"location":"Bus/route/#overview","title":"Overview","text":"This document describes the API for fetching bus routes. The API provides a list of available bus routes and their corresponding labels.
"},{"location":"Bus/route/#api-endpoint","title":"API Endpoint","text":"Request URL: {{base_url}}/api/servicegroup/routes/bus/ Request Method: POST
\n{\n \"token\": \"{{token}}\"\n}\n\n{\n \"status\": true,\n \"routes\": [\n {\n \"label\": \"radhe radhe\",\n \"value\": \"radhe radhe\"\n },\n {\n \"label\": \"Bardibas chock\",\n \"value\": \"Bardibas chock\"\n },\n {\n \"label\": \"Kathmandu Valley\",\n \"value\": \"Kathmandu Valley\"\n },\n {\n \"label\": \"Lumbini\",\n \"value\": \"Lumbini\"\n },\n {\n \"label\": \"Kakadvitta\",\n \"value\": \"Kakadvitta\"\n },\n {\n \"label\": \"Sindhuli\",\n \"value\": \"Sindhuli\"\n },\n {\n \"label\": \"Gaur\",\n \"value\": \"Gaur\"\n },\n {\n \"label\": \"Nepalgunj\",\n \"value\": \"Nepalgunj\"\n },\n {\n \"label\": \"Damauli\",\n \"value\": \"Damauli\"\n },\n {\n \"label\": \"Hile\",\n \"value\": \"Hile\"\n },\n {\n \"label\": \"Khurkot\",\n \"value\": \"Khurkot\"\n },\n {\n \"label\": \"Budhabare\",\n \"value\": \"Budhabare\"\n },\n {\n \"label\": \"Kakarbhitta\",\n \"value\": \"Kakarbhitta\"\n },\n {\n \"label\": \"Surunga\",\n \"value\": \"Surunga\"\n },\n {\n \"label\": \"Biratnagar\",\n \"value\": \"Biratnagar\"\n },\n {\n \"label\": \"Gaushala\",\n \"value\": \"Gaushala\"\n },\n {\n \"label\": \"Besisahar\",\n \"value\": \"Besisahar\"\n },\n {\n \"label\": \"CG Shashwat Dham\",\n \"value\": \"CG Shashwat Dham\"\n },\n {\n \"label\": \"Dhangadhi\",\n \"value\": \"Dhangadhi\"\n },\n {\n \"label\": \"Jaleshwor\",\n \"value\": \"Jaleshwor\"\n }\n ]\n}\nThis API allows clients to retrieve a list of bus routes. Ensure the token is valid for successful responses.
"},{"location":"Bus/search/","title":"Bus Search API Documentation","text":""},{"location":"Bus/search/#overview","title":"Overview","text":"This document describes the API for searching buses between specified locations. The API allows users to find available buses based on their travel preferences.
"},{"location":"Bus/search/#api-endpoint","title":"API Endpoint","text":"Request URL: {{url}}/api/servicegroup/search-v2/bus/ Request Method: GET
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"from\": \"from\",\n \"to\": \"to\",\n \"date\": \"date\"\n}\n\n{\n \"status\": true,\n \"buses\": [\n {\n \"id\": \"gongabu-buspark:12746\",\n \"ticket_price\": 2170,\n \"departure_time\": \"05:30 AM\",\n \"is_tourist_bus\": false,\n \"bus_type\": \"NBus 43(C4 B2 L1)\",\n \"amenities\": [],\n \"date_en\": \"2024-09-26\",\n \"operator\": \"Chandika Yatayat\",\n \"bus_no\": \"C31P1D-HILE\",\n \"commission\": 0\n }\n ],\n \"session_id\": 15005\n}\n\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Buses for this day could not be found\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\nThis API allows clients to search for buses between specified locations. Ensure the provided parameters are correct for successful responses.
"},{"location":"Bus/seat/","title":"Bus Seats Information API Documentation","text":""},{"location":"Bus/seat/#overview","title":"Overview","text":"This document describes the API for retrieving seating information for a specific bus. The API provides details about the seat layout and their booking statuses.
"},{"location":"Bus/seat/#api-endpoint","title":"API Endpoint","text":"Request URL: {{base_url}}/api/servicegroup/seatsinfo/bus/ Request Method: POST
\n \"token\":\"{{token}}\",\n \"bus_id\": \"{{bus_id}}\",\n \"session_id\": \"{{session_id}}\",\n\n{\n \"seat_layout\": [\n {\n \"display_name\": \"C1\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"C2\",\n \"booking_status\": \"Yes\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"C3\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"C4\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B\u0915\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B\u0916\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A1\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A2\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B1\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B2\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A3\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A4\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B3\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B4\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A5\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A6\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B5\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B6\",\n \"booking_status\": \"Yes\"\n },\n {\n \"display_name\": \"A7\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A8\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B7\",\n \"booking_status\": \"Yes\"\n },\n {\n \"display_name\": \"B8\",\n \"booking_status\": \"Yes\"\n },\n {\n \"display_name\": \"A9\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A10\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B9\",\n \"booking_status\": \"Yes\"\n },\n {\n \"display_name\": \"B10\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A11\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A12\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B11\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B12\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A13\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A14\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B13\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B14\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A15\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A16\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B15\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B16\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A17\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A18\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"19\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B17\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B18\",\n \"booking_status\": \"No\"\n }\n ],\n \"no_of_column\": 5,\n \"status\": true\n}\nThese things must be considered while making the seat layout:
no_of_column is 5, then the seat layout must have 5 columns.Note: The value for each seat must be checked from left to right as shown in the table below:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15displayName: bookingStatus:
Response for No Seat
\n {\n \"displayName\": \"na\",\n \"bookingStatus\": \"na\"\n }\n \n {\n \"displayName\": \"A1\",\n \"bookingStatus\": \"Yes\"\n }\n \n {\n \"displayName\": \"A2\",\n \"bookingStatus\": \"No\"\n }\n This is how the seat layout might look based on the above responses:
A1 A2 B1 B2 A3 A4 B3 B4 A5 A6 B5 B6 A7 A8 B7 B8 A9 A10 B9 B10 A11 A12 B11 B12 14 15 16 17 18"},{"location":"Bus/seat/#conclusion","title":"Conclusion","text":"This API allows clients to retrieve seating information for a specified bus. Ensure the provided parameters are valid for successful responses.
"},{"location":"Bus/ticket-download/","title":"Download Ticket API Documentation","text":""},{"location":"Bus/ticket-download/#overview","title":"Overview","text":"This document describes the API for downloading a bus ticket. The API allows users to retrieve a ticket in a specified format using their booking details.
"},{"location":"Bus/ticket-download/#api-endpoint","title":"API Endpoint","text":"Request URL: {{base_url}}/api/servicegroup/downloadticket/bus/ Request Method: POST
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"bus_id\": \"{{bus_id}}\",\n \"session_id\": \"{{session_id}}\"\n}\n\n{\n \"status\": true,\n \"data\": \"JVBERi0xLjUKJbXtrvsKNCAwIG9iago8PCAvTGVuZ3RoIDUgMCBSCiAgIC9GaWx0ZXIgL0ZsYXRl\\nRGVjb2RlCj4+CnN0cmVhbQp4nN1V32/bNhB+119xj9QA0UeKFMUgCFbHKYIM8dpaRR/cPTCOHHuJ\\nrUSWt+a/31E/bNkuhuWlwArDsnnkfXff8e6TAKRPJOiRKgGzVfASfISXIJFcahDacqMkKIPcGAP0\\n1FDm8AXWAdae5QMMHMLDpvNIkCsrYQU6jjlKs7M87S1WcFtbWp/denEUt4fSWvoosrV0KN36FGX+\\nS59UG+6nIiW15orI/HdSUidcUsh9Op1ln45MDTe1pfXZrRdHcfsojaWPkraWDqVbn6IckmrD/VSk\\n4lgRwBs4eYeDZFrDPpc4IY77VHbLxWHIQwSUBwimMXQI7fIE4ZBKE+j/TeU402EWpP5crYv1v3bw\\njOVSoI1TyFbBYB5hhCAgmwdT9j4UKSuLFZzBb65arNz6fhv+kd0EXloFT1CJxEB2H7BhUTzm93D3\\nCmH2p9+2XEuMk3rzslhXblbBKK/c8mnjT1xlvXoTlRg1GN9tVGvVFfslMG2+tV2nwrZJ24Rjgn5N\\nyt4QhME3A6Mi+Pg29pJkRyY6kcfsWbacPeYVeGbL9QMQCZ/4YPLs1nB+DoN3s2rrnrL8WwXn83w+\\nR0wS+toLuLiA4eiyQRMN2jkiigtP/PbyMEy5ctWyxZ5HorN70iTFcWyEr+GUXZa5q6jE70JhWAUS\\npYxQRCKuL6QPKSVPpZapgijmGpWJdQORhUJoVtBtfgilYcXjwpWuc99FZtDmsgOMeoiSa2O1qhHZ\\nKH92ZbWl68qWq/yYAgMUZ4jw4fYEccpuim25zl/hmn6bFP6lsA53RZ1Sev54Xccf49KjNGUaTuo9\\nZZPFcl69hcUh5o9mNGXj5cOiOmWCJEr+46851omOVdM4w+0GfPMge33OwyiRVrDfn/PSVUVzeVKR\\nZ6rQ0njtPMZFGKk0lqwboRE1cG0S1IpGstL9lT811uMmjPaIkSApSWxqG+Sb7equgOulm+Ut/Ji6\\n8Alul7OyuNtuaijSTGGUEUmXT\"\n}\nThis API allows clients to download their bus tickets after a successful booking. Ensure that all provided parameters are valid for successful retrieval of the ticket.
"},{"location":"Cable%20Car/cablecar/","title":"21. Cable Car","text":"Please find the name of the cable car and their respective slug.
Type: Multi-Step API
"},{"location":"Cable%20Car/cablecar/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/cable-car/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"unique reference\",\n \"service\": \"slug\",\n \"trip_type\": \"One Way/Two Way\"\n}\nResponse:
\n{\n \"trips\": [\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Normal\",\n \"price\": 395.0,\n \"vat\": 45.44,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Normal\"\n },\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Child\",\n \"price\": 240.0,\n \"vat\": 27.61,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Child\"\n },\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Student\",\n \"price\": 300.0,\n \"vat\": 34.51,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Student\"\n },\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Elderly\",\n \"price\": 275.0,\n \"vat\": 31.64,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Elderly\"\n },\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Diff-Able\",\n \"price\": 190.0,\n \"vat\": 21.86,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Differently Able\"\n },\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Indian\",\n \"price\": 496.0,\n \"vat\": 57.06,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Indian Normal\"\n },\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Indian-CH\",\n \"price\": 320.0,\n \"vat\": 36.81,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Indian Child\"\n }\n ],\n \"session_id\": 3971,\n \"status\": true\n}\nRequest URL: {{base_url}}/api/servicegroup/commit/cable-car/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"unique reference\",\n \"session_id\": \"session_id\", // obtained from Detail Fetch API\n \"trip_type\": \"One Way/Two Way\", // obtained from Detail Fetch API\n \"contact_name\": \"contact_name\",\n \"mobile_number\": \"mobile_number\",\n \"tickets\": [\n {\n \"passenger_type\": \"passenger_type\", // obtained from Detail Fetch API\n \"passenger_count\": passenger_count\n }\n ],\n \"amount\": \"amount\" // obtained from Detail Fetch API\n}\nResponse:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"transaction_id\": \"443\",\n \"bill_number\": \"T4767711565\"\n },\n \"detail\": \"Payment Successful\",\n \"credits_consumed\": 395.0,\n \"credits_available\": \"xxxxx\",\n \"id\": 115044\n}\nRequest URL: {{base_url}}/api/servicegroup/downloadticket/cable-car/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"session_id\": 3969, // obtained from Detail Fetch API\n \"service\": \"slug\",\n \"base64\": true\n}\nType: Multi-Step API
Service_slug: himchuli
"},{"location":"Electricity/Himchuli/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/easternhawk/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"reference\": \"Unique Identifier\",\n \"service_slug\": \"himchuli\",\n \"customer_number\": \"356\"\n}\nResponse:
\n{\n \"amount\": \"1708.00\",\n \"customer_id\": \"567\",\n \"name\": \"Gyan bahadur majhi\",\n \"capacity\": \"15A\",\n \"area\": \"03-7430\",\n \"session_id\": 2318,\n \"status\": true\n}\nFields:
Request URL: {{base_url}}/api/servicegroup/commit/easternhawk/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"amount\": \"1708.00\",\n \"reference\": \"Unique Reference\",\n \"session_id\": \"2318\" \n}\nResponse:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 400.0,\n \"credits_available\": 9999558289.38,\n \"id\": 36219\n}\nFields:
Success).Successfully Completed Transaction).Success).Below is the list of Life Insurances under Dreamer Electricity and their service_slug:
\u2026 others to be added
Type: Multi-Step API
"},{"location":"Electricity/dreamer/#khamari-khola-electricity-khamari-khola-electricity","title":"Khamari Khola Electricity: khamari-khola-electricity","text":""},{"location":"Electricity/dreamer/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/dreamer-electricity/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"customer_code\": \"01-1\",\n \"reference\": \"unique_reference\",\n \"service_slug\": \"service_slug\"\n}\nResponse:
\n{\n \"consumer_id\": 13,\n \"consumer_no\": \"01-1\",\n \"consumer_name\": \"01-1 Bryan Hamal\",\n \"address\": \"Tole\",\n \"total_payable_amount\": 180,\n \"total_discount\": 20,\n \"total_penalty\": 0,\n \"total_bill_amount\": 200,\n \"due_bills\": [\n {\n \"bill_id\": 58,\n \"bill_year\": \"2078\",\n \"bill_month\": \"Baishak\",\n \"bill_amount\": 200,\n \"penalty\": 0,\n \"discount\": 20,\n \"no_of_days\": 2,\n \"total_amount\": 180\n }\n ],\n \"session_id\": 119,\n \"status\": true\n}\nFields:
Request URL: {{base_url}}/api/servicegroup/commit/dreamer-electricity/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"unique_reference\",\n \"session_id\": \"obtained from previous API\",\n \"amount\": \"obtained from previous API 'total_payable_amount'\"\n}\nResponse:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"receipt_no\": 2\n },\n \"detail\": \"Payment Successful\",\n \"credits_consumed\": 180.0,\n \"credits_available\": \"xxxxx\",\n \"id\": 107743\n}\nFields:
Success).Successfully Completed Transaction).Payment Successful).Note This
This documentation outlines the request and response formats for the Dreamer Electricity API, including details for both the Detail Fetch API and the Payment API.
"},{"location":"Electricity/nea/","title":"Electricity Payment API Documentation","text":""},{"location":"Electricity/nea/#overview","title":"Overview","text":"This document provides details on how to interact with the Electricity Payment APIs. The process involves retrieving counters, fetching bill details, calculating service charges, and making payments.
"},{"location":"Electricity/nea/#1-get-counters","title":"1. Get Counters","text":"URL: {{base_url}}/api/servicegroup/counters/nea/ Method: POST
Request Body:
\n{\n \"token\": \"token\"\n}\n\n{\n \"status\": true,\n \"counters\": [\n {\n \"name\": \"AANBU DC\",\n \"value\": \"243:aanbu-dc\"\n },\n {\n \"name\": \"ACHHAM DC\",\n \"value\": \"391:achham-dc\"\n },\n {\n \"name\": \"RATNAPARK DC\",\n \"value\": \"201:ratnapark-dc\"\n }\n ]\n}\nURL:{{url}}/api/servicegroup/details/nea/
Request: POST
Service Params:
\n{\n \"token\": \"token\",\n \"sc_no\": \"customer sc number, e.g. 02A.12.512\",\n \"reference\": \"unique-reference\",\n \"office_code\":\"one of the 'value' fields from Get Counters response\",\n \"consumer_id\": \"consumer ID, e.g. 3042\"\n}\nNote : sc_no : 3 alphanumeric string separated by dot.
"},{"location":"Electricity/nea/#success-response_1","title":"Success Response","text":"\n{\n \"session_id\": 5,\n \"consumer_name\": \"Michael Jackson\",\n \"due_bills\": [\n {\n \"bill_amount\": \"200\",\n \"bill_date\": \"2017-02-24\",\n \"days\": 5,\n \"payable_amount\": 200,\n \"due_bill_of\": \"2073 Magh\",\n \"status\": \"Normal\"\n },\n {\n \"bill_amount\": \"200\",\n \"bill_date\": \"2017-02-24\",\n \"days\": 13,\n \"payable_amount\": 250,\n \"due_bill_of\": \"2073 Falgun\",\n \"status\": \"-25% Penalty\"\n }\n ],\n \"total_due_amount\": 450,\n \"status\": true\n}\nImportant
200 (2073 Magh). URL:{{url}}/api/servicegroup/servicecharge/nea/
Request: POST
Service Params:
\n{\n \"amount\": \"Total amount intended to pay\",\n \"session_id\": \"value obtained during detail fetch step\",\n \"token\": \"token\"\n}\n\n{\n \"service_charge\": 5.0,\n \"amount\": 600.0,\n \"status\": true\n}\n\nDescription: Calculate the service charge for the payment amount. The service charge applies only for amounts greater than 500.
Note: - For amounts less than 500, the service charge is 0. - This API only calculates the charge. The amount provided to the Make Payment API should exclude the service charge.
"},{"location":"Electricity/nea/#4-make-payment","title":"4. Make Payment","text":"URL: {{url}}/api/servicegroup/commit/nea/
Method: POST
Response Body
\n{\n \"token\": \"token\",\n \"amount\": \"Total amount intended to pay (excluding service charge)\",\n \"session_id\": \"value obtained during detail fetch step\",\n \"reference\": \"unique reference\"\n}\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Amount Paid Successfully\",\n \"credits_consumed\": 600.0,\n \"credits_available\": 9996,\n \"id\": 61892\n}\n\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Max number exceeding\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\nType: Multi-Step API
"},{"location":"Electricity/softlab/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/softlab-electricity/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"customer_code\": \"12\",\n \"month\": \"0\",\n \"reference\": \"unique_reference\",\n \"service_slug\": \"badagaun-electricity\"\n}\nResponse:
\n{\n \"customer_code\": \"12\",\n \"customer_name\": \"\u0905\u0930\u094d\u091c\u0941\u0928 \u0936\u094d\u0930\u0947\u0937\u094d\u0920 (H2O Software)\",\n \"address\": \"\u0907.\u0917\u093e.\u092a\u093e.-3, \u092b\u093f\u0938\u094d\u0932\u093f\u0919\u094d\u0917\",\n \"mobile_number\": \"\",\n \"current_month_dues\": \"0\",\n \"current_month_discount\": \"0\",\n \"current_month_fine\": \"0\",\n \"total_credit_sales_amount\": \"0\",\n \"total_advance_amount\": \"0.0000\",\n \"previous_dues\": \"2810\",\n \"total_dues\": \"2810\",\n \"minimum_payable_amount\": \"2810\",\n \"session_id\": 207,\n \"status\": true\n}\nFields:
true).Request URL: {{base_url}}/api/servicegroup/commit/softlab-electricity/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"session_id\": \"obtained from previous API\",\n \"amount\": \"obtained from previous API 'total_dues'\"\n}\nResponse:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"due_amount\": \"0\",\n \"detail\": {\n \"message\": \"Successful Payment\",\n \"due_amount\": \"0\"\n },\n \"credits_consumed\": 2810.0,\n \"credits_available\": 98639503.46,\n \"id\": 107793\n}\nFields:
Success).Successfully Completed Transaction).Successful Payment).0).Note
This documentation provides a clear and detailed view of how to use the SoftLab Electricity API, including the request and response structures for both the Detail Fetch API and the Payment API.
"},{"location":"Electricity/watermark/","title":"Watermark Electricity","text":"Note: Below is the list of electricity services under Watermark Electricity and their respective service_slug:
Type: Multi-Step API
"},{"location":"Electricity/watermark/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/watermark-electricity/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"customer_code\": \"590-11\",\n \"reference\": \"unique_reference\",\n \"service_slug\": \"service_slug\"\n}\nResponse:
\n{\n \"customer_code\": \"590-11\",\n \"customer_name\": \"Kedar Nath Timilsina\",\n \"address\": \"Devichaur-04\",\n \"meter_no\": \"11086508\",\n \"zone\": \"Devichaur(01)\",\n \"ward\": \"01-01\",\n \"type\": \"Domestic\",\n \"advance_amount\": 82.5,\n \"total_due_amount\": 330.0,\n \"due_bills\": [\n {\n \"description\": \"Tariff of 2078-Baisakh\",\n \"date\": \"2078-1-9\",\n \"amount\": 257.0\n },\n {\n \"description\": \"Penal of 2078-Baisakh\",\n \"date\": \"2078-1-9\",\n \"amount\": 64.25\n },\n {\n \"description\": \"Demand Fee\",\n \"date\": \"2078-1-9\",\n \"amount\": 65.0\n },\n {\n \"description\": \"Penal of 2078-Baisakh Demand Fee\",\n \"date\": \"2078-1-9\",\n \"amount\": 16.25\n },\n {\n \"description\": \"Service Charge\",\n \"date\": \"2078-1-9\",\n \"amount\": 10.0\n },\n {\n \"description\": \"Penal of 2078-Baisakh Service Charge\",\n \"date\": \"2078-1-9\",\n \"amount\": 0.0\n }\n ],\n \"session_id\": 442,\n \"status\": true\n}\nFields:
Request URL: {{base_url}}/api/servicegroup/commit/watermark-electricity/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"unique_reference\",\n \"session_id\": \"btained from previous API\",\n \"amount\": \"obtained from previous API 'total_due_amount'\"\n}\nResponse:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 330.0,\n \"credits_available\": \"xxxx\",\n \"id\": 107598\n}\nFields:
Success).Successfully Completed Transaction).Success).The Reliable Life Insurance API facilitates a multi-step process for fetching policy details and processing payments. It enables users to retrieve information about their insurance policies and make payments for premiums.
"},{"location":"Insurance/Reliable_life/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Insurance/Reliable_life/#1-detail-fetch","title":"1. Detail Fetch","text":"Request URL: {{base_url}}/api/servicegroup/details/reliable-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"reference\": \"Unique_Identifier\",\n \"policy_no\": \"101000000008\",\n \"dob\": \"2018-09-26\"\n}\nResponse:
\n{\n \"premium_amount\": 100.0,\n \"customer_name\": \"test test1\",\n \"address\": \"Malakheti\",\n \"total_amount\": 180.0,\n \"policy_no\": \"701000000052\",\n \"product_name\": \"Endowment Cum Whole Life Plan - Amulya\",\n \"fine_amount\": 80.0,\n \"next_due_date\": \"2020-04-24\",\n \"pay_mode\": \"Yearly\",\n \"session_id\": 1013,\n \"status\": true\n}\nRequest URL: {{base_url}}/api/servicegroup/commit/reliable-life-insurance/
Request Method: POST
Service Params:
\n{\n \"reference\": \"Unique_identifier\",\n \"token\": \"token\",\n \"session_id\": \"1013\",\n \"amount\": \"180\"\n}\nResponse:
\n{\n \"id\": 70282,\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 180.0,\n \"credits_available\": 742509.83,\n \"extra_data\": {}\n}\nType: Multi Step API
"},{"location":"Insurance/neco_insurance/#insurance-policy-categories","title":"Insurance Policy Categories","text":"Request URL: {{base_url}}/api/servicegroup/details/neco-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"Token\",\n \"insurance_slug\": \"neco-insurance\"\n}\nRegex:
\n[\n {\n \"name\": \"Mobile\",\n \"slug\": \"\",\n \"pattern\": \"([9][678][0-6][0-9]{7})\",\n \"error_message\": \"Invalid mobile number\"\n }\n]\nResponse:
\n{\n \"category_list\": {\n \"neco-insurance\": [\n \"Cardamon Agr\",\n \"AGR / CAD GROUP\",\n \"Agriculture\",\n \"AGR / CAT GROUP\",\n \"AGR / POU GROUP\",\n \"AGR / CRP GROUP\",\n \"AGR / FSH GROUP\",\n \"Cattle agr\",\n \"Poultry agr\",\n \"Fish agr\",\n \"Rice agr\",\n \"Vegetable agr\",\n \"Potato agr\",\n \"Fruit agr\",\n \"tmcy (motorcycle)\",\n \"tpc (private vehicle)\",\n \"tcvb (Public Bus)\",\n \"tcvo (Other)\",\n \"tcvt (Truck and Tanker)\",\n \"tcvv (Private Bus)\",\n \"tcvx (Taxi)\",\n \"Personnel Accident(Micro)\",\n \"Health Insurance(Micro)\",\n \"Crop\",\n \"Bee agr\",\n \"AGR / BEE GROUP\",\n \"Mushroom agr\"\n ]\n },\n \"status\": true\n}\nRequest URL: {{base_url}}/api/servicegroup/commit/neco-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"Account_Token\",\n \"policy_type\": \"Fresh OR Renew OR\",\n \"customer_name\": \"RamLal\",\n \"policy_category\": \"Any one value from categories above\",\n \"amount\": 100.0,\n \"reference\": \"unique identifier for each request\",\n \"policy_number\": \"Optional Field | 12\",\n \"mobile_number\": \"9843664612\",\n \"service_name\": \"neco-insurance\",\n \"insurance_slug\": \"insurance_slug_from_search_step\"\n}\nResponse:
\n{\n \"credits_available\": 681649.199999999,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"status\": true,\n \"credits_consumed\": 1,\n \"id\": 442\n}\nThe Nepal Insurance API provides a multi-step process for fetching insurance details and processing payments. This API enables users to retrieve information about available policies, branches, and insurance types, and allows for the submission of payment requests for chosen insurance plans.
"},{"location":"Insurance/nepal_non_life/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Insurance/nepal_non_life/#1-detail-fetch","title":"1. Detail Fetch","text":"Request URL: {{base_url}}/api/servicegroup/info/nepal-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\"\n}\nResponse:
\n{\n \"policies\": [\n {\n \"label\": \"Endorsement\",\n \"value\": \"1\"\n },\n {}\n ],\n \"insurance_types\": [\n {\n \"label\": \"Motor/ Vehicle Insurance\",\n \"value\": \"1\"\n },\n {\n \"label\": \"Micro/ Agriculture Insurance\",\n \"value\": \"22\"\n }\n ],\n \"branches\": [\n {\n \"label\": \"Abukhaireni\",\n \"value\": \"1\"\n },\n {\n \"label\": \"Tulsipur\",\n \"value\": \"51\"\n }\n ]\n}\nRequest URL: {{base_url}}/api/servicegroup/commit/nepal-insurance/
Request Method: POST
Service Params:
\n{\n \"policy_type\": \"{{policy value}}\", // from detail fetch API\n \"branch\": \"{{branch value}}\", // from detail fetch API\n \"insurance_type\": \"{{insurance value}}\", // from detail fetch API\n \"amount\": \"1000\",\n \"debit_note_number\": \"11111\",\n \"customer_name\": \"customer_name\",\n \"customer_address\": \"Thimi\",\n \"mobile_number\": \"9851168561\",\n \"policy_description\": \"11111\",\n \"bill_no\": \"bill no\", // user input\n \"email\": \"babubaiyaa@gmail.com\", // user input\n \"token\": \"token\",\n \"reference\": \"Unique_identifier\"\n}\nResponse:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"detail\": \"Successful Payment\",\n \"message\": \"Successfully Completed Transaction\",\n \"credits_consumed\": 1000.0,\n \"credits_available\": 92900.0,\n \"extra_data\": {},\n \"id\": null\n}\nThe Prabhu Life Insurance API allows users to fetch policy details and process payments efficiently through a multi-step process.
"},{"location":"Insurance/prabhu_life/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Insurance/prabhu_life/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/prabhu-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"policy_no\": \"701000000052\",\n \"dob\": \"1996-12-11\",\n \"reference\": \"Unique Reference\"\n}\nResponse:
\n{\n \"premium_amount\": 100.0,\n \"customer_name\": \"test test1\",\n \"address\": \"Malakheti\",\n \"total_amount\": 180.0,\n \"policy_no\": \"701000000052\",\n \"product_name\": \"Endowment Cum Whole Life Plan - Amulya\",\n \"fine_amount\": 80.0,\n \"next_due_date\": \"2020-04-24\",\n \"pay_mode\": \"Yearly\",\n \"session_id\": 320,\n \"status\": true\n}\nRequest URL: {{base_url}}/api/servicegroup/commit/prabhu-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"320\", // session id received from detail fetch API\n \"amount\": \"amount\",\n \"reference\": \"Unique Reference\"\n}\nResponse:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"assured_name\": \"test test1\",\n \"fine_amount\": 80.0,\n \"premium_amount\": 100.0,\n \"next_due_date\": \"2021-04-24\",\n \"policy_no\": \"701000000052\",\n \"total_amount\": 180.0,\n \"invoice_number\": \"RP30137\"\n },\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 180.0,\n \"credits_available\": 9999633558.47,\n \"id\": 34846\n}\nType: Multi-Step API
"},{"location":"Insurance/rastriyabeema/#1-detail-fetch","title":"1. Detail Fetch","text":"Request URL: {{base_url}}/api/servicegroup/details/rastriya-beema-sasthan/
Request Method: POST
Service Params:
\n{\n \"reference\": \"unique_identifier\",\n \"token\": \"token\",\n \"policy_no\": \"49726\",\n \"dob\": \"1962-08-10\"\n}\nRequest Example:
\n{\n \"reference\": \"unique_ref_123\",\n \"token\": \"your_token_here\",\n \"policy_no\": \"49726\",\n \"dob\": \"1962-08-10\"\n}\nResponse:
\n{\n \"premium_amount\": 8392.0,\n \"customer_name\": \"NAVA NIDHI PANT\",\n \"address\": \"ILIT ENGLISH SCHOOL BUTWAL\",\n \"total_amount\": 100.0,\n \"policy_no\": \"49726\",\n \"product_name\": \"Endowment\",\n \"fine_amount\": 80,\n \"next_due_date\": \"1999-07-19\",\n \"current_due_date\": \"1999-07-19\",\n \"pay_mode\": \"Yearly\",\n \"session_id\": 1913,\n \"status\": true\n}\nRequest URL: {{base_url}}/api/servicegroup/commit/rastriya-beema-sasthan/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"{{session_id}}\", // From Detail Fetch API\n \"amount\": \"{{total_amount}}\" // From Detail Fetch API\n}\nResponse:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"assured_name\": \"test test1\",\n \"fine_amount\": 80.0,\n \"premium_amount\": 100.0,\n \"next_due_date\": \"2021-04-24\",\n \"policy_no\": \"701000000052\",\n \"total_amount\": 180.0,\n \"invoice_number\": \"RP30137\"\n },\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 180.0,\n \"credits_available\": 92720.0,\n \"id\": 105658\n}\nRequest URL: {{base_url}}/api/servicegroup/details/sagarmatha-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"Provided Token\",\n \"debit_note_no\": \"Debit Note no of client> (TEST DEBIT NOTE NO : 001618/198500779)\",\n \"reference\": \"unique identifier\"\n}\nResponse:
\n{\n \"contact_no\": \"9861233462\",\n \"debit_note_no\": \"001618/198500778\",\n \"session_id\": 171,\n \"address\": \"Tathali - 3, Bhaktapur, Bagmati\",\n \"name\": \"Bal Sundar Raut\",\n \"status\": true,\n \"payable_amount\": \"1010\"\n}\nRequest URL: {{base_url}}/api/servicegroup/commit/sagarmatha-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"Account_Token\",\n \"session_id\": \"session_id returned during user lookup\",\n \"amount\": \"premium amount to be paid from details step\"\n}\nResponse:
\n{\n \"bill_info\": {\n \"tax_invoice_no\": \"18740\",\n \"receipt_no\": \"24211\",\n \"document_no\": \"111618/198500702\"\n },\n \"id\": 3523,\n \"extra_data\": {},\n \"state\": \"Success\",\n \"detail\": \"Successful Payment\",\n \"message\": \"Successfully Completed Transaction\",\n \"status\": true\n}\nType: Multi-Step API
"},{"location":"Insurance/suryajoytiloan/#1-detail-fetch","title":"1. Detail Fetch","text":"Request URL: {{base_url}}/api/servicegroup/details/surya-jyoti-loan-repayment/
Request Method: POST
Service Params:
\n{\n \"reference\": \"unique_identifier\",\n \"token\": \"token\",\n \"policy_no\": \"49726\",\n \"dob\": \"1962-08-10\",\n \"date_format\": \"AD / BS\"\n}\nRequest Example:
\n{\n \"reference\": \"unique_ref_123\",\n \"token\": \"your_token_here\",\n \"policy_no\": \"49726\",\n \"dob\": \"1962-08-10\",\n \"date_format\": \"AD\"\n}\nResponse:
\n{\n \"policy_no\": \"7330000152\",\n \"name\": \"Melina Magar\",\n \"policy_type\": \"Loan Repayment\",\n \"total_payable_amount\": 18056.0,\n \"minimum_payable\": 10.0,\n \"int_to_pay\": 5.0,\n \"loan_amount\": 22000,\n \"interest_calculated_from\": \"20/07/2022\",\n \"interest_calculated_to\": \"22/07/2022\",\n \"total_due_interest\": 10.0,\n \"principal_amount\": 18051.0,\n \"session_id\": 17118,\n \"status\": true\n}\nRequest URL: {{base_url}}/api/servicegroup/commit/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"{{session_id}}\", // From Detail Fetch API\n \"amount\": \"{{total_amount}}\", // From Detail Fetch API\n \"reference\": \"unique_identifier\"\n}\nRequest Example:
\n{\n \"token\": \"your_token_here\",\n \"session_id\": \"17118\",\n \"amount\": \"18056.0\",\n \"reference\": \"unique_ref_123\"\n}\nResponse:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"policy_no\": \"7330000152\"\n },\n \"detail\": \"Transaction Successful\",\n \"credits_consumed\": 18056.0,\n \"credits_available\": 75502.0,\n \"id\": 105663\n}\nThe Arhant Life Insurance API allows users to fetch details about their life insurance policies and process payments. This multi-step API supports various life insurance products under Arhant, including Asian Life Insurance and Ime Life Insurance.
"},{"location":"Insurance/Arhant%20Insurance/life/#type-multi-step-api","title":"Type: Multi Step API","text":"Below is the list of Life Insurances under Arhant and their service_slug:
"},{"location":"Insurance/Arhant%20Insurance/life/#asian-life-insurance-asian-life-insurance","title":"Asian Life Insurance : asian-life-insurance","text":""},{"location":"Insurance/Arhant%20Insurance/life/#ime-life-insurance-ime-life-insurance","title":"Ime Life Insurance : ime-life-insurance","text":""},{"location":"Insurance/Arhant%20Insurance/life/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{url}}/api/servicegroup/details/arhant-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"policy_no\": \"51080000258\", // User input\n \"dob_year\": \"1984\", // User input\n \"insurance_slug\": \"service_slug\",\n \"reference\": \"unique-reference\"\n}\nResponse:
\n{\n \"request_id\": \"51080000258-1984\",\n \"amount\": 4803,\n \"properties\": {\n \"policy_no\": \"51080000258\",\n \"customer_name\": \"Chandra Kala Ghimire\",\n \"address\": \"Fidim-4\",\n \"product_name\": \"Endowment\",\n \"premium\": \"4803\",\n \"late_fee\": \"0\",\n \"waive_amount\": \"0\",\n \"previous_excess_short\": \"0.00\"\n },\n \"session_id\": 8867,\n \"status\": true\n}\nRequest URL: {{base_url}}/api/servicegroup/commit/arhant-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"137\",\n \"amount\": \"amount\"\n}\nResponse:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 4803,\n \"credits_available\": 999999998060930.6,\n \"id\": 62849\n}\nOverview: This document provides information on the non-life insurance services offered by Arhant, including the endpoints for retrieving proforma details and completing payments.
"},{"location":"Insurance/Arhant%20Insurance/non_life/#available-non-life-insurance-services","title":"Available Non-Life Insurance Services:","text":"Insurance Company Service Slug Notes Ajod Insuranceajod-insurance Obsolete. Merged with United Insurance. Use United Insurance API. Everest Insurance everest-insurance Obsolete. GIC Insurance gic-insurance Obsolete. Lumbini General Insurance lumbini-general-insurance Merged with Sagarmatha Insurance API. Lumbini General Insurance is obsolete. NLG Insurance nlg-insurance Premier Insurance premier-insurance Obsolete. Merged with Siddhartha Insurance. Use Siddhartha Insurance API. Sanima General Insurance sanima-general-insurance Shikhar Insurance shikhar-insurance Obsolete. Siddhartha Insurance siddhartha-insurance United Insurance united-insurance"},{"location":"Insurance/Arhant%20Insurance/non_life/#details","title":"Details","text":"{{base_url}}/api/servicegroup/details/arhant-non-life-insurance/ To get the proforma details, send a POST request with the following parameters:
\n{\n \"token\": \"token\", \n \"reference\": \"reference\", \n \"proforma_no\": \"01458110\", \n \"service_slug\": \"service_slug\" \n}\nThe response provides detailed information about the proforma, such as premium amounts, insured details, and vehicle information.
\n{\n \"success_message\": \"Proforma is valid\",\n \"request_id\": 2176242,\n \"proforma_no\": \"2176242\",\n \"class_name\": \"Motor,Third Party Motorcycle\",\n \"sum_insured\": 0,\n \"net_premium\": 1700,\n \"stamp_duty\": 10,\n \"vat_amount\": 221,\n \"subsidized_premium\": 0,\n \"total_premium\": 1931,\n \"vehicle_no\": \"NA 59 PA 2511\",\n \"insured\": \"Tanknath Pokharel,Hariwan-01, Sarlahi\",\n \"session_id\": 20327,\n \"status\": true\n}\n{{base_url}}/api/servicegroup/commit/arhant-non-life-insurance/ To finalize the payment, send a POST request with these parameters:
\n{\n \"token\": \"token\", \n \"reference\": \"reference\", \n \"session_id\": \"session_id\" \n}\nThe response confirms the transaction status and provides details about credits consumed and remaining.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 4803,\n \"credits_available\": \"xxxxxxxx\",\n \"id\": 62849\n}\nThe Citizen Life Insurance API allows users to retrieve details about their insurance policies and process payments. This multi-step API provides access to policy information and facilitates secure transactions for premium payments.
"},{"location":"Insurance/Citizen/citizen/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Insurance/Citizen/citizen/#1-detail-fetch","title":"1. Detail Fetch","text":"Request URL: {{base_url}}/api/servicegroup/details/citizen-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"reference\": \"Unique_Identifier\",\n \"policy_no\": \"101000315\",\n \"dob\": \"1976-09-22\"\n}\nResponse:
\n{\n \"premium_amount\": 100.0,\n \"customer_name\": \"test test1\",\n \"address\": \"Malakheti\",\n \"total_amount\": 180.0,\n \"policy_no\": \"701000000052\",\n \"product_name\": \"Endowment Cum Whole Life Plan - Amulya\",\n \"fine_amount\": 80.0,\n \"next_due_date\": \"2020-04-24\",\n \"pay_mode\": \"Yearly\",\n \"session_id\": 994,\n \"status\": true\n}\nRequest URL: {{base_url}}/api/servicegroup/commit/citizen-life-insurance/
Request Method: POST
Service Params:
\n{\n \"reference\": \"Unique_identifier\",\n \"token\": \"token\",\n \"session_id\": \"994\",\n \"amount\": \"180\"\n}\nResponse:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"assured_name\": \"test test1\",\n \"fine_amount\": 80.0,\n \"premium_amount\": 100.0,\n \"next_due_date\": \"2021-04-24\",\n \"policy_no\": \"701000000052\",\n \"total_amount\": 180.0,\n \"invoice_number\": \"RP30137\"\n },\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 180.0,\n \"credits_available\": 9995400876.57663,\n \"id\": 68751\n}\nThis document outlines the APIs for fetching user details and processing payments related to Himalayan General Insurance.
"},{"location":"Insurance/Himalayan%20Insurance/hg-general-insurance/#user-detail-fetch-api","title":"User Detail Fetch API","text":"{{base_url}}/api/servicegroup/details/hg-insurance/\n{\n \"insured_party\": \"Jeetendra Maharjan\",\n \"policy_no\": \"KTM/MCY/11/18/19/95868\",\n \"premium_amount\": 4875.56,\n \"expiry_date\": \"2019-05-24\",\n \"insured_amount\": 200000,\n \"coverage_type\": \"Comprehensive\",\n \"ids\": \"5cff2e048c36076fac6a4d0d\",\n \"session_id\": 161,\n \"status\": true\n}\n{{base_url}}/api/servicegroup/commit/hg-insurance/\n{\n \"token\": \"token\",\n \"session_id\": 161,\n \"reference\": \"reference123\",\n \"amount\": 4875.56\n}\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"premium_amount\": 4875.56,\n \"policy_no\": \"KTM/MCY/11/18/19/95868\",\n \"coverage_type\": \"Comprehensive\",\n \"insured_amount\": 200000\n },\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 4875.56,\n \"credits_available\": 96786310.1950002,\n \"id\": 5878\n}\nRequest URL: {{base_url}}/api/servicegroup/details/nepal-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{TOKEN}}\",\n \"reference\": \"unique reference id\",\n \"policy_no\": \"401059698\",\n \"dob\": \"2008-03-20\"\n}\nResponse:
\n{\n \"customer_name\": \"TUSARA SINGH THAKURI\",\n \"policy_no\": \"401059698\",\n \"due_date\": \"2020-12-20\",\n \"premium_amount\": 2500.0,\n \"amount\": 2500.0,\n \"fine_amount\": 0.0,\n \"rebate_amount\": 0.0,\n \"session_id\": 102,\n \"status\": true\n}\nError Response:
\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Policy does not exist or not active.\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\nRequest URL: {{base_url}}/api/servicegroup/commit/nepal-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{TOKEN}}\",\n \"reference\": \"unique reference id\",\n \"amount\": 2500,\n \"session_id\": 2121345\n}\nResponse:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"policy_no\": \"401059698\"\n },\n \"detail\": \"Success\",\n \"credits_consumed\": 2500.0,\n \"credits_available\": 105844058.084999,\n \"id\": 10959\n}\nNote: Reliance and Sanima Life Insurance have merged. Please use the Reliance Life Insurance API.
Type: Multi Step API
"},{"location":"Insurance/Reliance%20Insurance/reliance_insurance/#overview","title":"Overview","text":"The Reliance Insurance API facilitates interactions with Reliance Insurance services, including retrieving user details and processing payments. The API involves two primary steps:
USER DETAIL API: Fetches policy details and user information based on the provided policy number and date of birth.
Payment API: Handles the payment process for the insurance policy using the information retrieved from the USER DETAIL API.
Request URL: {{base_url}}/api/servicegroup/details/reliance-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"provided_token\",\n \"policy_no\": \"301000003781\",\n \"dob\": \"YYYY-MM-DD\"\n}\nSample Response:
Success:
\n{\n \"paymode\": \"Yearly\",\n \"transaction_id\": \"100373\",\n \"product_name\": \"Endowment Assurance Cum Whole Life Policy\",\n \"customer_id\": \"301000000277\",\n \"next_due_date\": \"2019-02-20\",\n \"status\": true,\n \"invoice_number\": \"\",\n \"amount\": \"43845.00\",\n \"customer_name\": \"HARI CHANDRA YADAV\",\n \"address\": \"Auradi\",\n \"fine_amount\": \"949.0000\"\n}\nOverview: The USER DETAIL API allows you to fetch detailed information about an insurance policy using the policy number and date of birth. It provides details such as the product name, next due date, amount payable, and customer information.
"},{"location":"Insurance/Reliance%20Insurance/reliance_insurance/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/reliance-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"\",\n \"amount\": \"\",\n \"policy_no\": \"\",\n \"transaction_id\": \"\",\n \"reference\": \"\"\n}\n\n\nSample Response:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"customer_id\": \"101000000008\",\n \"customer_name\": \"BIBEK KUMAR DEV\",\n \"next_due_date\": \"11/04/2019\",\n \"product_name\": \"Child Assurance Plan\",\n \"fine_amount\": \"0.00\",\n \"invoice_number\": \"RP001\",\n \"transaction_id\": \"100051\"\n },\n \"detail\": {\n \"customer_id\": \"101000000008\",\n \"customer_name\": \"BIBEK KUMAR DEV\",\n \"next_due_date\": \"11/04/2019\",\n \"product_name\": \"Child Assurance Plan\",\n \"fine_amount\": \"0.00\",\n \"invoice_number\": \"RP001\",\n \"transaction_id\": \"100051\"\n },\n \"credits_consumed\": 43845.0,\n \"credits_available\": 9993994136.51662,\n \"id\": 93762\n}\n
\n\nOverview: \nThe Payment API processes payments for the insurance policy. It requires details such as the policy number, transaction ID, amount to be paid, and a unique reference identifier. Upon successful payment, it returns information about the transaction, including customer details and payment status.
"},{"location":"Insurance/Sunlife/sunlife/","title":"Sun Life Insurance","text":"Type: Multi Step API
"},{"location":"Insurance/Sunlife/sunlife/#1-detail-fetch","title":"1. Detail Fetch","text":"Request URL: {{base_url}}/api/servicegroup/details/sun-life-insurance/
Request Method: POST
Service Params:
\n{\n \"reference\": \"\",\n \"token\": \"\",\n \"policy_no\": \"66160014378\",\n \"dob\": \"1968-06-01\"\n}\n\n\nResponse:
\n\n{\n \"premium_amount\": 100.0,\n \"customer_name\": \"test test1\",\n \"address\": \"Malakheti\",\n \"total_amount\": 180.0,\n \"policy_no\": \"701000000052\",\n \"product_name\": \"Endowment Cum Whole Life Plan - Amulya\",\n \"fine_amount\": 80.0,\n \"next_due_date\": \"2020-04-24\",\n \"current_due_date\": \"2020-04-24\",\n \"pay_mode\": \"Yearly\",\n \"session_id\": 1916,\n \"status\": true\n}\n
"},{"location":"Insurance/Sunlife/sunlife/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/sun-life-insurance/
\nRequest Method: POST
\nService Params:
\n\n{\n \"token\": \"\",\n \"session_id\": \"{{session_id}}\", // From Detail Fetch API\n \"amount\": \"{{total_amount}}\", // From Detail Fetch API\n \"reference\": \"\"\n}\n\n\nResponse:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"assured_name\": \"test test1\",\n \"fine_amount\": 80.0,\n \"premium_amount\": 100.0,\n \"next_due_date\": \"2021-04-24\",\n \"policy_no\": \"701000000052\",\n \"total_amount\": 180.0,\n \"invoice_number\": \"RP30137\"\n },\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 180.0,\n \"credits_available\": 75322.0,\n \"id\": 105695\n}\n
"},{"location":"Insurance/ime/ime_general/","title":"IME General Insurance","text":""},{"location":"Insurance/ime/ime_general/#overview","title":"Overview","text":"The IME General Insurance API provides a structured approach to handle insurance-related operations, including fetching details of various insurance types and processing payments for those insurance policies.
"},{"location":"Insurance/ime/ime_general/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Insurance/ime/ime_general/#1-detail-api","title":"1. Detail API","text":"Request URL: {{base_url}}/api/servicegroup/info/ime-general-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\"\n}\n
Response:
\n{\n \"policy_type\": [\n { \"label\": \"Endorsement\", \"value\": \"1\" },\n { \"label\": \"New\", \"value\": \"2\" },\n { \"label\": \"Renewal\", \"value\": \"3\" }\n ],\n \"insurance_type\": [\n { \"label\": \"Motor/Vehicle Insurance\", \"value\": \"1\" },\n { \"label\": \"Property Insurance\", \"value\": \"2\" },\n { \"label\": \"Engineering Insurance\", \"value\": \"3\" },\n { \"label\": \"Group Personal Accidental Insurance\", \"value\": \"4\" },\n { \"label\": \"Money Insurance\", \"value\": \"5\" },\n { \"label\": \"Banker's Blanket Insurance\", \"value\": \"6\" },\n { \"label\": \"Personal Accidental Insurance\", \"value\": \"7\" },\n { \"label\": \"Professional Indemnity Insurance\", \"value\": \"8\" },\n { \"label\": \"Cash In Transit Insurance\", \"value\": \"9\" },\n { \"label\": \"Public Liability Insurance\", \"value\": \"10\" },\n { \"label\": \"Medi Claim Insurance\", \"value\": \"11\" },\n { \"label\": \"Travel Insurance\", \"value\": \"12\" },\n { \"label\": \"Cash Counter Insurance\", \"value\": \"13\" },\n { \"label\": \"Gold Insurance\", \"value\": \"14\" },\n { \"label\": \"Press Accident Insurance\", \"value\": \"15\" },\n { \"label\": \"Adventure Sports Insurance\", \"value\": \"16\" },\n { \"label\": \"Tracking Insurance\", \"value\": \"17\" },\n { \"label\": \"Cyber Insurance\", \"value\": \"18\" },\n { \"label\": \"Critical Illness Insurance\", \"value\": \"19\" },\n { \"label\": \"Marine Insurance\", \"value\": \"20\" },\n { \"label\": \"Micro/Agriculture Insurance\", \"value\": \"21\" }\n ],\n \"branches\": [\n { \"label\": \"Head Office\", \"value\": \"1\" },\n { \"label\": \"Pokhara\", \"value\": \"2\" },\n { \"label\": \"Butwal\", \"value\": \"3\" },\n { \"label\": \"Narayangadh\", \"value\": \"4\" },\n { \"label\": \"Nepalgunj\", \"value\": \"5\" },\n { \"label\": \"Birgunj\", \"value\": \"6\" },\n { \"label\": \"Dhangadhi\", \"value\": \"7\" },\n { \"label\": \"Banepa\", \"value\": \"8\" },\n { \"label\": \"Biratnagar\", \"value\": \"9\" },\n { \"label\": \"Janakpur\", \"value\": \"10\" },\n { \"label\": \"Hetauda\", \"value\": \"11\" },\n { \"label\": \"Okhaldhunga\", \"value\": \"12\" },\n { \"label\": \"Bardibas\", \"value\": \"13\" },\n { \"label\": \"Solukhumbu\", \"value\": \"14\" },\n { \"label\": \"Gongabu\", \"value\": \"15\" },\n { \"label\": \"Kalanki\", \"value\": \"16\" },\n { \"label\": \"Koteshwor\", \"value\": \"17\" },\n { \"label\": \"Bhaktapur\", \"value\": \"18\" },\n { \"label\": \"Bhairahawa\", \"value\": \"19\" },\n { \"label\": \"Dolakha\", \"value\": \"20\" },\n { \"label\": \"Dang\", \"value\": \"21\" },\n { \"label\": \"Jawalakhel\", \"value\": \"22\" },\n { \"label\": \"Aabukhaireni\", \"value\": \"23\" },\n { \"label\": \"Birtamod\", \"value\": \"24\" },\n { \"label\": \"Baglung\", \"value\": \"25\" },\n { \"label\": \"Kawasoti\", \"value\": \"26\" },\n { \"label\": \"New Road\", \"value\": \"27\" },\n { \"label\": \"Surkhet\", \"value\": \"28\" },\n { \"label\": \"Dhading\", \"value\": \"29\" },\n { \"label\": \"Manthali\", \"value\": \"30\" },\n { \"label\": \"Boudha\", \"value\": \"31\" },\n { \"label\": \"Itahari\", \"value\": \"32\" },\n { \"label\": \"Damak\", \"value\": \"33\" },\n { \"label\": \"Teku\", \"value\": \"34\" },\n { \"label\": \"Tulsipur\", \"value\": \"35\" },\n { \"label\": \"Nuwakot\", \"value\": \"36\" },\n { \"label\": \"Syangja\", \"value\": \"37\" },\n { \"label\": \"Tandi\", \"value\": \"38\" },\n { \"label\": \"Dadeldhura\", \"value\": \"39\" },\n { \"label\": \"Lahan\", \"value\": \"40\" },\n { \"label\": \"Kirtipur\", \"value\": \"41\" },\n { \"label\": \"Simara\", \"value\": \"42\" },\n { \"label\": \"Mahendranagar\", \"value\": \"43\" },\n { \"label\": \"Damauli\", \"value\": \"44\" },\n { \"label\": \"Ilam\", \"value\": \"45\" }\n ]\n}\n
"},{"location":"Insurance/ime/ime_general/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/use/ime-general-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"policy_type\": \"Endorsement\",\n \"insurance_type\": \"Property Insurance\",\n \"branch\": \"Pokhara\",\n \"full_name\": \"test test\",\n \"address\": \"address\",\n \"mobile_number\": \"9841111111\",\n \"policy_description\": \"Description\",\n \"debit_note_no\": \"123465789\",\n \"bill_no\": \"12346589\",\n \"email\": \"user_email_id\",\n \"amount\": \"10\",\n \"reference\": \"Unique Reference\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 10.0,\n \"credits_available\": 9999633548.47,\n \"extra_data\": {\n \"policy_type\": \"Endorsement\",\n \"insurance_type\": \"Property Insurance\",\n \"branch\": \"Pokhara\",\n \"full_name\": \"test test\",\n \"address\": \"test test\",\n \"mobile_number\": \"9841111111\",\n \"policy_description\": \"test test\",\n \"debit_note_no\": \"123465789\",\n \"bill_no\": \"12346589\",\n \"email\": \"ressrew\"\n },\n \"id\": 34849\n}\n
"},{"location":"Insurance/prudential/prudential/","title":"Prudential Insurance","text":"Type: Multi Step API
"},{"location":"Insurance/prudential/prudential/#1-get-branches-api","title":"1. Get Branches API","text":" - Request URL:
{{base_url}}/api/servicegroup/getpackages/prudential-insurance/ - Request Method: POST
"},{"location":"Insurance/prudential/prudential/#service-params","title":"Service Params:","text":"\n{\n \"token\": \"token\"\n}\n
"},{"location":"Insurance/prudential/prudential/#response","title":"Response:","text":"\n{\n \"status\": true,\n \"detail\": {\n \"branches\": [\n {\n \"branch_name\": \"Kathmandu\",\n \"id\": 1\n },\n {\n \"branch_name\": \"Birgunj\",\n \"id\": 2\n }\n ]\n }\n}\n
"},{"location":"Insurance/prudential/prudential/#2-payment-api","title":"2. Payment API","text":" - Request URL:
{{base_url}}/api/use/prudential-insurance/ - Request Method: POST
"},{"location":"Insurance/prudential/prudential/#service-params_1","title":"Service Params:","text":"\n{\n \"token\": \"\",\n \"issue_branch\": \"Kathmandu\", // branches fetched from get branch API\n \"customer_name\": \"Babu rao\",\n \"mobile_number\": \"9818822421\",\n \"email\": \"baburao@gmail.com\",\n \"debit_note_or_bill_number\": \"123456\",\n \"amount\": \"amount\",\n \"reference\": \"unique-reference\"\n}"},{"location":"Insurance/prudential/prudential/#response_1","title":"Response:","text":"\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 1200.0,\n \"credits_available\": 9999611980.48,\n \"extra_data\": {\n \"issue_branch\": \"Kathmandu\",\n \"customer_name\": \"Babu rao\",\n \"mobile_number\": \"9818822421\",\n \"email\": \"baburao@gmail.com\",\n \"debit_note_or_bill_number\": \"123456\"\n },\n \"id\": 35444\n}\n
"},{"location":"Insurance/surya/Suryalife/","title":"11.5 Surya Jyoti Life Insurance API","text":"Note: Jyoti and Surya Life Insurance have merged. Please use the Surya Life Insurance API.
"},{"location":"Insurance/surya/Suryalife/#overview","title":"Overview","text":"The Surya Jyoti Life Insurance API provides functionalities for retrieving policy details and processing payments for Surya Life Insurance policies. The API involves two main operations:
-
Detail Fetch API: Retrieves detailed information about an insurance policy using the policy number and date of birth.
-
Payment API: Processes payments for the insurance policy using the information retrieved from the Detail Fetch API.
"},{"location":"Insurance/surya/Suryalife/#surya-jyoti-life-detail-fetch-api","title":"Surya Jyoti Life Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/surya-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"\",\n \"policy_no\": \"7000000019\",\n \"dob\": \"1988-02-21\",\n \"reference\": \"\"\n}\n\n\nSuccess Response:
\n\n{\n \"policy_no\": \"207001096\",\n \"plan_code\": \"71\",\n \"pay_mode\": \"YRLY\",\n \"name\": \"Ram Thakur\",\n \"premium_amount\": 10211,\n \"fine_amount\": 85,\n \"adjustment_amount\": 0,\n \"amount\": \"10296\",\n \"payment_date\": \"06/07/2023\",\n \"due_date\": \"20/05/2023\",\n \"next_due_date\": \"20/05/2024\",\n \"policy_status\": \"ACTIVE\",\n \"term\": \"15\",\n \"maturity_date\": \"20/05/2025\",\n \"session_id\": 9470,\n \"status\": true\n}\n
\n\nError Response:
\n\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Invalid Date of Birth/Policy Number\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
\n\nOverview: \nThe Detail Fetch API retrieves comprehensive details about a specific insurance policy based on the policy number and date of birth. It provides information such as the policy number, premium amount, fine amount, due dates, and policy status.
"},{"location":"Insurance/surya/Suryalife/#surya-jyoti-life-payment-api","title":"Surya Jyoti Life Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/surya-life-insurance/
\nRequest Method: POST
\nService Params:
\n\n{\n \"token\": \"\",\n \"session_id\": \"\",\n \"reference\": \"reference123\",\n \"amount\": 1305\n}\n\n\nSuccess Response:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"customer_name\": \"Parbati Kunwar Karki\",\n \"fine_amount\": 0.0,\n \"adjustment_amount\": 0.0,\n \"premium_amount\": 8430.0,\n \"payment_date\": \"02/06/2020\",\n \"next_due_date\": \"20/05/2021\",\n \"policy_no\": \"111001524\",\n \"total_amount\": 8430.0\n },\n \"detail\": \"Transaction Successful\",\n \"credits_consumed\": 8430.0,\n \"credits_available\": 477719.77,\n \"id\": 85407\n}\n
\n\nError Response:
\n\n{\n \"status\": false,\n \"error_code\": \"1011\",\n \"message\": \"Validation error\",\n \"error\": \"validation_error\",\n \"details\": {\n \"amount\": \"Invalid Amount\"\n },\n \"error_data\": {\n \"amount\": \"Invalid Amount\"\n },\n \"state\": \"Error\"\n}\n
\n\nOverview: \nThe Payment API processes payments for a Surya Life Insurance policy. It requires details such as the session ID (from the Detail Fetch API), payment amount, and a unique reference identifier. On successful completion, it returns transaction details including customer name, payment date, and total amount. If there are issues, such as invalid payment amounts, the API will return an error response with relevant details.
"},{"location":"Insurance/surya/surya_life_insurance/","title":"Surya Life Insurance First Payment","text":""},{"location":"Insurance/surya/surya_life_insurance/#overview","title":"Overview","text":"The Surya Life Insurance API facilitates the first payment process for policyholders. It includes a detail retrieval step that provides essential information about the policy, followed by a payment submission step.
"},{"location":"Insurance/surya/surya_life_insurance/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Insurance/surya/surya_life_insurance/#1-detail-api","title":"1. Detail API","text":"Request URL: {{base_url}}/api/servicegroup/first_payment/surya-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"policy_no\": \"132468\",\n \"reference\": \"Unique_Reference\",\n \"service_slug\": \"surya-life-first-payment\"\n}\n
Response:
\n{\n \"customer_name\": \"Suresh Raj Joshi\",\n \"address\": \"Sabhapokhari\",\n \"plan_name\": \"Surya Surachhit (Limited Payment)\",\n \"policy_no\": \"77777780079\",\n \"sum_assured\": 100000,\n \"premium_amount\": 40,\n \"payment_date\": \"31/05/2021\",\n \"term_year\": \"1\",\n \"pay_mode\": \"SNGL\",\n \"amount\": \"40\",\n \"session_id\": 286,\n \"status\": true\n}\n
"},{"location":"Insurance/surya/surya_life_insurance/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/surya-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"286\", // Obtained from detail API\n \"reference\": \"Unique Identifier\",\n \"service_slug\": \"surya-life-first-payment\",\n \"amount\": \"40\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"customer_name\": \"Suresh Raj Joshi\",\n \"fine_amount\": 0.0,\n \"adjustment_amount\": 0.0,\n \"premium_amount\": 40.0,\n \"payment_date\": \"31/05/2021\",\n \"next_due_date\": \"\",\n \"policy_no\": \"77777780079\",\n \"total_amount\": 40.0\n },\n \"detail\": \"Transaction Successful\",\n \"credits_consumed\": 40.0,\n \"credits_available\": 9999625028.47,\n \"id\": 34864\n}\n
"},{"location":"Internet/3g-vision/","title":"3G Vision","text":"This document outlines the API for 3G Vision, which includes two main functionalities: retrieving available packages and processing payments. It details the request URLs, methods, parameters, and example responses for both the package retrieval and payment APIs.
"},{"location":"Internet/3g-vision/#get-packages-api","title":"Get Packages API","text":"Request URL: {{base_url}}/api/servicegroup/getpackages/three-g-vision/
Request Method: POST
"},{"location":"Internet/3g-vision/#service-params","title":"Service Params:","text":"\n{ \n \"token\": \"token\", \n \"reference\": \"unique reference\" \n}\n
"},{"location":"Internet/3g-vision/#response","title":"Response:","text":"\n{ \n \"status\": true, \n \"detail\": { \n \"packages\": [ \n { \n \"label\": \"5 Mbps unlimited - Internet\", \n \"value\": \"5 Mbps unlimited - Internet\" \n }, \n { \n \"label\": \"10 Mbps unlimited - Internet\", \n \"value\": \"10 Mbps unlimited - Internet\" \n }, \n { \n \"label\": \"15 Mbps unlimited - Internet\", \n \"value\": \"15 Mbps unlimited - Internet\" \n }, \n { \n \"label\": \"30 Mbps unlimited - Internet\", \n \"value\": \"30 Mbps unlimited - Internet\" \n }, \n { \n \"label\": \"75 Mbps unlimited - Internet\", \n \"value\": \"75 Mbps unlimited - Internet\" \n }, \n { \n \"label\": \"Basic Package - Tv\", \n \"value\": \"Basic Package - Tv\" \n }, \n { \n \"label\": \"Basic Plus Package - Tv\", \n \"value\": \"Basic Plus Package - Tv\" \n }, \n { \n \"label\": \"Premium Package - Tv\", \n \"value\": \"Premium Package - Tv\" \n } \n ] \n } \n}\n
"},{"location":"Internet/3g-vision/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/use/three-g-vision/
Request Method: POST
"},{"location":"Internet/3g-vision/#service-params_1","title":"Service Params:","text":"\n{ \n \"token\": \"{{live}}\", \n \"reference\": \"{{$guid}}\", \n \"name\": \"udeep\", \n \"contact_number\": \"9849324652\", \n \"user_id\": \"aoubeceoa\", \n \"amount\": 100, \n \"package\": \"5 Mbps unlimited - Internet\", \n \"remarks\": \"This is an optional field\" \n}\n
"},{"location":"Internet/3g-vision/#response_1","title":"Response:","text":"\n{ \n \"status\": true, \n \"state\": \"Queued\", \n \"detail\": \"Transaction Queued\", \n \"message\": \"Your operation is in queue.\", \n \"credits_consumed\": 100.0, \n \"credits_available\": \"**********\", \n \"extra_data\": { \n \"name\": \"udeep\", \n \"contact_number\": \"9849324652\", \n \"user_id\": \"aoubeceoa\", \n \"package\": \"5 Mbps unlimited - Internet\", \n \"remarks\": \"This is an optional field\" \n }, \n \"id\": 20274 \n}\n
"},{"location":"Internet/Fibertel/","title":"Fibertel Fibernet","text":"This document outlines the API for initiating a transaction with Fibertel Fibernet, including the required parameters and expected response format.
Type: Single Step API
"},{"location":"Internet/Fibertel/#request-details","title":"Request Details","text":" - Request URL:
{{base_url}}/api/use/fibertel-fibernet/ - Request Method: POST
"},{"location":"Internet/Fibertel/#service-params","title":"Service Params","text":"\n{\n \"token\": \"{{live}}\",\n \"username\": \"abin\",\n \"contact_number\": \"9843666888\",\n \"package\": \"Residential Plan 1 Month 30 Mbps\", // User Input\n \"amount\": 15501, // User Input\n \"reference\": \"sky12\",\n \"remarks\": \"TEST\"\n}\n
"},{"location":"Internet/Fibertel/#response","title":"Response","text":"\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 15501.0,\n \"credits_available\": 101197089.864999,\n \"extra_data\": {\n \"username\": \"abin\",\n \"contact_number\": \"9843666888\",\n \"package\": \"Residential Plan 1 Month 30 Mbps\",\n \"remarks\": \"TEST\",\n \"name\": \"ABin\"\n },\n \"id\": 20211\n}\n
"},{"location":"Internet/Virtual-network/","title":"Virtual Network API","text":"The Virtual Network API allows users to make payments for virtual network services.
"},{"location":"Internet/Virtual-network/#type-single-step-api","title":"Type: Single Step API","text":""},{"location":"Internet/Virtual-network/#endpoint","title":"Endpoint","text":" - URL:
{{base_url}}/api/use/virtual-network/ - Method:
POST
"},{"location":"Internet/Virtual-network/#service-parameters","title":"Service Parameters","text":"The request must include the following parameters:
\n{\n \"token\": \"token\",\n \"username\": \"Username, eg: khaltiUser\",\n \"mobile_number\": \"9818766122\",\n \"amount\": 100, // Minimum Amount 100\n \"reference\": \"virtualnetwork1\"\n}\n
"},{"location":"Internet/Virtual-network/#regex-validation","title":"Regex Validation","text":"For the username parameter, the following regex validation applies:
\n[\n {\n \"name\": \"Username\",\n \"slug\": \"\",\n \"pattern\": \"([a-zA-Z0-9_]+)\",\n \"error_message\": \"Invalid Username\"\n }\n]\n
"},{"location":"Internet/Virtual-network/#response","title":"Response","text":"Upon successful operation, the API will return a response in the following format:
\n{\n \"status\": true,\n \"id\": 1266,\n \"credits_available\": 9200.0,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"credits_consumed\": 100.0\n}\n
"},{"location":"Internet/adsl/","title":"ADSL","text":""},{"location":"Internet/adsl/#overview","title":"Overview","text":"The ADSL API allows you to perform operations related to both Unlimited and Volume Based ADSL services. Depending on your choice, you can submit requests for ADSL services using the provided API endpoints. This API requires parameters such as a token, a unique reference, the amount, and the landline number to process the request.
"},{"location":"Internet/adsl/#type-single-step-api","title":"Type: Single Step API","text":""},{"location":"Internet/adsl/#url","title":"URL:","text":" - Unlimited:
{{base_url}}/api/use/adsl-ul/ - Volume Based:
{{base_url}}/api/use/adsl-vb/
"},{"location":"Internet/adsl/#service-params","title":"Service Params:","text":" - number: 8-digit number (area code without 0 and landline number), e.g., 15522942
- token: Your authentication token
- reference: A unique reference for the transaction
- amount: The amount to be processed
- number: The landline number in the required format
"},{"location":"Internet/adsl/#valid-amounts-for-both-unlimited-volume-based","title":"Valid Amounts for Both Unlimited & Volume Based:","text":" - 9 < Amount < 10001
"},{"location":"Internet/adsl/#regex","title":"Regex:","text":"\n[ \n { \n \"name\": \"LandLine\", \n \"slug\": \"\", \n \"pattern\": \"([0-9]{8})\", \n \"error_message\": \"Invalid LandLine number\" \n } \n]\n
"},{"location":"Internet/adsl/#request","title":"Request:","text":"\n{ \n \"token\": \"token-provided\", \n \"reference\": \"unique-reference\", \n \"amount\": \"amount\", \n \"number\": \"number\" \n}\n
"},{"location":"Internet/adsl/#response","title":"Response:","text":""},{"location":"Internet/adsl/#success-response","title":"Success Response:","text":"\n{ \n \"id\": 165, \n \"credits_consumed\": 10.0, \n \"status\": true, \n \"state\": \"Queued\", \n \"message\": \"Your operation has been submitted for processing.\", \n \"credits_available\": 1170 \n}\n
"},{"location":"Internet/adsl/#unsuccessful-response","title":"Unsuccessful Response:","text":"\n{ \n \"error_code\": \"1010\", \n \"message\": \"Validation error\", \n \"status\": false, \n \"error_data\": , \n \"details\": \"**\" \n}"},{"location":"Internet/adsl/#note","title":"Note:","text":"Check the status key in the response to verify the response. If status is false, there is an issue with the request, and you should correct it. If status is true, the request is successfully submitted but is subject to third-party provider processing. If the state is Queued, the request is being sent to the third-party provider, and you will receive an update on the final status (success or failure) via our DLR callback.
"},{"location":"Internet/adsl/#dlr-sample","title":"DLR Sample:","text":"\n{ \n \"reference\": \"Unique id sent by you\", \n \"amount\": \"amount\", \n \"status\": \"status\", \n \"detail\": \"detail regarding the service\" \n}\n
"},{"location":"Internet/airlink/","title":"Airlink Communication","text":"This document provides details for the Airlink Communication Single Step API, which is used for processing payments related to their services. It includes the request URL, method, parameters, and example responses.
Airlink is an ISP.
"},{"location":"Internet/airlink/#type-single-step-api","title":"Type: Single Step API","text":""},{"location":"Internet/airlink/#payment-api","title":"Payment API:","text":"Request URL: {{base_url}}/api/use/airlink-communication/
Request Method: POST
"},{"location":"Internet/airlink/#service-params","title":"Service Params:","text":"\n{\n \"token\": \"token\",\n \"mobile_number\": \"user-mobile-number\",\n \"username\": \"sashant\",\n \"address\": \"bhaktapur\",\n \"amount\": 10,\n \"reference\": \"unique reference\"\n}\n
"},{"location":"Internet/airlink/#response","title":"Response:","text":"\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 10.0,\n \"credits_available\": 9999767335.42,\n \"extra_data\": {\n \"mobile_number\": \"9843007232\",\n \"username\": \"sashant\",\n \"address\": \"bhaktapur\"\n },\n \"id\": 32438\n}\n
"},{"location":"Internet/arrownet/","title":"Arrownet","text":""},{"location":"Internet/arrownet/#87-arrownet","title":"8.7 Arrownet","text":""},{"location":"Internet/arrownet/#multi-step-api","title":"Multi-Step API","text":""},{"location":"Internet/arrownet/#1-user-details","title":"1. User Details","text":"URL: {{base_url}}/api/servicegroup/details/arrownet/
Service Params:
\n{\n \"token\": \"token-provided\",\n \"username\": \"username\"\n}\n
Request Example:
\n{\n \"token\": \"your_token_here\",\n \"username\": \"Pradhanang\"\n}\n
Response:
- Success:
\n{\n \"status\": true,\n \"plan_details\": [\n {\n \"duration\": 1,\n \"amount\": \"1695.00\"\n },\n {\n \"duration\": 3,\n \"amount\": \"5085.00\"\n },\n {\n \"duration\": 6,\n \"amount\": \"9492.00\"\n },\n {\n \"duration\": 12,\n \"amount\": \"17628.00\"\n }\n ],\n \"days_remaining\": 464,\n \"current_plan\": \"50Mbps\",\n \"accept_advance_payment\": true,\n \"has_due\": false,\n \"full_name\": \"Ashish Pradhanang - Home\"\n}\n
- Error:
Note: For all client errors, error_code is 4000.
\n{\n \"status\": false,\n \"message\": \"Can't fulfill request\",\n \"state\": \"Error\",\n \"error\": \"client_error\",\n \"details\": \"Username not found\",\n \"error_data\": {},\n \"error_code\": \"4000\"\n}\n
"},{"location":"Internet/arrownet/#2-arrownet-payment","title":"2. Arrownet Payment","text":"URL: {{base_url}}/api/servicegroup/commit/arrownet/
Service Params:
\n{\n \"username\": \"username\",\n \"amount\": \"amount\",\n \"duration\": \"1,3,6,12\", // According to Requirement\n \"reference\": \"unique value\",\n \"token\": \"token provided by khalti\"\n}\n
Request Example:
\n{\n \"username\": \"Pradhanang\",\n \"amount\": \"1695.00\",\n \"duration\": 1,\n \"reference\": \"unique_ref_123\",\n \"token\": \"your_token_here\"\n}\n
Response:
- Success:
\n{\n \"status\": true,\n \"message\": \"Successfully Completed Transaction\",\n \"detail\": \"Transaction successful\",\n \"extra_data\": {},\n \"state\": \"Success\",\n \"id\": 1440\n}\n
- Error:
\n{\n \"error_code\": \"1010\",\n \"message\": \"Validation error\",\n \"status\": false,\n \"error_data\": {\n // present for validation error (codes 1010, 1011) specifying errors corresponding to fields\n },\n \"details\": \"error details (string) for other errors\"\n}\n
"},{"location":"Internet/broadlink/","title":"Broadlink","text":"Introduction:
This documentation provides the APIs to fetch details and make payments for Broadlink internet users.
"},{"location":"Internet/broadlink/#broadlink-payment-types","title":"Broadlink Payment Types:","text":""},{"location":"Internet/broadlink/#outstanding-payment","title":"Outstanding Payment","text":"Users who inform Broadlink to activate their internet and generate an invoice for the payable amount. In this case, you will not find the \u201cpackages\u201d key in the response. Use the \u201camount\u201d key for payment and skip the getDiscount API before proceeding to the commit API.
- Example Customer ID: 53905
"},{"location":"Internet/broadlink/#package-payment","title":"Package Payment","text":"Users can choose a package. The \u201camount\u201d key in the detail API will be 0 in this case. Use the \u201cpackages\u201d key for package details and proceed to the checkDiscount API to get the final discounted amount.
- Example Customer ID: 47531
"},{"location":"Internet/broadlink/#1-broadlink-detail-fetch-api","title":"1. Broadlink Detail Fetch API","text":" - Request URL:
{{base_url}}/api/servicegroup/details/broadlink/ - Request Method: POST
"},{"location":"Internet/broadlink/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"customer_id\": 53905,\n \"reference\": \"Broadlink\"\n}\n
"},{"location":"Internet/broadlink/#response-for-outstanding-payment","title":"Response for Outstanding Payment","text":"\n{\n \"name\": \"sujansir home\",\n \"email\": \"sujan@broadlink.com\",\n \"mobile_no\": \"9801011844\",\n \"customer_id\": \"53905\",\n \"amount\": \"1129\",\n \"invoice_no\": \"343327\",\n \"session_id\": 5,\n \"status\": true\n}\n
"},{"location":"Internet/broadlink/#response-for-package-payment","title":"Response for Package Payment","text":"\n{\n \"name\": \"sujansir home\",\n \"mobile_no\": \"9801011844\",\n \"customer_id\": \"53905\",\n \"email\": \"sujan@broadlink.com\",\n \"amount\": 0,\n \"invoice_no\": 0,\n \"packages\": [\n {\n \"package\": \"Supernet 10 mbps@999 MID BasePlan\",\n \"package_id\": \"4\",\n \"package_sub_id\": \"4\",\n \"amount\": \"1129\"\n },\n {\n \"package\": \"Supernet 20 mbps@1499 KTM BasePlan\",\n \"package_id\": \"16\",\n \"package_sub_id\": \"16\",\n \"amount\": \"1694\"\n },\n {\n \"package\": \"Supernet 20 mbps@1499 KTM BasePlan\",\n \"package_id\": \"16\",\n \"package_sub_id\": \"258\",\n \"amount\": \"17684\"\n },\n {\n \"package\": \"Supernet 20 mbps@1499 KTM BasePlan\",\n \"package_id\": \"16\",\n \"package_sub_id\": \"259\",\n \"amount\": \"9553\"\n },\n {\n \"package\": \"Doen OLD 5mbps@599 EAST BasePlan\",\n \"package_id\": \"35\",\n \"package_sub_id\": \"35\",\n \"amount\": \"677\"\n },\n {\n \"package\": \"30 mbps Dhamaka - OV\",\n \"package_id\": \"158\",\n \"package_sub_id\": \"350\",\n \"amount\": \"13560\"\n },\n {\n \"package\": \"test icon\",\n \"package_id\": \"224\",\n \"package_sub_id\": \"528\",\n \"amount\": \"0\"\n }\n ],\n \"session_id\": 6,\n \"status\": true\n}\n
"},{"location":"Internet/broadlink/#2-broadlink-get-discount-api","title":"2. Broadlink Get Discount API","text":" - Request URL:
{{base_url}}/api/servicegroup/get_discounted_amount/broadlink/ - Request Method: POST
"},{"location":"Internet/broadlink/#service-params_1","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"session_id\": 5,\n \"package_id\": 4,\n \"package_sub_id\": 4\n}\n
"},{"location":"Internet/broadlink/#response","title":"Response","text":"\n{\n \"status\": true,\n \"detail\": {\n \"amount\": \"1129.00\",\n \"package\": \"Supernet 10 mbps@999 MID BasePlan\"\n }\n}\n
"},{"location":"Internet/broadlink/#3-broadlink-commit-api","title":"3. Broadlink Commit API","text":" - Request URL:
{{base_url}}/api/servicegroup/commit/broadlink/ - Request Method: POST
"},{"location":"Internet/broadlink/#service-params_2","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"session_id\": 5,\n \"amount\": 1129\n}\n
"},{"location":"Internet/broadlink/#response_1","title":"Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 1129.0,\n \"credits_available\": 95727.0,\n \"id\": 5373\n}\n
"},{"location":"Internet/chitrawan/","title":"Chitrawan Unique Net","text":"This document outlines the API for Chitrawan Unique Net services, including details about the service, the methods to request information, and the payment process. It includes the request URLs, methods, parameters, and example success responses for both service details and payment.
"},{"location":"Internet/chitrawan/#service-details-api","title":"Service Details API","text":"Request URL: {{base_url}}/api/servicegroup/details/chitrawan-unique-net/
Request Method: POST
"},{"location":"Internet/chitrawan/#request-params","title":"Request Params:","text":"\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"request_id\": \"khalti_test\"\n}\n
"},{"location":"Internet/chitrawan/#success-response","title":"Success Response:","text":"\n{\n \"amount\": 0,\n \"customer_name\": \"Khalti Test\",\n \"phone\": \"9800000000\",\n \"address\": \"Basnetgaun, Lalitpur-04, Lalitpur\",\n \"packages\": [\n {\n \"amount\": 1500,\n \"package_id\": 202,\n \"name\": \"100 mbps 1 month\"\n }\n ],\n \"session_id\": 26015,\n \"status\": true\n}\n
"},{"location":"Internet/chitrawan/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/chitrawan-unique-net/
Request Method: POST
"},{"location":"Internet/chitrawan/#request-params_1","title":"Request Params:","text":"\n{\n \"reference\": \"{{$guid}}\",\n \"token\": \"{{token}}\",\n \"session_id\": {{session_id}},\n \"package_id\": {{package_id}},\n \"amount\": {{package_amount}}\n}\n
"},{"location":"Internet/chitrawan/#success-response_1","title":"Success Response:","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"SUCCESS\",\n \"credits_consumed\": 1500,\n \"credits_available\": 999999997280694,\n \"id\": 126362\n}\n
"},{"location":"Internet/classictech/","title":"Classic Tech","text":""},{"location":"Internet/classictech/#overview","title":"Overview","text":"The Classic Tech API provides two main endpoints to manage user details and process payments:
- User Detail API: Retrieves details about a user's available plans and session information.
- Payment API: Commits a payment using the details obtained from the User Detail API.
"},{"location":"Internet/classictech/#user-detail-api","title":"User Detail API","text":"URL: {{base_url}}/api/servicegroup/details/classictech-isp/
METHOD: POST
Service Params:
\n{\n \"token\": \"provided_token\",\n \"reference\": \"unique reference id\",\n \"username\": \"classitech_username, e.g., ctdeveloper\"\n}\n
Response:
"},{"location":"Internet/classictech/#success","title":"Success","text":"\n{\n \"status\": true,\n \"token\": \"d95f1f947faf32d131c01a6e77d75938\",\n \"session_id\": 8,\n \"available_plans\": [\n {\n \"package\": \"Classic-30Mbps\",\n \"duration\": \"1\",\n \"amount\": 1695\n },\n {\n \"package\": \"Classic-30Mbps\",\n \"duration\": \"3\",\n \"amount\": 4403.61\n },\n {\n \"package\": \"Classic-30Mbps\",\n \"duration\": \"15\",\n \"amount\": 12430\n }\n ]\n}\n
"},{"location":"Internet/classictech/#payment-api","title":"Payment API","text":"URL: {{base_url}}/api/servicegroup/commit/classictech-isp/
METHOD: POST
Service Params:
\n{\n \"token\": \"\",\n \"session_id\": \"\",\n \"plan_id\": \"\"\n}\n\n\nSample Response:
"},{"location":"Internet/classictech/#success-response","title":"Success Response","text":"\n{\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"status\": true,\n \"id\": 2420\n}\n
"},{"location":"Internet/dishhome/","title":"Dish Home API","text":"Dishhome is a TV/ISP payment service that allows users to pay for various services, including regular recharges, Dishhome FTTH (ISP), Dishhome combos, and special offers. This API consists of two main endpoints for fetching service details and processing payments.
"},{"location":"Internet/dishhome/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Internet/dishhome/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"This endpoint retrieves detailed information about the user's Dish Home package.
"},{"location":"Internet/dishhome/#request","title":"Request","text":" - Request URL:
{{base_url}}/api/servicegroup/details/dishhome-updated/ - Request Method:
POST - Service Params:
\n{\n \"token\": \"token\",\n \"customer_id\": \"customer_id\",\n \"reference\": \"unique reference\"\n}\n
"},{"location":"Internet/dishhome/#response","title":"Response","text":"The response includes various details about the customer's package, including available recharge options.
\n{\n \"response_code\": 200,\n \"package\": \"Basic Package\",\n \"quantity\": 1,\n \"expiry_date\": \"2037-11-28T11:15:00\",\n \"zone\": \"Mid-West | Bheri Zone\",\n \"district\": \"Surkhet\",\n \"customer_type\": \"House\",\n \"customer_status\": \"Prepaid On\",\n \"customer_id\": 1111,\n \"customer_class\": \"1-Residential\",\n \"isp_customer_id\": \"\",\n \"yearly_price\": 4800.0,\n \"packages\": [\n {\n \"description\": \"1 Month\",\n \"price\": 400.0,\n \"duration_type\": 1,\n \"bonus\": 0.0,\n \"is_regular\": false,\n \"idx\": 1\n },\n {\n \"description\": \"3 Months\",\n \"price\": 1200.0,\n \"duration_type\": 3,\n \"bonus\": 400.0,\n \"is_regular\": false,\n \"idx\": 2\n },\n {\n \"description\": \"6 Months\",\n \"price\": 2399.0,\n \"duration_type\": 6,\n \"bonus\": 1201.0,\n \"is_regular\": false,\n \"idx\": 3\n },\n {\n \"description\": \"12 Months\",\n \"price\": 4800.0,\n \"duration_type\": 12,\n \"bonus\": 4800.0,\n \"is_regular\": false,\n \"idx\": 4\n },\n {\n \"description\": \"Regular\",\n \"price\": 2000.0,\n \"duration_type\": 0,\n \"bonus\": 400.0,\n \"is_regular\": true,\n \"idx\": 5\n },\n {\n \"description\": \"Regular\",\n \"price\": 1000.0,\n \"duration_type\": 0,\n \"bonus\": 100.0,\n \"is_regular\": true,\n \"idx\": 6\n },\n {\n \"description\": \"Regular\",\n \"price\": 700.0,\n \"duration_type\": 0,\n \"bonus\": 35.0,\n \"is_regular\": true,\n \"idx\": 7\n },\n {\n \"description\": \"Regular\",\n \"price\": 600.0,\n \"duration_type\": 0,\n \"bonus\": 30.0,\n \"is_regular\": true,\n \"idx\": 8\n },\n {\n \"description\": \"Regular\",\n \"price\": 500.0,\n \"duration_type\": 0,\n \"bonus\": 25.0,\n \"is_regular\": true,\n \"idx\": 9\n }\n ],\n \"session_id\": 20520,\n \"status\": true\n}\n
"},{"location":"Internet/dishhome/#2-payment-api","title":"2. Payment API","text":"This endpoint processes the payment for the selected Dish Home package.
"},{"location":"Internet/dishhome/#request_1","title":"Request","text":" - Request URL:
{{base_url}}/api/servicegroup/commit/dishhome-updated/ - Request Method:
POST - Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"\\ session_id\\ \",\n \"package_id\": \"\\ idx\\ \"\n}\n
"},{"location":"Internet/dishhome/#response_1","title":"Response","text":"The response provides details about the transaction status, including updated balance and transaction ID.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": {\n \"response_code\": 200,\n \"response_description\": \"Successfully Recharged\",\n \"updated_balance\": -1591.5836,\n \"expiry_date\": \"2024-06-14T11:15:00\",\n \"customer_status\": \"Active\",\n \"transaction_id\": 140251146,\n \"recharged_amount\": 500,\n \"is_bonus_added\": true\n },\n \"credits_consumed\": 500,\n \"credits_available\": 19987322608.1098,\n \"id\": 109657\n}\n
"},{"location":"Internet/dolfin-internet/","title":"Dolfin Internet","text":"This document provides the necessary information for interacting with the Dolfin Internet service APIs, detailing the required parameters and expected responses for both fetching details and processing payments.
"},{"location":"Internet/dolfin-internet/#detail-fetch-api","title":"Detail Fetch API","text":" - Request URL:
{{base_url}}/api/servicegroup/details/dolfin-net-communication/ - Request Method: POST
"},{"location":"Internet/dolfin-internet/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"reference\": \"{{$guid}}\",\n \"user\": \"user1\"\n}\n
"},{"location":"Internet/dolfin-internet/#response-example","title":"Response Example","text":"\n{\n \"customer_name\": \"K.PATRA\",\n \"bill_date\": \"17 May, 2024\",\n \"invoice_number\": \"4494fd025d3b367ebfa1\",\n \"partner_code\": \"ARCR1RVPMU6HVNTA6Q\",\n \"due_date\": \"26 Oct, 2024\",\n \"bill_period\": \"MONTHLY\",\n \"packages\": [\n {\n \"id\": 630,\n \"name\": \"50Mbps_1 Month (FUP) [Rs. 850] 1 Month\",\n \"price\": 50\n },\n {\n \"id\": 631,\n \"name\": \"120Mbps_1 Month (FUP) [Rs. 1230] 1 Month\",\n \"price\": 50\n },\n {\n \"id\": 914,\n \"name\": \"80Mbps_1 Month (FUP) [Rs. 1080] 1 Month\",\n \"price\": 50\n },\n {\n \"id\": 915,\n \"name\": \"200Mbps_1 Month (FUP) [Rs. 1480] 1 Month\",\n \"price\": 50\n },\n {\n \"id\": 916,\n \"name\": \"300Mbps_1 Month (FUP) [Rs. 1875] 1 Month\",\n \"price\": 50\n },\n {\n \"id\": 1051,\n \"name\": \"25Mbps_Unlimited_FUP 1 Month\",\n \"price\": 50\n },\n {\n \"id\": 1184,\n \"name\": \"50Mbps_3 Months (FUP) [Rs. 2000] 3 Months\",\n \"price\": 50\n },\n {\n \"id\": 1185,\n \"name\": \"80Mbps_3 Months (FUP) [Rs. 2300] 3 Months\",\n \"price\": 50\n },\n {\n \"id\": 1186,\n \"name\": \"120Mbps_3 Months (FUP) [Rs. 2700] 3 Months\",\n \"price\": 50\n },\n {\n \"id\": 1188,\n \"name\": \"50Mbps_12 Months (FUP) [Rs. 7500] 12 Months\",\n \"price\": 50\n },\n {\n \"id\": 1189,\n \"name\": \"80Mbps_12 Months (FUP) [Rs. 9000] 12 Months\",\n \"price\": 50\n },\n {\n \"id\": 1190,\n \"name\": \"120Mbps_12 Months (FUP) [Rs. 10000] 12 Months\",\n \"price\": 50\n }\n ],\n \"amount\": 50,\n \"session_id\": 23100,\n \"status\": true\n}\n
"},{"location":"Internet/dolfin-internet/#payment-api","title":"Payment API","text":" - Request URL:
{{base_url}}/api/servicegroup/commit/dolfin-net-communication/ - Request Method: POST
"},{"location":"Internet/dolfin-internet/#service-params_1","title":"Service Params","text":"\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"package_id\": \"package_id\",\n \"session_id\": \"session_id\"\n}\n
"},{"location":"Internet/dolfin-internet/#response-example_1","title":"Response Example","text":"\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 1100.0,\n \"credits_available\": 102009144.984999,\n \"extra_data\": {\n \"username\": \"joker_a\",\n \"mobile_number\": \"9818822421\",\n \"package\": \"20Mbps - 1 Month\",\n \"branch\": \"Saljhandi\"\n },\n \"id\": 18806\n}\n
"},{"location":"Internet/eastlink/","title":"East Link API","text":""},{"location":"Internet/eastlink/#overview","title":"Overview","text":"The East Link API allows users to initiate a transaction by submitting a POST request. This API requires user authentication through a token and supports transactions with specified parameters, such as the username, mobile number, amount, and a reference. The API response indicates the status of the operation and provides information about credits available and consumed.
"},{"location":"Internet/eastlink/#api-details","title":"API Details","text":" - Type: Single Step API
- URL:
{{base_url}}/api/use/eastlink/ - Method: POST
"},{"location":"Internet/eastlink/#service-parameters","title":"Service Parameters","text":"To make a request, send the following JSON object in the body of your POST request:
\n{\n \"token\": \"token\",\n \"username\": \"Username, eg: khaltiUser\",\n \"mobile_number\": \"9818766122\",\n \"amount\": 100, // Minimum Amount 100\n \"reference\": \"eastlink1\"\n}\n
"},{"location":"Internet/eastlink/#response-format","title":"Response Format","text":"Upon a successful request, the API will return a response in the following format:
\n{\n \"status\": true,\n \"id\": 1256,\n \"credits_available\": 9700.0,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"credits_consumed\": 100.0\n}\n
"},{"location":"Internet/eastlink/#response-fields","title":"Response Fields","text":" - status: Indicates if the request was successful (true/false).
- id: A unique identifier for the transaction.
- credits_available: The remaining credits available after the transaction.
- message: A message indicating the state of the transaction.
- state: The current state of the transaction (e.g., \"Queued\").
- credits_consumed: The amount of credits used for the transaction.
"},{"location":"Internet/eastlink/#conclusion","title":"Conclusion","text":"The East Link API is designed for easy and efficient transaction processing, providing necessary information for user account management and real-time updates on transaction status.
"},{"location":"Internet/first-link/","title":"First Link","text":"This document outlines the API for First Link, which includes functionalities for retrieving user details, getting package rates, and processing payments. It includes request URLs, methods, parameters, and example responses for each API.
"},{"location":"Internet/first-link/#user-detail-api","title":"User Detail API","text":"Request URL: {{base_url}}/api/servicegroup/details/firstlink/
Request Method: POST
"},{"location":"Internet/first-link/#service-params","title":"Service Params:","text":"\n{ \n \"token\": \"{{token}}\", \n \"reference\": \"{{$guid}}\", \n \"username\": \"url_ramesh_kafle\"\n}\n
"},{"location":"Internet/first-link/#response","title":"Response:","text":"\n{ \n \"email\": \"ramesh@firstlink.net.np\", \n \"user_identifier\": \"2\", \n \"session_id\": 55, \n \"status\": true \n}\n
"},{"location":"Internet/first-link/#get-packages-api","title":"Get Packages API","text":"Request URL: {{base_url}}/api/servicegroup/getpackagerates/firstlink/
Request Method: POST
"},{"location":"Internet/first-link/#service-params_1","title":"Service Params:","text":"\n{ \n \"token\": \"{{token}}\", \n \"session_id\": 55 \n}\n
"},{"location":"Internet/first-link/#response_1","title":"Response:","text":"\n{ \n \"active_internet_services\": [ \n { \n \"mac\": \"A4BE2BB9926C\", \n \"description\": \"Fiberhome 40Mbps-1Month\", \n \"status\": \"active\", \n \"unit_price\": \"1921.0000\" \n } \n ], \n \"tariff\": { \n \"title\": \"Fiberhome 40Mbps-1Month\", \n \"service_name\": \"Fiberhome 40Mbps-1Month\", \n \"billing_days_count\": \"30\" \n }, \n \"session_id\": 55, \n \"status\": true \n}\n
"},{"location":"Internet/first-link/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/firstlink/
Request Method: POST
"},{"location":"Internet/first-link/#service-params_2","title":"Service Params:","text":"\n{ \n \"token\": \"{{token}}\", \n \"amount\": 1921, \n \"session_id\": 4, \n \"comment\": \"Optional\" \n}\n
"},{"location":"Internet/first-link/#response_2","title":"Response:","text":"\n{ \n \"status\": true, \n \"state\": \"Queued\", \n \"detail\": \"Transaction Queued [Exception in Payment]\", \n \"message\": \"Your operation is in queue.\", \n \"credits_consumed\": 1921.0, \n \"credits_available\": \"**********\", \n \"extra_data\": {}, \n \"id\": 20276 \n}\n
"},{"location":"Internet/grs-internet/","title":"GRS Internet","text":"GRS Internet is an ISP.
Type: Multi Step API
"},{"location":"Internet/grs-internet/#1-detail-fetch-api","title":"1. Detail Fetch API","text":" - Request URL:
{{base_url}}/api/servicegroup/details/grs/ - Request Method: POST
"},{"location":"Internet/grs-internet/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"username\": \"blya-test\",\n \"reference\": \"unique reference\"\n}\n
"},{"location":"Internet/grs-internet/#response","title":"Response","text":"\n{\n \"username\": \"blya-test\",\n \"address\": \"Ganeshpur\",\n \"package\": [\n {\n \"package_id\": \"1\",\n \"package_name\": \"10Mbps\",\n \"amount\": 1000.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"2\",\n \"package_name\": \"20Mbps\",\n \"amount\": 1150.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"3\",\n \"package_name\": \"25Mbps\",\n \"amount\": 1150.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"4\",\n \"package_name\": \"40Mbps\",\n \"amount\": 1650.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"5\",\n \"package_name\": \"60Mbps\",\n \"amount\": 1800.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"6\",\n \"package_name\": \"30Mbps\",\n \"amount\": 1250.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"7\",\n \"package_name\": \"15Mbps\",\n \"amount\": 1050.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"8\",\n \"package_name\": \"100Mbps\",\n \"amount\": 2550.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"9\",\n \"package_name\": \"50Mbps\",\n \"amount\": 1750.0,\n \"valid_days\": \"30\"\n }\n ],\n \"session_id\": 4603,\n \"status\": true\n}\n
"},{"location":"Internet/grs-internet/#2-payment-api","title":"2. Payment API","text":" - Request URL:
{{base_url}}/api/servicegroup/commit/grs/ - Request Method: POST
"},{"location":"Internet/grs-internet/#service-params_1","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"package_id\": \"\\ Obtained from detail fetch API\\ \",\n \"session_id\": \"\\ Obtained from detail fetch API\\ \",\n \"amount\": \"\\ Obtained from detail fetch API\\ \",\n \"reference\": \"\\ unique reference\\ \"\n}\n
"},{"location":"Internet/grs-internet/#response_1","title":"Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 300.0,\n \"credits_available\": 9999711067.15,\n \"id\": 34081\n}\n
This document outlines the APIs for fetching user details and processing payments for GRS Internet services.
"},{"location":"Internet/infonet/","title":"Infonet Communication API","text":""},{"location":"Internet/infonet/#overview","title":"Overview","text":"The Infonet Communication API enables users to process communication service transactions. By sending a POST request with the required parameters, users can manage their communication services effectively. The API provides a status update on the transaction and the remaining credits.
"},{"location":"Internet/infonet/#api-details","title":"API Details","text":" - Type: Single Step API
- Test URL: {{base_url}}/api/use/infonet-communication/
- Method: POST
"},{"location":"Internet/infonet/#service-parameters","title":"Service Parameters","text":"To make a request, send the following JSON object in the body of your POST request:
\n{\n \"token\": \"token\",\n \"username\": \"Username, eg: khaltiUser\",\n \"number\": \"9818766122\",\n \"amount\": 100, // Minimum Amount 100, Max: 50,000\n \"address\": \"kathmandu\",\n \"reference\": \"infonetcommunication1\"\n}\n
"},{"location":"Internet/infonet/#response-format","title":"Response Format","text":"Upon a successful request, the API will return a response in the following format:
\n{\n \"status\": true,\n \"id\": 1259,\n \"credits_available\": 9400.0,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"credits_consumed\": 100.0\n}\n
"},{"location":"Internet/infonet/#response-fields","title":"Response Fields","text":" - status: Indicates if the request was successful (true/false).
- id: A unique identifier for the transaction.
- credits_available: The remaining credits available after the transaction.
- message: A message indicating the state of the transaction.
- state: The current state of the transaction (e.g., \"Queued\").
- credits_consumed: The amount of credits used for the transaction.
"},{"location":"Internet/infonet/#conclusion","title":"Conclusion","text":"The Infonet Communication API streamlines the process of managing communication services, providing users with essential updates and ensuring efficient transaction handling.
"},{"location":"Internet/konnect/","title":"Konnect (KCMS)","text":"Note: Below is the list of ISPs under KCMS and their service slugs:
"},{"location":"Internet/konnect/#izone-izone","title":"Izone: izone","text":""},{"location":"Internet/konnect/#world-fiber-net-world-fiber-net","title":"World Fiber Net: world-fiber-net","text":""},{"location":"Internet/konnect/#dg-link-dg-link","title":"DG Link: dg-link","text":""},{"location":"Internet/konnect/#loop-network-loop-network","title":"Loop Network: loop-network","text":""},{"location":"Internet/konnect/#acme-internet-acme-internet","title":"Acme Internet: acme-internet","text":""},{"location":"Internet/konnect/#chitrawan-unique-net-chitrawan-unique-net-has-been-shifted-in-chitrawan","title":"Chitrawan Unique Net: chitrawan-unique-net (has been Shifted in Chitrawan)","text":"Type: Multi-Step API
"},{"location":"Internet/konnect/#test-username","title":"Test Username:","text":"There are 3 different types of users. New users cannot make online payments:
- New
- Active
- Expired
"},{"location":"Internet/konnect/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/konnect/
Request Method: POST
Service Slug: service_slug
Service Parameters:
\n{\n \"token\": \"token\",\n \"username\": \"username\",\n \"reference\": \"unique_reference\",\n \"service_slug\": \"service_slug\" // e.g., izone, world-fiber-net, etc.\n}\n
Responses:
- Response for username: new
\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"This customer's first subscription payment cannot be paid online. Please contact the nearest office.\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
- Response for username: active
\n{\n \"customer\": {\n \"username\": \"9779869045195\",\n \"name\": \"Chandra Mani Neupane\",\n \"mobile\": \"9869045195\",\n \"status\": \"Active\"\n },\n \"current_subscription\": {\n \"package\": \"Fiber Internet (First Installation 20Mbps Home)\",\n \"end_date\": \"2021-04-30\",\n \"status\": \"Active\"\n },\n \"due\": {\n \"amount\": \"0.00000\",\n \"message\": \"Due Amount is NIL\"\n },\n \"packages\": [\n {\n \"package_id\": \"1-13286-5-3\",\n \"package_name\": \"Fiber Internet (First Installation) - 3 Month(s)\",\n \"amount\": 5999,\n \"current\": true\n },\n {\n \"package_id\": \"1-13286-5-12\",\n \"package_name\": \"Fiber Internet (First Installation) - 12 Month(s)\",\n \"amount\": 15500,\n \"current\": false\n }\n ],\n \"session_id\": 179,\n \"status\": true\n}\n
- Response for username: expired
\n{\n \"customer\": {\n \"username\": \"9779803074977\",\n \"name\": \"koshish bortaula\",\n \"mobile\": \"\",\n \"status\": \"Expired\"\n },\n \"current_subscription\": {\n \"package\": \"NET+TV - 30Mbps\",\n \"end_date\": \"2021-01-31\",\n \"status\": \"Expired\"\n },\n \"due\": {\n \"amount\": \"0\",\n \"message\": \"Due Amount is NIL\"\n },\n \"packages\": [\n {\n \"package_id\": \"1-4412-8-1\",\n \"package_name\": \"NET+TV - 30Mbps - 1 Month(s)\",\n \"amount\": 1850,\n \"current\": false\n },\n {\n \"package_id\": \"1-4412-8-3\",\n \"package_name\": \"NET+TV - 30Mbps - 3 Month(s)\",\n \"amount\": 5550,\n \"current\": false\n },\n {\n \"package_id\": \"1-4412-8-6\",\n \"package_name\": \"NET+TV - 30Mbps - 6 Month(s)\",\n \"amount\": 9250,\n \"current\": false\n },\n {\n \"package_id\": \"1-4412-8-12\",\n \"package_name\": \"NET+TV - 30Mbps - 12 Month(s)\",\n \"amount\": 18500,\n \"current\": true\n }\n ],\n \"session_id\": 180,\n \"status\": true\n}\n
"},{"location":"Internet/konnect/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/konnect/
Request Method: POST
Service Parameters:
\n{\n \"token\": \"token\",\n \"reference\": \"unique reference\",\n \"package_id\": \"package id of selected package\",\n \"amount\": \"amount of selected package\",\n \"session_id\": \"obtained from previous API\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Payment made successfully. Account will be activated in few minutes\",\n \"credits_consumed\": 5999.0,\n \"credits_available\": 9998.37,\n \"id\": 74020\n}\n
"},{"location":"Internet/kriti-darshan/","title":"Kriti Darshan","text":"This document provides details for the Kriti Darshan Single Step API, including the request URL, method, parameters, and example responses. The API allows users to initiate transactions and provides feedback on the status of those transactions. Single Step API
Request URL: {{base_url}}/api/use/kriti-darshan/
Request Method: POST
"},{"location":"Internet/kriti-darshan/#service-params","title":"Service Params:","text":"\n{ \n \"full_name\": \"udeep shrestha\", \n \"amount\": 2000, \n \"token\": \"{{LIVE_TOKEN}}\", \n \"reference\": \"{{$guid}}\", \n \"address\": \"Madhyapur Thimi\", \n \"mobile_number\": \"016632588\" \n}\n
Response:
\n{ \n \"status\": true, \n \"state\": \"Queued\", \n \"detail\": \"Transaction Queued\", \n \"message\": \"Your operation is in queue.\", \n \"credits_consumed\": 2000.0, \n \"credits_available\": 101194530.874999, \n \"extra_data\": { \n \"full_name\": \"udeep shrestha\", \n \"address\": \"Madhyapur Thimi\", \n \"mobile_number\": \"016632588\" \n }, \n \"id\": 20270 \n}\n
"},{"location":"Internet/merosoft/","title":"Merosoft","text":""},{"location":"Internet/merosoft/#overview","title":"Overview","text":"Merosoft provides various Internet Service Providers (ISPs) along with their respective service slugs. Below is the list of ISPs under Merosoft:
"},{"location":"Internet/merosoft/#isps-and-their-service-slugs","title":"ISPs and Their Service Slugs","text":" - Meta Link:
metalink - Prime Network:
prime-network - Alisha Communication:
alisha-communication - Smart Link:
smart-link - PDS Server Network:
pds-server-network
"},{"location":"Internet/merosoft/#api-details","title":"API Details","text":"Merosoft offers a multi-step API to fetch details and process payments for the services.
"},{"location":"Internet/merosoft/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/merosoft/
Request Method: POST
Service Parameters:
\n{\n \"token\": \"token\",\n \"reference\": \"unique reference\",\n \"Username\": \"kiran\",\n \"service_slug\": \"service_slug\" // service_slug of respective ISP, e.g., prime-network, metalink, alisha-communication\n}\n
Response:
\n{\n \"customer_name\": \"Kiran Shrestha\",\n \"remaining_days\": \"2781 days\",\n \"expiry_date\": \"2029-07-26\",\n \"active_package\": \"Basic for 1 month\",\n \"packages\": [\n {\n \"id\": 9,\n \"name\": \"Basic for 1 month\",\n \"price\": 1150\n },\n {\n \"id\": 13,\n \"name\": \"Advanced for 1 month\",\n \"price\": 1700\n },\n {\n \"id\": 21,\n \"name\": \"Extreme for 1 month\",\n \"price\": 2300\n }\n ],\n \"session_id\": 22,\n \"status\": true\n}\n
"},{"location":"Internet/merosoft/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/merosoft/
Request Method: POST
Service Parameters:
\n{\n \"token\": \"token\",\n \"reference\": \"unique reference\",\n \"username\": \"kiran\",\n \"service_slug\": \"service_slug\",\n \"package_id\": 9,\n \"package_name\": \"Basic for 1 month\",\n \"amount\": 1150,\n \"session_id\": 1\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Recharged Successfully\",\n \"credits_consumed\": 1150.0,\n \"credits_available\": 9999919624.3,\n \"id\": 29256\n}\n
"},{"location":"Internet/metrolink/","title":"Metrolink Internet","text":"Type: Single Step API
Test URL: {{base_url}}/api/use/metrolink/
Method: POST
Service Parameters:
\n{\n \"token\": \"token\",\n \"username\": \"Username, eg: khaltiUser\",\n \"number\": \"9818766122\",\n \"amount\": 100, // Minimum Amount 100, Max: 50,000\n \"address\": \"Banepa\",\n \"reference\": \"metrolink1\"\n}\n
Response:
\n{\n \"status\": true,\n \"id\": 1260,\n \"credits_available\": 9300.0,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"credits_consumed\": 100.0\n}\n
"},{"location":"Internet/netmax/","title":"Net Max Service","text":""},{"location":"Internet/netmax/#overview","title":"Overview","text":"An overview of the Net Max service APIs, including details on how to fetch customer subscription information and process payments. It covers the necessary request parameters, expected responses, and notes for handling dues.
"},{"location":"Internet/netmax/#fetch-api","title":"Fetch API","text":""},{"location":"Internet/netmax/#detail-fetch-api","title":"Detail Fetch API","text":" - Request URL:
{{base_url}}/api/servicegroup/details/net-max/ - Request Method: POST
"},{"location":"Internet/netmax/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"username\": \"new/active/expired\",\n \"reference\": \"Unique reference\"\n}\n
"},{"location":"Internet/netmax/#response-example","title":"Response Example","text":"\n{\n \"customer\": {\n \"username\": \"9779803074977\",\n \"name\": \"koshish bortaula\",\n \"mobile\": \"\",\n \"status\": \"Expired\"\n },\n \"current_subscription\": {\n \"package\": \"NET+TV - 30Mbps\",\n \"end_date\": \"2021-01-31\",\n \"status\": \"Expired\"\n },\n \"due\": {\n \"amount\": \"0\",\n \"message\": \"Due Amount is NIL\"\n },\n \"packages\": [\n {\n \"package_id\": \"1-4412-8-1\",\n \"package_name\": \"NET+TV - 30Mbps - 1 Month(s)\",\n \"amount\": 1850,\n \"current\": false\n },\n {\n \"package_id\": \"1-4412-8-3\",\n \"package_name\": \"NET+TV - 30Mbps - 3 Month(s)\",\n \"amount\": 5550,\n \"current\": false\n },\n {\n \"package_id\": \"1-4412-8-6\",\n \"package_name\": \"NET+TV - 30Mbps - 6 Month(s)\",\n \"amount\": 9250,\n \"current\": false\n },\n {\n \"package_id\": \"1-4412-8-12\",\n \"package_name\": \"NET+TV - 30Mbps - 12 Month(s)\",\n \"amount\": 18500,\n \"current\": true\n }\n ],\n \"session_id\": 8,\n \"status\": true\n}\n
Note: If there is a due amount, it will be displayed separately without summing it with the package amount. Package amounts may vary for different users if there are dues.
"},{"location":"Internet/netmax/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/net-max/ Request Method: POST
"},{"location":"Internet/netmax/#service-params_1","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"package_id\": \"1-4412-8-1\",\n \"amount\": \"1850\",\n \"session_id\": \"8\",\n \"reference\": \"Unique reference\"\n}\n
"},{"location":"Internet/netmax/#response-example_1","title":"Response Example","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Payment made successfully. Account will be activated in few minutes\",\n \"credits_consumed\": 1850.0,\n \"credits_available\": 986190.0,\n \"id\": 60959\n}\n
"},{"location":"Internet/nijgad_cable/","title":"Nijgad Cable API","text":""},{"location":"Internet/nijgad_cable/#1-for-cable-tv","title":"1. FOR CABLE TV","text":""},{"location":"Internet/nijgad_cable/#fetch-tv-package-api","title":"Fetch TV Package API","text":" - Request URL:
{{base_url}}/api/servicegroup/getpackages/nijgadh-cable/ - Request Method: POST
"},{"location":"Internet/nijgad_cable/#service-parameters","title":"Service Parameters","text":"To fetch available TV packages, send the following JSON object:
\n{\n \"token\": \"token\",\n \"type\": \"tv\"\n}\n
"},{"location":"Internet/nijgad_cable/#response-format","title":"Response Format","text":"The response will be in the following format:
\n{\n \"status\": true,\n \"detail\": {\n \"packages\": [\n {\n \"package_name\": \"Basic TV Package - 1Month\",\n \"amount\": 325\n },\n {\n \"package_name\": \"Basic TV Package - 3Month\",\n \"amount\": 975\n },\n {\n \"package_name\": \"Basic TV Package - 6Month\",\n \"amount\": 1550\n },\n {\n \"package_name\": \"Basic TV Package - 1Year\",\n \"amount\": 3000\n },\n {\n \"package_name\": \"HD TV Package - 1Month\",\n \"amount\": 525\n },\n {\n \"package_name\": \"HD TV Package - 3Month\",\n \"amount\": 1075\n },\n {\n \"package_name\": \"HD TV Package - 6Month\",\n \"amount\": 2575\n },\n {\n \"package_name\": \"HD TV Package - 1Year\",\n \"amount\": 5075\n }\n ]\n }\n}\n
"},{"location":"Internet/nijgad_cable/#tv-payment-api","title":"TV Payment API","text":" - Request URL:
{{base_url}}/api/use/nijgadh-cable/ - Request Method: POST
"},{"location":"Internet/nijgad_cable/#service-parameters_1","title":"Service Parameters","text":"To make a payment for the selected TV package, send the following JSON object:
\n{\n \"token\": \"token\",\n \"reference\": \"reference123\",\n \"username\": \"khaltiUser\",\n \"full_name\": \"Khalti User\",\n \"mobile_number\": \"9841xxxxxx\",\n \"package\": \"HD Plus Child TV Package - 1Year\", // from detail API\n \"amount\": 8000,\n \"tv_identifier\": \"132465\" // Should be cas_id(6 digit), box_number(10 digits), or smart_card_number(12)\n}\n
"},{"location":"Internet/nijgad_cable/#response-format_1","title":"Response Format","text":"Upon a successful transaction, the API will return the following response:
\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 8000.0,\n \"credits_available\": 96688310.0450002,\n \"extra_data\": {},\n \"id\": 7515\n}\n
"},{"location":"Internet/nijgad_cable/#2-for-internet","title":"2. FOR INTERNET","text":""},{"location":"Internet/nijgad_cable/#fetch-internet-package-api","title":"Fetch Internet Package API","text":" - Request URL:
{{base_url}}/api/servicegroup/getpackages/nijgadh-cable/ - Request Method: POST
"},{"location":"Internet/nijgad_cable/#service-parameters_2","title":"Service Parameters","text":"To fetch available internet packages, send the following JSON object:
\n{\n \"token\": \"token\",\n \"type\": \"internet\"\n}\n
"},{"location":"Internet/nijgad_cable/#response-format_2","title":"Response Format","text":"The response will be in the following format:
\n{\n \"status\": true,\n \"detail\": {\n \"packages\": [\n {\n \"package_name\": \"Internet Package - 1Month 20Mbps\",\n \"amount\": 1150\n },\n {\n \"package_name\": \"Internet Package - 3Month 20Mbps\",\n \"amount\": 3150\n },\n {\n \"package_name\": \"Internet Package - 6Month 20Mbps\",\n \"amount\": 7015\n },\n {\n \"package_name\": \"Internet Package - 12Month 20Mbps\",\n \"amount\": 12600\n },\n {\n \"package_name\": \"Internet Package - 1Month 30Mbps\",\n \"amount\": 1375\n },\n {\n \"package_name\": \"Internet Package - 3Month 30Mbps\",\n \"amount\": 3945\n },\n {\n \"package_name\": \"Internet Package - 6Month 30Mbps\",\n \"amount\": 7530\n },\n {\n \"package_name\": \"Internet Package - 12Month 30Mbps\",\n \"amount\": 13635\n },\n {\n \"package_name\": \"Internet Package - 1Month 40Mbps\",\n \"amount\": 1615\n },\n {\n \"package_name\": \"Internet Package - 3Month 40Mbps\",\n \"amount\": 4655\n },\n {\n \"package_name\": \"Internet Package - 6Month 40Mbps\",\n \"amount\": 8955\n },\n {\n \"package_name\": \"Internet Package - 12Month 40Mbps\",\n \"amount\": 16480\n },\n {\n \"package_name\": \"Internet Package - 1Month 75Mbps\",\n \"amount\": 2446\n },\n {\n \"package_name\": \"Internet Package - 3Month 75Mbps\",\n \"amount\": 7150\n },\n {\n \"package_name\": \"Internet Package - 6Month 75Mbps\",\n \"amount\": 13615\n },\n {\n \"package_name\": \"Internet Package - 12Month 75Mbps\",\n \"amount\": 26450\n }\n ]\n }\n}\n
"},{"location":"Internet/nijgad_cable/#internet-payment-api","title":"Internet Payment API","text":" - Request URL:
{{base_url}}/api/use/nijgadh-cable/ - Request Method: POST
"},{"location":"Internet/nijgad_cable/#service-parameters_3","title":"Service Parameters","text":"To make a payment for the selected internet package, send the following JSON object:
\n{\n \"token\": \"token\",\n \"reference\": \"reference123\",\n \"user_id\": \"khaltiUser\",\n \"name\": \"Khalti User\",\n \"mobile_number\": \"9841xxxxxx\",\n \"package\": \"Internet Package - 12Month 75Mbps\", // from detail API\n \"amount\": 26450\n}\n
"},{"location":"Internet/nijgad_cable/#response-format_3","title":"Response Format","text":"Upon a successful transaction, the API will return the following response:
\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 26450.0,\n \"credits_available\": 96688310.0450002,\n \"extra_data\": {},\n \"id\": 7515\n}\n
"},{"location":"Internet/ntftth/","title":"NT FTTH","text":"Type: Single Step API
"},{"location":"Internet/ntftth/#payment-api","title":"Payment API","text":" - Request URL:
{{base_url}}/api/use/nt-ftth/ - Request Method: POST
"},{"location":"Internet/ntftth/#service-params","title":"Service Params","text":"\n{\n \"token\": \"\\ token\\ \",\n \"number\": \"subscriber_number\", // e.g. 10000141001060\n \"amount\": 100,\n \"reference\": \"\\ Unique Identifier\\ \"\n}\n
"},{"location":"Internet/ntftth/#notes","title":"Notes","text":" - Amount should be between Rs. 10 and Rs. 25,000.
- The
number is the subscriber number of the user (14 characters). - The initial 5 characters are always constant:
10000.
"},{"location":"Internet/ntftth/#response-example","title":"Response Example","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Transaction successful\",\n \"credits_consumed\": 100.0,\n \"credits_available\": 9997874087.88002,\n \"id\": 51510\n}\n
"},{"location":"Internet/pokhara-internet/","title":"Pokhara Internet API","text":""},{"location":"Internet/pokhara-internet/#overview","title":"Overview","text":"The Pokhara Internet API allows users to submit a transaction request to purchase internet services. By sending a POST request with the required parameters, users can manage their internet subscriptions. The API provides feedback on the transaction status and available credits.
"},{"location":"Internet/pokhara-internet/#api-details","title":"API Details","text":" - Type: Single Step API
- URL:
{{base_url}}/api/use/pokhara-internet - Method: POST
"},{"location":"Internet/pokhara-internet/#service-parameters","title":"Service Parameters","text":"To make a request, send the following JSON object in the body of your POST request:
\n{\n \"token\": \"token\",\n \"username\": \"Username, eg: khaltiUser\",\n \"number\": \"9818766122\",\n \"amount\": 100, // Minimum Amount 100, Max: 50,000\n \"address\": \"Amarsingh\",\n \"reference\": \"pokharainternet1\"\n}\n
"},{"location":"Internet/pokhara-internet/#response-format","title":"Response Format","text":"Upon a successful request, the API will return a response in the following format:
\n{\n \"status\": true,\n \"id\": 1257,\n \"credits_available\": 9600.0,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"credits_consumed\": 100.0\n}\n
"},{"location":"Internet/pokhara-internet/#response-fields","title":"Response Fields","text":" - status: Indicates if the request was successful (true/false).
- id: A unique identifier for the transaction.
- credits_available: The remaining credits available after the transaction.
- message: A message indicating the state of the transaction.
- state: The current state of the transaction (e.g., \"Queued\").
- credits_consumed: The amount of credits used for the transaction.
"},{"location":"Internet/pokhara-internet/#conclusion","title":"Conclusion","text":"The Pokhara Internet API facilitates the purchase of internet services, ensuring users can manage their subscriptions efficiently while receiving real-time updates on transaction status.
"},{"location":"Internet/rapidapi/","title":"Rapid Unique Net","text":"Type: Multi Step API This document outlines the APIs for fetching user details and processing payments for Rapid Unique Net services.
"},{"location":"Internet/rapidapi/#1-details-fetch-api","title":"1. Details Fetch API","text":" - Request URL:
{{url}}/api/servicegroup/details/rapid-api/ - Method: POST
"},{"location":"Internet/rapidapi/#service-params","title":"Service Params","text":"\n{\n \"token\": \"provided token\",\n \"username\": \"username\",\n \"reference\": \"unique reference id\"\n}\n
"},{"location":"Internet/rapidapi/#response","title":"Response","text":"\n{\n \"status\": true,\n \"details\": {\n \"user_id\": 8897,\n \"name\": \"test \",\n \"address\": \"test\",\n \"username\": \"test\",\n \"remaining_days\": 30,\n \"phone_number\": \"9801558646\",\n \"amount\": \"1000.00\",\n \"added_grace_days\": \"0\",\n \"package_period\": \"1 Month\",\n \"package\": \"FIBER-HOME-10M\"\n },\n \"session_id\": 11686\n}\n
"},{"location":"Internet/rapidapi/#2-payment-api","title":"2. Payment API","text":" - Request URL:
{{url}}/api/servicegroup/commit/rapid-api/ - Method: POST
"},{"location":"Internet/rapidapi/#service-params_1","title":"Service Params","text":"\n{\n \"token\": \"\\ provided token\\ \",\n \"amount\": \"\\ amount from detail fetch\\ \",\n \"session_id\": \"\\ session id from get details\\ \"\n}\n
"},{"location":"Internet/rapidapi/#response_1","title":"Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Recharge Successful\",\n \"credits_consumed\": 1001.0,\n \"credits_available\": 9993943006.01662,\n \"id\": 95287\n}\n
"},{"location":"Internet/royal-network/","title":"Royal Network API","text":"The Royal Network API allows users to perform transactions related to the Royal Network service.
"},{"location":"Internet/royal-network/#type-single-step-api","title":"Type: Single Step API","text":""},{"location":"Internet/royal-network/#endpoint","title":"Endpoint","text":" - URL:
{{base_url}}/api/use/royal-network - Method:
POST
"},{"location":"Internet/royal-network/#service-parameters","title":"Service Parameters","text":"The request must include the following parameters:
\n{\n \"token\": \"token\",\n \"username\": \"Username, eg: khaltiUser\",\n \"mobile_number\": \"9818766122\",\n \"amount\": 100, // Minimum Amount 100\n \"reference\": \"royalnetwork1\"\n}\n
"},{"location":"Internet/royal-network/#validation","title":"Validation","text":" - Username Pattern:
([a-zA-Z0-9_]+) - Error Message: \"Invalid Username\"
"},{"location":"Internet/royal-network/#response","title":"Response","text":"Upon successful request, the API will return a response in the following format:
\n{\n \"status\": true,\n \"id\": 1268,\n \"credits_available\": 9000.0,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"credits_consumed\": 100.0\n}\n
"},{"location":"Internet/sky-broadband/","title":"Sky Broadband","text":"This document outlines the API for Sky Broadband, which includes functionalities for fetching available packages and processing payments. It details the request URLs, methods, parameters, and example responses for both the package fetch and payment APIs.
Type: Multi Step API
"},{"location":"Internet/sky-broadband/#1-package-fetch-api","title":"1. Package Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/sky-broadband/
Request Method: POST
"},{"location":"Internet/sky-broadband/#service-params","title":"Service Params:","text":"\n{ \n \"token\": \"token\", \n \"username\": \"ppoe_ashis_test\", \n \"reference\": \"unique reference\" \n}\n
"},{"location":"Internet/sky-broadband/#response","title":"Response:","text":"\n{ \n \"packages\": [ \n { \n \"package_id\": 3, \n \"package_name\": \"50Mbps Residential 1Month\", \n \"profile\": \"007_50Mbps_Residential_1Month\", \n \"package_slug\": \"50Mbps-Residential-1Month\", \n \"is_referrable\": 0, \n \"package_type\": null, \n \"expiration_amount\": null, \n \"expiration_period\": null, \n \"amount\": 10.0 \n }, \n { \n \"package_id\": 4, \n \"package_name\": \"default-2Mbit-1Month\", \n \"profile\": \"default-2Mbit-1Month\", \n \"package_slug\": \"default-2Mbit-1Month\", \n \"is_referrable\": 0, \n \"package_type\": \"Prepaid\", \n \"expiration_amount\": 1, \n \"expiration_period\": \"Month\", \n \"amount\": 1000.0 \n }, \n { \n \"package_id\": 5, \n \"package_name\": \"3-days-extension-package\", \n \"profile\": \"3-days-extension-package\", \n \"package_slug\": \"3-days-extension-package\", \n \"is_referrable\": 0, \n \"package_type\": \"Extension\", \n \"expiration_amount\": 3, \n \"expiration_period\": \"Day\", \n \"amount\": 10.0 \n } \n ], \n \"session_id\": 8319, \n \"status\": true \n}\n
"},{"location":"Internet/sky-broadband/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/sky-broadband/
Request Method: POST
"},{"location":"Internet/sky-broadband/#service-params_1","title":"Service Params:","text":"\n{ \n \"token\": \"token\", \n \"session_id\": \"session_id from previous detail fetch API\", \n \"amount\": \"amount from previous detail fetch API\", \n \"package_id\": \"package_id from previous detail fetch API\" \n}\n
"},{"location":"Internet/sky-broadband/#response_1","title":"Response:","text":"\n{ \n \"status\": true, \n \"state\": \"Success\", \n \"message\": \"Successfully Completed Transaction\", \n \"extra_data\": {}, \n \"detail\": \"Success\", \n \"credits_consumed\": 10.0, \n \"credits_available\": 9994745936.78663, \n \"id\": 82599 \n}\n
"},{"location":"Internet/subisu/","title":"Subisu New","text":"Multistep API
NOTE:
- If there is an outstanding amount greater than 0, users can choose to pay either the outstanding amount or their package payment. Users can also pay for their package if the outstanding amount is greater than 0.
- When fetching details, there are four different responses based on the user's plans: TV only, internet only, TV + internet, and Combo.
- Users with TV can have either a Single STB or multiple STBs. This applies to TV only and Internet + TV users.
- Payment parameters change based on the type of payment: Outstanding payment, TV payment, Internet payment, or Combo offer payment.
"},{"location":"Internet/subisu/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"URL: {{base_url}}/api/servicegroup/details/subisu/
Service Params:
\n{ \n \"token\": \"token-provided\", \n \"reference\": \"unique-reference\", \n \"username\": \"username\" \n}\n
"},{"location":"Internet/subisu/#response","title":"Response:","text":"Note:
- There are four different
plan_type values, and responses vary based on plan_type. - TV may have either a single STB or multiple STBs.
Types of Response:
- Response of
plan_type: \"internet\"
Test User: khaltiinternet
\n { \n \"customer_name\": \"Northbound Test Khalti\", \n \"address\": \"Baluwatar\", \n \"current_plan_name\": \"Internet Northbound\", \n \"user_id\": \"khaltiinternet\", \n \"outstanding_amount\": \"0.00\", \n \"expiry_date\": \"2023-08-25T23:59:59\", \n \"mobile_no\": \"9100000000\", \n \"onu_id\": null, \n \"partner_name\": \"Selfcare Test 1\", \n \"plan_detail_list\": { \n \"plan_detail_list\": { \n \"internet_plan_details\": [ \n { \n \"amount\": 10, \n \"plan_name\": \"Internet Northbound\", \n \"description\": \"10.00\", \n \"primary_speed\": \"0\", \n \"volume_quota\": \"0\", \n \"validity\": \"30 Days\" \n }, \n { \n \"amount\": 10, \n \"plan_name\": \"Internet Northbound\", \n \"description\": \"10.00\", \n \"primary_speed\": \"4096\", \n \"volume_quota\": null, \n \"validity\": \"30 Days\" \n }, \n { \n \"amount\": 4000, \n \"plan_name\": \"10Mbps 12Months BPKIHS\", \n \"description\": \"4000.00\", \n \"primary_speed\": \"10240\", \n \"volume_quota\": null, \n \"validity\": \"360 Days\" \n }, \n { \n \"amount\": 10, \n \"plan_name\": \"Selfcare Renew eSewa\", \n \"description\": \"10.00\", \n \"primary_speed\": \"20480\", \n \"volume_quota\": null, \n \"validity\": \"1 Days\" \n }, \n { \n \"amount\": 1, \n \"plan_name\": \"Selfcare Renew IPS & Card\", \n \"description\": \"1.00\", \n \"primary_speed\": \"20480\", \n \"volume_quota\": null, \n \"validity\": \"1 Days\" \n } \n ] \n }, \n \"plan_type\": \"internet\" \n }, \n \"session_id\": 9017, \n \"status\": true \n }\n
- Response of
plan_type: \"combo offer\"
Test User: khaltioffer
\n { \n \"customer_name\": \"Northbound Test Khalti\", \n \"address\": \"khaltioffer\", \n \"current_plan_name\": \"Offer Test Data\", \n \"user_id\": \"khaltioffer\", \n \"outstanding_amount\": \"0.00\", \n \"expiry_date\": \"2023-08-29T23:59:59\", \n \"mobile_no\": \"9100000000\", \n \"tv_plan_list\": { \n \"tv_plan_details\": [ \n { \n \"current_video_plan_name\": \"Offer Test Video\", \n \"stb\": \"ABCCD10BBBFC942B\", \n \"expiry_date\": \"2023-08-29T23:59:59\" \n } \n ] \n }, \n \"onu_id\": null, \n \"partner_name\": \"Selfcare Test 1\", \n \"plan_detail_list\": { \n \"plan_detail_list\": [ \n { \n \"validity\": \"1 Months\", \n \"offer_name\": \"Combo Offer Test 2\", \n \"offer_id\": \"4237\", \n \"amount\": 10, \n \"combo_plan_details\": [ \n { \n \"plan_type\": \"Data\", \n \"service_media\": \"FTTH\", \n \"activation_date\": \"2023-08-30T00:00:00\", \n \"expiry_date\": \"2023-09-29T00:00:00\", \n \"allow_to_renew\": \"false\", \n \"service_media_id\": \"11952\", \n \"stb_id\": null, \n \"is_primary\": \"false\", \n \"expiry_date_string\": \"29-Sep-2023\", \n \"activation_date_string\": \"30-Aug-2023\" \n }, \n { \n \"plan_type\": \"Video\", \n \"service_media\": \"Clear TV(DTV)\", \n \"activation_date\": \"2023-08-30T00:00:00\", \n \"expiry_date\": \"2023-09-29T00:00:00\", \n \"allow_to_renew\": \"false\", \n \"service_media_id\": \"11956\", \n \"stb_id\": \"780784\", \n \"is_primary\": \"true\", \n \"expiry_date_string\": \"29-Sep-2023\", \n \"activation_date_string\": \"30-Aug-2023\" \n } \n ] \n } \n ], \n \"plan_type\": \"combo offer\" \n }, \n \"session_id\": 9018, \n \"status\": true \n }\n
- Response of
plan_type: \"tv\"
Test User: paypoint_video
\n { \n \"customer_name\": \"Paypoint Video\", \n \"address\": \"Baluwatar\", \n \"user_id\": \"paypoint_video\", \n \"outstanding_amount\": \"0.00\", \n \"expiry_date\": null, \n \"mobile_no\": \"9100000000\", \n \"tv_plan_list\": { \n \"tv_plan_details\": [ \n { \n \"current_video_plan_name\": \"Video Tests Plan 1M\", \n \"stb\": \"sample5\", \n \"expiry_date\": \"2023-06-17T23:59:59\" \n }, \n { \n \"current_video_plan_name\": \"Mobile API DTV CHILD - TEST\", \n \"stb\": \"TEST0001\", \n \"expiry_date\": \"2023-06-17T23:59:59\" \n } \n ] \n }, \n \"onu_id\": null, \n \"partner_name\": \"Selfcare Test 1\", \n \"plan_detail_list\": { \n \"plan_detail_list\": [ \n { \n \"stb\": \"sample5\", \n \"tv_plan_details\": [ \n { \n \"amount\": 10, \n \"plan_name\": \"Video Tests Plan 1M\", \n \"validity\": \"30 Days\" \n } \n ] \n } \n ], \n \"plan_type\": \"tv\" \n }, \n \"session_id\": 9019, \n \"status\": true \n }\n
- Response of
plan_type: \"internet + tv\"
Test User: khaltivideo
\n { \n \"customer_name\": \"Khalti Video Plan\", \n \"address\": \"Baluwatar\", \n \"current_plan_name\": \"Selfcare Renew eSewa\", \n \"user_id\": \"khaltivideo\", \n \"outstanding_amount\": \"0.00\", \n \"expiry_date\": \"2023-07-01T23:59:59\", \n \"mobile_no\": \"9100000000\", \n \"tv_plan_list\": { \n \"tv_plan_details\": [ \n { \n \"current_video_plan_name\": \"Video offer child tests\", \n \"stb\": \"Sample 11\", \n \"expiry_date\": \"2023-07-21T23:59:59\" \n }, \n { \n \"current_video_plan_name\": \"Video Tests Plan 1M\", \n \"stb\": \"ABCC2C1D07B01A20\", \n \"expiry_date\": \"2023-08-21T23:59:59\" \n } \n ] \n }, \n \"onu_id\": null, \n \"partner_name\": \"Selfcare Test 1\", \n \"plan_detail_list\": { \n \"plan_detail_list\": { \n \"internet_details\": { \n \"internet_plan_details\": [ \n { \n \"amount\": 10, \n \"plan_name\": \"Selfcare Renew eSewa\", \n \"description\": \"10.00\", \n \"primary_speed\": \"0\", \n \"volume_quota\": \"0\", \n \"validity\": \"1 Days\" \n }, \n { \n \"amount\": 10, \n \"plan_name\": \"Internet Northbound\", \n \"description\": \"10.00\", \n \"primary_speed\": \"4096\", \n \"volume_quota\": null, \n \"validity\": \"30 Days\" \n }, \n { \n \"amount\": 4000, \n \"plan_name\": \"10Mbps 12Months BPKIHS\", \n \"description\": \"4000.00\", \n \"primary_speed\": \"10240\", \n \"volume_quota\": null, \n \"validity\": \"360 Days\" \n }, \n { \n \"amount\": 10, \n \"plan_name\": \"Selfcare Renew eSewa\", \n \"description\": \"10.00\", \n \"primary_speed\": \"20480\", \n \"volume_quota\": null, \n \"validity\": \"1 Days\" \n }, \n { \n \"amount\": 1, \n \"plan_name\": \"Selfcare Renew IPS & Card\", \n \"description\": \"1.00\", \n \"primary_speed\": \"20480\", \n \"volume_quota\": null, \n \"validity\": \"1 Days\" \n } \n ] \n }, \n \"tv_details\": [ \n { \n \"stb\": \"ABCC2C1D07B01A20\", \n \"tv_plan_details\": [ \n { \n \"amount\": 10, \n \"plan_name\": \"Video Tests Plan 1M\", \n \"validity\": \"30 Days\" \n } \n ] \n }, \n { \n \"stb\": \"ABCC2C1D07B01A20\", \n \"tv_plan_details\": [ \n { \n \"amount\": 10, \n \"plan_name\": \"Video Tests Plan 1M\", \n \"validity\": \"30 Days\" \n } \n ] \n }, \n { \n \"stb\": \"Sample 11\", \n \"tv_plan_details\": [ \n { \n \"amount\": 3, \n \"plan_name\": \"Video offer child tests\", \n \"validity\": \"30 Days\" \n } \n ] \n }, \n { \n \"stb\": \"Sample 11\", \n \"tv_plan_details\": [ \n { \n \"amount\": 3, \n \"plan_name\": \"Video offer child tests\", \n \"validity\": \"30 Days\" \n } \n ] \n } \n ] \n }, \n \"plan_type\": \"internet + tv\" \n }, \n \"session_id\": 9020, \n \"status\": true \n }\n
"},{"location":"Internet/subisu/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/subisu/
Request Method: POST
Outstanding amount is the due amount. Users can choose to pay the outstanding amount or the package amount. Parameters change based on the type of payment:
- Outstanding Payment If
outstanding_amount > 0, users can pay the outstanding amount. This works for all plan types: internet, combo offer, TV, and internet + TV.
Service Params for Outstanding Payment:
\n { \n \"token\": \"provided_token\", \n \"session_id\": Obtained from detail fetch API, \n \"amount\": \"amount\", // amount from detail step \n \"renew_type\": \"outstanding_payment\" \n }\n
- TV Payment When fetching details, users must select one STB if there are multiple STBs. This works for plan types: TV and internet + TV.
Service Params for TV Payment:
\n { \n \"token\": \"provided_token\", \n \"session_id\": Obtained from detail fetch API, \n \"amount\": \"amount\", // amount from detail fetch API \n \"offer_name\": \"offer_name\", // plan_name from detail step \n \"stb\": \"stb\" // STB from detail fetch API \n }\n
- Internet Payment This works for plan types: TV and internet + TV.
Service Params for Internet Payment:
\n { \n \"token\": \"provided_token\", \n \"session_id\": Obtained from detail fetch API, \n \"amount\": \"amount\", // amount from detail step \n \"offer_name\": \"offer_name\" // plan_name from detail step \n }\n
- Offer Payment This works for the combo offer plan type.
Service Params for Offer Payment:
\n { \n \"token\": \"provided_token\", \n \"session_id\": Obtained from detail fetch API, \n \"amount\": \"amount\", // amount from detail step \n \"offer_name\": \"offer_name\" // offer_name from detail step \n }\n
"},{"location":"Internet/subisu/#success-response","title":"Success Response:","text":"\n{ \n \"status\": true, \n \"state\": \"Success\", \n \"message\": \"Successfully Completed Transaction\", \n \"extra_data\": {}, \n \"detail\": \"2531\", \n \"credits_consumed\": 1232, \n \"credits_available\": 2460415608.4800014, \n \"id\": 64146 \n}\n
"},{"location":"Internet/subisu/#failed-response","title":"Failed Response:","text":" - If the user has no outstanding amount
\n { \n \"status\": false, \n \"error_code\": \"4000\", \n \"message\": \"Can't fulfill request\", \n \"error\": \"client_error\", \n \"details\": \"No outstanding dues.\", \n \"error_data\": {}, \n \"state\": \"Error\" \n }\n
- If the user has already purchased the package
\n { \n \"status\": false, \n \"error_code\": \"4000\", \n \"message\": \"Can't fulfill request\", \n \"error\": \"client_error\", \n \"details\": \"Future plan is already exist.\", \n \"error_data\": {}, \n \"state\": \"Error\" \n }\n
- Invalid offer name and amount
\n { \n \"status\": false, \n \"error_code\": \"1011\", \n \"message\": \"Validation error\", \n \"error\": \"validation_error\", \n \"details\": { \n \"offer_name\": \"Offer_name does not match with amount!\" \n }, \n \"error_data\": {}, \n \"state\": \"Error\" \n }\n
"},{"location":"Internet/techminds/","title":"Techminds API","text":"The Techminds API provides endpoints for fetching user details and processing payments.
"},{"location":"Internet/techminds/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Internet/techminds/#1-user-detail-api","title":"1. User Detail API","text":" - URL:
{{base_url}}/api/servicegroup/details/techminds/ - Method:
POST
"},{"location":"Internet/techminds/#service-parameters","title":"Service Parameters","text":"The request must include the following parameters:
\n{\n \"token\": \"token\",\n \"request_id\": \"lionschowk\",\n \"reference\": \"techminds123\"\n}\n
"},{"location":"Internet/techminds/#response-user-details","title":"Response: User Details","text":""},{"location":"Internet/techminds/#success-response","title":"Success Response","text":"\n{\n \"data\": {\n \"customer_name\": \"Kamal Raj Paudyal\",\n \"expiration\": \"Dec 28 2024\",\n \"mobile_number\": \"9855059124\",\n \"previous_balance\": 256,\n \"email\": \"kamal@technolinx.com.np\",\n \"monthly_charge\": \"1350\"\n },\n \"status\": true,\n \"session_id\": 8,\n \"available_plans\": {\n \"180 Days\": 8100,\n \"90 Days\": 4050,\n \"30 Days\": 1350,\n \"15 Days\": 675,\n \"60 Days\": 2700\n }\n}\n
"},{"location":"Internet/techminds/#2-payment-api","title":"2. Payment API","text":" - URL:
{{base_url}}/api/servicegroup/commit/techminds/ - Method:
POST
"},{"location":"Internet/techminds/#service-parameters_1","title":"Service Parameters","text":"The request must include the following parameters:
\n{\n \"request_id\": \"lionschowk\",\n \"session_id\": 7,\n \"reference\": \"reference123\",\n \"token\": \"TEST:O7QxjFcdueNzAh9aBOsD\",\n \"amount\": 1350\n}\n
"},{"location":"Internet/techminds/#response-payment","title":"Response: Payment","text":""},{"location":"Internet/techminds/#success-response_1","title":"Success Response","text":"\n{\n \"id\": 2209,\n \"status\": true,\n \"message\": \"Successfully Completed Transaction\",\n \"state\": \"Success\",\n \"detail\": \"Transaction successful\",\n \"extra_data\": {}\n}\n
"},{"location":"Internet/timesinternet/","title":"Times Internet","text":""},{"location":"Internet/timesinternet/#86-times-internet","title":"8.6 Times - Internet","text":"Note: Below is the list of ISPs under Times and their service_slug:
- 8.6.1 Websurfer Internet:
websurfer-internet - 8.6.2 Reliant Technology:
reliant-technology-v2 - 8.6.3 Palsnet:
palsnet - 8.6.4 Sky Internet:
sky-internet - 8.6.5 Pathibara Internet:
pathibara
"},{"location":"Internet/timesinternet/#multi-step-api","title":"Multi-Step API","text":"The Times Internet API consists of three main steps:
- Detail Fetch API
- Package Fetch API
- Payment API
"},{"location":"Internet/timesinternet/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"URL: {{base_url}}/api/servicegroup/userlist/times/
METHOD: POST
Service Params:
\n{\n \"token\": \"Account_Token\",\n \"reference\": \"Unique Id sent from your side\",\n \"customer_id\": \"Customer_ID\",\n \"service_slug\": \"service_slug\"\n}\n
Response:
\n{\n \"customer\": {\n \"cuid\": \"1000000\",\n \"first_name\": \"rajesh\",\n \"last_name\": \"lamichhane\",\n \"status\": \"active\"\n },\n \"connection\": [\n {\n \"username\": \"rajesh-lamichhane\",\n \"status\": \"active\"\n },\n {\n \"username\": \"rajesh-lamichhane2\",\n \"status\": \"active\"\n }\n ],\n \"session_id\": 2809,\n \"status\": true\n}\n
"},{"location":"Internet/timesinternet/#2-package-fetch-api","title":"2. Package Fetch API","text":"URL: {{base_url}}/api/servicegroup/details/times/
METHOD: POST
Service Params:
\n{\n \"token\": \"Account_Token\",\n \"username\": \"rajesh-lamichhane\",\n \"session_id\": \"session_id from user lookup\",\n \"service_slug\": \"service_slug\",\n \"reference\": \"unique reference id\"\n}\n
Response:
\n{\n \"packages\": [\n {\n \"package_id\": \"132\",\n \"package_name\": \"10Mbps Half Yearly - Nepalgunj (HALF YEARLY)\",\n \"amount\": 7451\n },\n {\n \"package_id\": \"130\",\n \"package_name\": \"10Mbps Monthly - Nepalgunj (MONTHLY)\",\n \"amount\": 1355\n },\n {\n \"package_id\": \"131\",\n \"package_name\": \"10Mbps Quarterly - Nepalgunj (QUARTERLY)\",\n \"amount\": 3895\n },\n {\n \"package_id\": \"134\",\n \"package_name\": \"10Mbps Yearly - renew- Nepalgu (YEARLY)\",\n \"amount\": 11000\n },\n {\n \"package_id\": \"137\",\n \"package_name\": \"15Mbps Half Yearly - Nepalgunj (HALF YEARLY)\",\n \"amount\": 7910\n },\n {\n \"package_id\": \"135\",\n \"package_name\": \"15Mbps Monthly - Nepalgunj (MONTHLY)\",\n \"amount\": 1412\n },\n {\n \"package_id\": \"136\",\n \"package_name\": \"15Mbps Quarterly - Nepalgunj (QUARTERLY)\",\n \"amount\": 4068\n },\n {\n \"package_id\": \"139\",\n \"package_name\": \"15Mbps Yearly - renew- Nepalgu (YEARLY)\",\n \"amount\": 12001\n },\n {\n \"package_id\": \"103\",\n \"package_name\": \"15Mbps-Half Yearly (HALF YEARLY)\",\n \"amount\": 5101\n },\n {\n \"package_id\": \"101\",\n \"package_name\": \"15Mbps-Monthly (MONTHLY)\",\n \"amount\": 950\n },\n {\n \"package_id\": \"102\",\n \"package_name\": \"15Mbps-Quarterly (QUARTERLY)\",\n \"amount\": 2550\n },\n {\n \"package_id\": \"104\",\n \"package_name\": \"15Mbps-Yearly (YEARLY)\",\n \"amount\": 10201\n },\n {\n \"package_id\": \"107\",\n \"package_name\": \"20Mbps-Half Yearly (HALF YEARLY)\",\n \"amount\": 5700\n },\n {\n \"package_id\": \"105\",\n \"package_name\": \"20Mbps-Monthly (MONTHLY)\",\n \"amount\": 950\n },\n {\n \"package_id\": \"106\",\n \"package_name\": \"20Mbps-Quarterly (QUARTERLY)\",\n \"amount\": 2851\n },\n {\n \"package_id\": \"108\",\n \"package_name\": \"20Mbps-Yearly (YEARLY)\",\n \"amount\": 11400\n },\n {\n \"package_id\": \"111\",\n \"package_name\": \"30Mbps-Half Yearly (HALF YEARLY)\",\n \"amount\": 7500\n },\n {\n \"package_id\": \"109\",\n \"package_name\": \"30Mbps-Monthly (MONTHLY)\",\n \"amount\": 1250\n },\n {\n \"package_id\": \"110\",\n \"package_name\": \"30Mbps-Quarterly (QUARTERLY)\",\n \"amount\": 3750\n },\n {\n \"package_id\": \"112\",\n \"package_name\": \"30Mbps-Yearly (YEARLY)\",\n \"amount\": 15000\n },\n {\n \"package_id\": \"115\",\n \"package_name\": \"40Mbps-Half Yearly (HALF YEARLY)\",\n \"amount\": 9000\n },\n {\n \"package_id\": \"119\",\n \"package_name\": \"40Mbps-Half Yearly-Nepalgunj (HALF YEARLY)\",\n \"amount\": 7800\n },\n {\n \"package_id\": \"113\",\n \"package_name\": \"40Mbps-Monthly (MONTHLY)\",\n \"amount\": 1501\n },\n {\n \"package_id\": \"141\",\n \"package_name\": \"40Mbps-Monthly @ 1000-R (MONTHLY)\",\n \"amount\": 1000\n },\n {\n \"package_id\": \"117\",\n \"package_name\": \"40Mbps-Monthly-Nepalgunj (MONTHLY)\",\n \"amount\": 1300\n },\n {\n \"package_id\": \"118\",\n \"package_name\": \"40Mbps-Quarterly-Nepalgunj (QUARTERLY)\",\n \"amount\": 3900\n },\n {\n \"package_id\": \"120\",\n \"package_name\": \"40Mbps-Yearly-Nepalgunj (YEARLY)\",\n \"amount\": 14501\n },\n {\n \"package_id\": \"127\",\n \"package_name\": \"5Mbps Half Yearly - Nepalgunj (HALF YEARLY)\",\n \"amount\": 4740\n },\n {\n \"package_id\": \"125\",\n \"package_name\": \"5Mbps Monthly Old - Nepalgunj (MONTHLY)\",\n \"amount\": 790\n },\n {\n \"package_id\": \"126\",\n \"package_name\": \"5Mbps Quarterly - Nepalgunj (QUARTERLY)\",\n \"amount\": 2201\n },\n {\n \"package_id\": \"129\",\n \"package_name\": \"5Mbps Yearly - renew- Nepalgun (YEARLY)\",\n \"amount\": 5901\n }\n ],\n \"session_id\": 2809,\n \"status\": true\n}\n
"},{"location":"Internet/timesinternet/#3-payment-api","title":"3. Payment API","text":"URL: {{base_url}}/api/servicegroup/commit/times/
METHOD: POST
Service Params:
\n{\n \"token\": \"Account_Token\",\n \"session_id\": \"session_id from user lookup\",\n \"amount\": \"Package Amount from package fetch API\",\n \"package_id\": \"package ID from package fetch API\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 790.0,\n \"credits_available\": 9999378747.53,\n \"id\": 42353\n}\n
"},{"location":"Internet/vianet-new/","title":"Vianet","text":""},{"location":"Internet/vianet-new/#1-service-group-details-api","title":"1. Service Group Details API","text":""},{"location":"Internet/vianet-new/#url","title":"URL","text":"{{base_url}}/api/servicegroup/details/vianet-updated/
"},{"location":"Internet/vianet-new/#method","title":"Method","text":"POST
"},{"location":"Internet/vianet-new/#request-payload","title":"Request Payload","text":"\n{\n \"token\": \"token\",\n \"reference\": \"Unique reference\",\n \"customer_id\": 110871\n}\n
"},{"location":"Internet/vianet-new/#success-response","title":"Success Response","text":"\n{\n \"customer_id\": 110871,\n \"customer_name\": \"Suman Shrestha\",\n \"bills\": [\n {\n \"payment_id\": \"1613142_PP\",\n \"service_name\": \"wetherspooncafe21424\",\n \"service_details\": \"FiberNet Home CRush (1 year)\",\n \"vat_amount\": \"30.55\",\n \"grand_total\": \"277.98\",\n \"service_rate\": \"246.00\"\n },\n {\n \"payment_id\": \"1613143_PP\",\n \"service_name\": \"wetherspooncafe21424\",\n \"service_details\": \"Test payment 2\",\n \"vat_amount\": \"3.77\",\n \"grand_total\": \"34.35\",\n \"service_rate\": \"30.40\"\n },\n {\n \"payment_id\": \"1613144_PP\",\n \"service_name\": \"wetherspooncafe21424\",\n \"service_details\": \"Test Payment 1\",\n \"vat_amount\": \"5.20\",\n \"grand_total\": \"47.46\",\n \"service_rate\": \"42.00\"\n },\n {\n \"payment_id\": \"1613145_PP\",\n \"service_name\": \"wetherspooncafe21424\",\n \"service_details\": \"FiberNet Home CRush (6 months)\",\n \"vat_amount\": \"13.00\",\n \"grand_total\": \"118.65\",\n \"service_rate\": \"105.00\"\n }\n ],\n \"session_id\": 27383,\n \"status\": true\n}\n
"},{"location":"Internet/vianet-new/#error-response","title":"Error Response","text":"\n{\n \"status\": false,\n \"error_code\": \"7000\",\n \"message\": \"Unknown Error occured. Check details\",\n \"error\": \"unknown_error\",\n \"details\": \"You have no pending bills right now !!\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"Internet/vianet-new/#2-payment-commit-api","title":"2. Payment Commit API","text":""},{"location":"Internet/vianet-new/#url_1","title":"URL","text":"{{base_url}}/api/servicegroup/commit/vianet-updated/
"},{"location":"Internet/vianet-new/#method_1","title":"Method","text":"POST
"},{"location":"Internet/vianet-new/#request-payload_1","title":"Request Payload","text":"\n{\n \"token\": \"{{token}}\",\n \"session_id\": \"{{session_id}}\",\n \"payment_id\": \"{{payment_id}}\",\n \"amount\": {{amount}},\n \"reference\": \"{{$guid}}\"\n}\n
"},{"location":"Internet/vianet-new/#success-response_1","title":"Success Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": {\n \"message\": \"Payment Successfull! Thank you for using Online Payment Option\"\n },\n \"credits_consumed\": 277.98,\n \"credits_available\": 999006795.14,\n \"id\": 130144\n}\n
"},{"location":"Internet/vianet-new/#error-response_1","title":"Error Response","text":"\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Payment seems to have already been Made!\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"Internet/vianet/","title":"Vianet Deprecated","text":"Note: Please ensure to follow the latest API in the Vianet documentation. Click here for more details.
"},{"location":"Internet/vianet/#overview","title":"Overview","text":"The Vianet API consists of two primary endpoints for interacting with the service:
- User Details Endpoint: Retrieves details about a specific customer, including their billing information.
- Payment Endpoint: Commits a payment based on the details retrieved from the first step.
"},{"location":"Internet/vianet/#user-details","title":"User Details","text":"URL: {{base_url}}/api/servicegroup/details/vianet/
Service Params:
\n{\n \"token\": \"token-provided\",\n \"customer_id\": \"CustomerId provided by vianet, e.g., 10619\"\n}\n
Regex:
\n[\n {\n \"name\": \"Customer ID\",\n \"slug\": \"\",\n \"pattern\": \"([a-zA-Z0-9_]+)\",\n \"error_message\": \"Invalid Customer Id\"\n }\n]\n
Example:
"},{"location":"Internet/vianet/#response","title":"Response:","text":""},{"location":"Internet/vianet/#success","title":"Success","text":"\n{\n \"status\": true,\n \"bills\": [\n {\n \"payment_id\": \"378197\",\n \"bill_date\": \"2017-09-08\",\n \"service_details\": \"FiberNet Home Rush (1 year)\",\n \"service_name\": \"serv9099\",\n \"amount\": 23187.6\n }\n ],\n \"session_id\": 130,\n \"customer_id\": \"9099\",\n \"customer_name\": \"Customer Name\"\n}\n
"},{"location":"Internet/vianet/#error","title":"Error","text":"\n{\n \"error_code\": \"1010\",\n \"message\": \"Validation error\",\n \"status\": false,\n \"error_data\": \"\",\n \"details\": \"**\"\n}"},{"location":"Internet/vianet/#vianet-payment","title":"Vianet Payment","text":"URL: {{base_url}}/api/servicegroup/commit/vianet/
\nService Params:
\n\n{\n \"token\": \"token-provided\",\n \"session_id\": \"Session id as obtained in details step\",\n \"customer_id\": \"Customer Id, same as in details step\",\n \"payment_id\": \"Payment Id as obtained in details step\",\n \"reference\": \"unique reference_id\"\n}\n
"},{"location":"Internet/vianet/#response_1","title":"Response:","text":""},{"location":"Internet/vianet/#success_1","title":"Success","text":"\n{\n \"id\": 496,\n \"message\": \"Thank you for using our online Service.\",\n \"status\": true,\n \"state\": \"Success\"\n}\n
"},{"location":"Internet/vianet/#error_1","title":"Error","text":"\n{\n \"error_code\": \"1010\",\n \"message\": \"Validation error\",\n \"status\": false,\n \"error_data\": \"\",\n \"details\": \"**\"\n}"},{"location":"Internet/web-network/","title":"Web Network API","text":"The Web Network API allows users to fetch details and make payments for web network services.
"},{"location":"Internet/web-network/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Internet/web-network/#1-get-details","title":"1. Get Details","text":" - URL: {{base_url}}/api/servicegroup/details/web-network
- Method:
POST
"},{"location":"Internet/web-network/#service-parameters","title":"Service Parameters","text":"The request must include the following parameters:
\n{\n \"token\": \"token\",\n \"request_id\": \"anjudvt_fiber\",\n \"reference\": \"unique reference identifier\"\n}\n
"},{"location":"Internet/web-network/#response","title":"Response","text":"Upon successful request, the API will return a response in the following format:
\n{\n \"request_id\": \"anjudvt_fiber\",\n \"amount\": 7150,\n \"response_message\": \"\",\n \"properties\": {\n \"name\": \"Anju Kc\",\n \"address\": \"Nayamil, Rupandehi\",\n \"package\": \"Fiber Plan\",\n \"duration\": \"8\"\n },\n \"session_id\": 8795,\n \"status\": true\n}\n
"},{"location":"Internet/web-network/#2-payment","title":"2. Payment","text":" - URL: {{base_url}}/api/servicegroup/commit/web-network/
- Method:
POST
"},{"location":"Internet/web-network/#service-parameters_1","title":"Service Parameters","text":"The request must include the following parameters:
\n{\n \"amount\": \"amount from get details API\",\n \"session_id\": \"session id from get details API\",\n \"reference\": \"unique reference\",\n \"token\": \"token\"\n}\n
"},{"location":"Internet/web-network/#response_1","title":"Response","text":"Upon successful transaction, the API will return a response in the following format:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 7150,\n \"credits_available\": 999999998110797.6,\n \"id\": 62819\n}\n
"},{"location":"Internet/wifi-nepal/","title":"Wifi Nepal API","text":"Wifi Nepal provides a multi-step API for managing internet service subscriptions and payments.
"},{"location":"Internet/wifi-nepal/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Internet/wifi-nepal/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"This endpoint retrieves detailed information about a user's Wifi Nepal account, including due payments and package details.
"},{"location":"Internet/wifi-nepal/#request","title":"Request","text":" - Request URL:
{{base_url}}/api/servicegroup/details/wifi-nepal/ - Request Method:
POST - Service Params:
\n{\n \"token\": \"token\",\n \"username\": \"username\",\n \"reference\": \"unique reference\",\n \"service_slug\": \"wifi-nepal-v2\"\n}\n
"},{"location":"Internet/wifi-nepal/#response","title":"Response","text":"The response contains the user's details, subscription package, due amount, and remaining days.
\n{\n \"name\": \"Kalpana Dahal\",\n \"user_id\": \"test10_wifinepal\",\n \"amount\": 6215,\n \"subscribed_package_name\": \"Master Plan-50mbps/12mths\",\n \"subscription_type\": \"RETAIL\",\n \"days_remaining\": \"353\",\n \"message\": \"You have due payment.\",\n \"amount_detail\": [\n {\n \"particular\": \"Internet\",\n \"amount\": 5085\n },\n {\n \"particular\": \"Equipment Rental Charges\",\n \"amount\": 1130\n }\n ],\n \"session_id\": 548,\n \"status\": true\n}\n
"},{"location":"Internet/wifi-nepal/#2-payment-api","title":"2. Payment API","text":"This endpoint processes the payment for the user's Wifi Nepal account.
"},{"location":"Internet/wifi-nepal/#request_1","title":"Request","text":" - Request URL:
{{base_url}}/api/servicegroup/commit/wifi-nepal/ - Request Method:
POST - Service Params:
\n{\n \"amount\": \"1808\",\n \"session_id\": \"21820\",\n \"reference\": \"{{$guid}}\",\n \"token\": \"{{token}}\",\n \"service_slug\": \"wifi-nepal-v2\"\n}\n
"},{"location":"Internet/wifi-nepal/#response_1","title":"Response","text":"The response confirms the transaction and provides invoice details.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": {\n \"invoiceNumber\": \"gs-366/2079.080\",\n \"taxableAmount\": \"5500\",\n \"vatAmount\": \"715\"\n },\n \"credits_consumed\": 6215,\n \"credits_available\": 9791703.64,\n \"id\": 58743\n}\n
"},{"location":"Internet/worldlink/","title":"WorldLink","text":""},{"location":"Internet/worldlink/#version-2","title":"Version 2","text":"Type: Multi-Step API
There are three types of users for whom this API is applicable:
-
Package Switchable Users You will receive the package options in package_options.
These users can switch their internet package. - Username: online_renew
-
Package Switchable Users with Due Payment
You will receive the package options in available_renew_options.
- Users can switch their internet package and need to pay any outstanding dues.
- If the subscribed_package_id is the same as the available_renew_options packageId, due payment will not be added to the total payable amount.
-
If the subscribed_package_id is different from the available_renew_options packageId, the due amount will be added to the total payable amount.
-
Username: online_due_and_package
-
Package Non-Switchable Users with Due Payment These users have a due payment but cannot switch their package.
- Username:
online_due_payment
"},{"location":"Internet/worldlink/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/worldlink-v2/
Request Method: POST
Service Params:
\n{ \n \"token\": \"token\", \n \"reference\": \"\", \n \"username\": \"online_renew/online_due_payment\" \n}\n\n\nResponse:
\nResponses vary depending on the type of user.
"},{"location":"Internet/worldlink/#response-for-package-switchable-users","title":"Response for Package Switchable Users","text":"Example Response:
\n\n{ \n \"username\": \"online_renew\", \n \"full_name\": \"Online Renew\", \n \"subscribed_package_name\": \"Value Standard 25mbps/3mths 1TV (Renew)\", \n \"subscribed_package_type\": \"Unlimited\", \n \"subscribedPackageId\": 1888314,\n \"days_remaining\": 0, \n \"message\": \"You have due payment.\", \n \"package_options\": [ \n { \n \"packageId\": 1888117, \n \"packageName\": \"Fiber Smart home 2019-25mbps/3 mths(Renew)\", \n \"packageRate\": 4915, \n \"packageLabel\": \"Fiber Smart home 2019-25mbps/3 mths(Renew) [Rs. 4915]\" \n }, \n { \n \"packageId\": 1888314, \n \"packageName\": \"Value Standard 25mbps/3mths 1TV (Renew)\", \n \"packageRate\": 4915, \n \"packageLabel\": \"Value Standard 25mbps/3mths 1TV (Renew) [Rs. 4915]\" \n }, \n { \n \"packageId\": 1888118, \n \"packageName\": \"Fiber Smart home 2019-40mbps/3 mths(Renew)\", \n \"packageRate\": 5932, \n \"packageLabel\": \"Fiber Smart home 2019-40mbps/3 mths(Renew) [Rs. 5932]\" \n }, \n { \n \"packageId\": 1888119, \n \"packageName\": \"Fiber Smart home 2019-60mbps/3 mths(Renew)\", \n \"packageRate\": 8475, \n \"packageLabel\": \"Fiber Smart home 2019-60mbps/3 mths(Renew) [Rs. 8475]\" \n }, \n { \n \"packageId\": 1888123, \n \"packageName\": \"Fiber Smart home 2019-25mbps/12mths(Renew)\", \n \"packageRate\": 16272, \n \"packageLabel\": \"Fiber Smart home 2019-25mbps/12mths(Renew) [Rs. 16272]\" \n }, \n { \n \"packageId\": 1888124, \n \"packageName\": \"Fiber Smart home 2019-40mbps/12mths(Renew)\", \n \"packageRate\": 19097, \n \"packageLabel\": \"Fiber Smart home 2019-40mbps/12mths(Renew) [Rs. 19097]\" \n }, \n { \n \"packageId\": 1888125, \n \"packageName\": \"Fiber Smart home 2019-60mbps/12mths(Renew)\", \n \"packageRate\": 28250, \n \"packageLabel\": \"Fiber Smart home 2019-60mbps/12mths(Renew) [Rs. 28250]\" \n } \n ], \n \"renew_option\": false, \n \"first_online_payment\": false, \n \"amount_detail\": [ \n { \n \"particular\": \"Internet\", \n \"amount\": 4915 \n } \n ], \n \"amount\": 4915, \n \"session_id\": 109, \n \"status\": true \n}\n
"},{"location":"Internet/worldlink/#response-for-package-switchable-users-with-due-payment","title":"Response for Package Switchable Users with Due Payment","text":"Example Response:
\n\n{\n \"username\": \"online_due_and_package\",\n \"account_type\": \"PERSONAL\",\n \"full_name\": \"online_due_and_package\",\n \"branch\": \"REGION2-NBU4\",\n \"subscribed_package_name\": \"BTL 120Mbps/12mths With 1TV New Year Dhamaka 079\",\n \"subscribed_package_type\": \"Unlimited\",\n \"subscribed_package_id\": 1888768,\n \"days_remaining\": 0,\n \"message\": \"You have due payment.\",\n \"package_options\": [],\n \"vatrefund_eligible\": true,\n \"available_renew_options\": [\n {\n \"packageId\": 18881068,\n \"packageName\": \"WorldLink TurboSpeed Plus 150Mbps/12M\\t\",\n \"packageRate\": 13108,\n \"packageLabel\": \"WorldLink TurboSpeed Plus 150Mbps/12M\\t [Rs. 13108]\",\n \"recommendOrder\": 1,\n \"packageDuration\": \"365\",\n \"tvEligiblePackage\": 0,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 1888857,\n \"packageName\": \"Smart Offer (1TV) 2079 200mbps/12mths\",\n \"packageRate\": 16272,\n \"packageLabel\": \"Smart Offer (1TV) 2079 200mbps/12mths [Rs. 16272]\",\n \"recommendOrder\": 2,\n \"packageDuration\": \"365\",\n \"tvEligiblePackage\": 1,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 1888767,\n \"packageName\": \"BTL 120Mbps/3mths With 1TV New Year Dhamaka 079\",\n \"packageRate\": 3220,\n \"packageLabel\": \"BTL 120Mbps/3mths With 1TV New Year Dhamaka 079 [Rs. 3220]\",\n \"recommendOrder\": 3,\n \"packageDuration\": \"90\",\n \"tvEligiblePackage\": 0,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 1888668,\n \"packageName\": \"Special BTL 120Mbps/mth (1TV)\",\n \"packageRate\": 1356,\n \"packageLabel\": \"Special BTL 120Mbps/mth (1TV) [Rs. 1356]\",\n \"recommendOrder\": 4,\n \"packageDuration\": \"30\",\n \"tvEligiblePackage\": 0,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 1888858,\n \"packageName\": \"Smart Offer (1TV) 2079 250mbps/12mths\",\n \"packageRate\": 16950,\n \"packageLabel\": \"Smart Offer (1TV) 2079 250mbps/12mths [Rs. 16950]\",\n \"recommendOrder\": 5,\n \"packageDuration\": \"365\",\n \"tvEligiblePackage\": 1,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 18881115,\n \"packageName\": \"New Smart Offer (1TV) 2081 200Mbps/6mths\",\n \"packageRate\": 8927,\n \"packageLabel\": \"New Smart Offer (1TV) 2081 200Mbps/6mths [Rs. 8927]\",\n \"recommendOrder\": 6,\n \"packageDuration\": \"180\",\n \"tvEligiblePackage\": 0,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 18881116,\n \"packageName\": \"New smart Offer (1TV) 2081 200Mbps/24mths\",\n \"packageRate\": 23041,\n \"packageLabel\": \"New smart Offer (1TV) 2081 200Mbps/24mths [Rs. 23041]\",\n \"recommendOrder\": 7,\n \"packageDuration\": \"730\",\n \"tvEligiblePackage\": 0,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 1888768,\n \"packageName\": \"BTL 120Mbps/12mths With 1TV New Year Dhamaka 079\",\n \"packageRate\": 12204,\n \"packageLabel\": \"BTL 120Mbps/12mths With 1TV New Year Dhamaka 079 [Rs.12204]\",\n \"tvEligiblePackage\": 0,\n \"packageEligibility\": true,\n \"packageDuration\": 0,\n \"recommendOrder\": 0\n }\n ],\n \"renew_option\": true,\n \"due_amount_till_now\": 301,\n \"due_remarks\": \"used 9 days of BTL 120Mbps/12mths With 1TV New Year Dhamaka 079 (1888768)\",\n \"first_online_payment\": false,\n \"amount_detail\": [\n {\n \"amount\": 12204,\n \"creditor\": \"worldlink\",\n \"particular\": \"Internet\",\n \"creditorPan\": \"300073250\"\n }\n ],\n \"amount\": 12204,\n \"session_id\": 22906,\n \"status\": true\n}\n
"},{"location":"Internet/worldlink/#response-for-package-non-switchable-users-with-due-payment","title":"Response for Package Non-Switchable Users with Due Payment","text":"Example Response:
\n\n{ \n \"username\": \"online_due_payment\", \n \"full_name\": \"Online Due Payment\", \n \"branch\": \"MANIGRAM\", \n \"subscribed_package_name\": \"Value Standard 25mbps/3mths 1TV (Renew)\", \n \"subscribed_package_type\": \"Unlimited\", \n \"days_remaining\": 0, \n \"message\": \"You have due payment.\", \n \"package_options\": [], \n \"renew_option\": false, \n \"first_online_payment\": false, \n \"amount_detail\": [ \n { \n \"particular\": \"Internet\", \n \"amount\": 4950 \n } \n ], \n \"amount\": 4950, \n \"session_id\": 224, \n \"status\": true \n}\n
"},{"location":"Internet/worldlink/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/worldlink-v2/
\nRequest Method: POST
\nService Params:
\n\n{ \n \"token\": \"token\", \n \"session_id\": \"\", \n \"amount\": 4950, \n \"package_id\": \"\", // OPTIONAL - Required when a package is selected \n \"reference\": \"\" \n}\n\n\nResponse:
\nSuccess Response:
\n\n{ \n \"status\": true, \n \"state\": \"Success\", \n \"message\": \"Successfully Completed Transaction\", \n \"extra_data\": {}, \n \"detail\": \"Transaction successful\", \n \"id\": 5033 \n}\n
\n\nError Response:
\n\n{ \n \"status\": false, \n \"error_code\": \"4000\", \n \"message\": \"Can't fulfill request\", \n \"error\": \"client_error\", \n \"details\": \"Customer not found.\", \n \"error_data\": {}, \n \"state\": \"Error\" \n}\n
"},{"location":"Internet/hashcnet/v1/","title":"HashCNet V1","text":"This document provides the necessary information for interacting with the HashCNet APIs, detailing the required parameters and expected responses for both fetching user details and processing payments.
Note: Below is the list of ISPs under HashCNet and their service slugs:
"},{"location":"Internet/hashcnet/v1/#askina-askina","title":"Askina: askina","text":""},{"location":"Internet/hashcnet/v1/#kshireshwar-network-kshireshwar-network","title":"Kshireshwar Network: kshireshwar-network","text":""},{"location":"Internet/hashcnet/v1/#life-net-life-net","title":"Life Net: life-net","text":""},{"location":"Internet/hashcnet/v1/#limpid-ict-solution-limpid-ict-solution","title":"Limpid ICT Solution: limpid-ict-solution","text":""},{"location":"Internet/hashcnet/v1/#lnt-infotech-lnt-infotech","title":"LNT Infotech: lnt-infotech","text":""},{"location":"Internet/hashcnet/v1/#mega-cable-net-mega-cable-net","title":"Mega Cable Net: mega-cable-net","text":""},{"location":"Internet/hashcnet/v1/#nepalink-nepalink","title":"Nepalink: nepalink","text":""},{"location":"Internet/hashcnet/v1/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Internet/hashcnet/v1/#user-detail-fetch-api","title":"User Detail Fetch API","text":" - Request URL:
{{base_url}}/api/servicegroup/details/hashcnet/ - Request Method: POST
"},{"location":"Internet/hashcnet/v1/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"reference\": \"\\ unique reference\\ \",\n \"username\": \"pnt_test\",\n \"service_slug\": \"lnt-infotech\" // Service slug from above list\n}\n
"},{"location":"Internet/hashcnet/v1/#response-example","title":"Response Example","text":"\n{\n \"package_name\": \"FOC users / 6M\",\n \"total_amount\": 10,\n \"session_id\": 21,\n \"status\": true\n}\n
"},{"location":"Internet/hashcnet/v1/#payment-api","title":"Payment API","text":" - Request URL:
{{base_url}}/api/servicegroup/commit/hashcnet/ - Request Method: POST
"},{"location":"Internet/hashcnet/v1/#service-params_1","title":"Service Params","text":"\n{\n \"session_id\": 172,\n \"reference\": \"reference123\",\n \"token\": \"Test_token\",\n \"package_name\": \"FOC users / 6M\", // Package name from the service params in detail fetch API\n \"amount\": 1150.00\n}\n
"},{"location":"Internet/hashcnet/v1/#response-example_1","title":"Response Example","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Payment successfully created.\",\n \"credits_consumed\": 1150.0,\n \"credits_available\": 96790035.7550002,\n \"id\": 5884\n}\n
"},{"location":"Internet/hashcnet/v2/","title":"HashCNet V2","text":"This document provides the necessary information for interacting with the HashCNet V2 API, detailing the required parameters and expected responses for fetching user details.
Note: Below is the list of ISPs under HashCNet and their service slugs:
"},{"location":"Internet/hashcnet/v2/#airson-internet-airson-internet","title":"Airson Internet: airson-internet","text":""},{"location":"Internet/hashcnet/v2/#broadband-solutions-broadband-solutions","title":"Broadband Solutions: broadband-solutions","text":""},{"location":"Internet/hashcnet/v2/#everest-wireless-everest-wireless","title":"Everest Wireless: everest-wireless","text":""},{"location":"Internet/hashcnet/v2/#fast-speed-fast-speed","title":"Fast Speed: fast-speed","text":""},{"location":"Internet/hashcnet/v2/#fiberworld-communication-fiberworld-communication","title":"Fiberworld Communication: fiberworld-communication","text":""},{"location":"Internet/hashcnet/v2/#hons-hons","title":"Hons: hons","text":""},{"location":"Internet/hashcnet/v2/#janaki-cable-network-janaki-cable-network","title":"Janaki Cable Network: janaki-cable-network","text":""},{"location":"Internet/hashcnet/v2/#sahaj-network-sahaj-network","title":"Sahaj Network: sahaj-network","text":""},{"location":"Internet/hashcnet/v2/#super-eight-networks-super-eight-networks","title":"Super Eight Networks: super-eight-networks","text":""},{"location":"Internet/hashcnet/v2/#ultra-net-ultra-net","title":"Ultra Net: ultra-net","text":""},{"location":"Internet/hashcnet/v2/#unified-communication-isp-unified-communication-isp","title":"Unified Communication ISP: unified-communication-isp","text":""},{"location":"Internet/hashcnet/v2/#bbn-internet-bbn-internet","title":"BBN Internet: bbn-internet","text":""},{"location":"Internet/hashcnet/v2/#pokhara-internet-lekhnath-pokhara-internet-lekhnath","title":"Pokhara Internet Lekhnath: pokhara-internet-lekhnath","text":""},{"location":"Internet/hashcnet/v2/#vns-vns","title":"VNS: vns","text":""},{"location":"Internet/hashcnet/v2/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Internet/hashcnet/v2/#user-detail-fetch-api","title":"User Detail Fetch API","text":" - Request URL: {{base_url}}/api/servicegroup/details/hashcnet-v2/
- Request Method: POST
"},{"location":"Internet/hashcnet/v2/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"reference\": \"unique reference\",\n \"username\": \"jeetenaug4\",\n \"service_slug\": \"\\ service_slug\\ \" // Service slug from above list\n}\n
"},{"location":"Internet/hashcnet/v2/#response-example","title":"Response Example","text":"\n{\n \"customer_name\": \"jeetenaug4(23123213)\",\n \"current_plan\": \"Fiber Gold\",\n \"accept_advance_payment\": true,\n \"days_remaining\": 314,\n \"has_due\": \"false\",\n \"plan_detail\": [\n {\n \"duration\": \"1 month(s)\",\n \"duration_title\": \"1 month\",\n \"total_cost\": 1232.0,\n \"duration_code\": \"1\"\n },\n {\n \"duration\": \"3 month(s)\",\n \"duration_title\": \"3 months\",\n \"total_cost\": 7876.0,\n \"duration_code\": \"3\"\n },\n {\n \"duration\": \"6 month(s)\",\n \"duration_title\": \"6 months\",\n \"total_cost\": 15750.0,\n \"duration_code\": \"6\"\n },\n {\n \"duration\": \"12 month(s)\",\n \"duration_title\": \"12 months\",\n \"total_cost\": 15750.0,\n \"duration_code\": \"12\"\n },\n {\n \"duration\": \"custom_2 month(s)\",\n \"duration_title\": \"15 Days\",\n \"total_cost\": 1634.0,\n \"duration_code\": \"custom_2\"\n },\n {\n \"duration\": \"custom_3 month(s)\",\n \"duration_title\": \"60 Days\",\n \"total_cost\": 859.0,\n \"duration_code\": \"custom_3\"\n }\n ],\n \"available_packages\": [\n {\n \"title\": \"Fiber Gold\",\n \"package_code\": 9,\n \"duration\": [\n {\n \"total_cost\": 1232,\n \"duration_code\": \"1\",\n \"duration_title\": \"1 Month\"\n },\n {\n \"total_cost\": 7876,\n \"duration_code\": \"3\",\n \"duration_title\": \"3 Months\"\n },\n {\n \"total_cost\": 15750,\n \"duration_code\": \"6\",\n \"duration_title\": \"6 Months\"\n },\n {\n \"total_cost\": 15750,\n \"duration_code\": \"12\",\n \"duration_title\": \"12 Months\"\n },\n {\n \"total_cost\": 1634,\n \"duration_code\": \"custom_2\",\n \"duration_title\": \"15 Days\"\n },\n {\n \"total_cost\": 859,\n \"duration_code\": \"custom_3\",\n \"duration_title\": \"60 Days\"\n }\n ]\n },\n {\n \"title\": \"FTTH-50Mbps\",\n \"package_code\": 9,\n \"duration\": [\n {\n \"total_cost\": 999,\n \"duration_code\": \"1\",\n \"duration_title\": \"1 Month\"\n },\n {\n \"total_cost\": 2800,\n \"duration_code\": \"3\",\n \"duration_title\": \"3 Months\"\n },\n {\n \"total_cost\": 5300,\n \"duration_code\": \"6\",\n \"duration_title\": \"6 Months\"\n },\n {\n \"total_cost\": 9999,\n \"duration_code\": \"12\",\n \"duration_title\": \"12 Months\"\n },\n {\n \"total_cost\": 13500,\n \"duration_code\": \"custom_1\",\n \"duration_title\": \"12M + 1 IPTV\"\n }\n ]\n },\n {\n \"title\": \"TESTING\",\n \"package_code\": 71,\n \"duration\": [\n {\n \"total_cost\": 2,\n \"duration_code\": \"1\",\n \"duration_title\": \"1 Month\"\n }\n ]\n }\n ],\n \"session_id\": 6466,\n \"status\": true\n}\n
"},{"location":"Internet/hashcnet/v2/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/hashcnet-v2/
Request Method: POST
Service Params:
\n{ \n \"session id\": 6466, \\\\ session id from detail fetch API \n \u201creference\u201d: \u201cunique identifier\u201d, \n \"token\": \"Test token\", \n \"package code\": \u201c9\u201d, \n \u201cduration code\u201d:\u201d1\u201d, \n \u201camount\": 999.00 \n}\n
Response:
\n{ \n \"status\": true, \n \"state\": \"Success\", \n \"message\": \"Successfully Completed Transaction\", \n \"extra data\": {}, \n \"detail\": \"2532\", \n \"credits consumed\": 999.0, \n \"credits available\": 9995285594.37663, \n \"id\": 70704 \n}\n
"},{"location":"Khaltitopup/khaltitopup/","title":"Khalti Topup","text":""},{"location":"Khaltitopup/khaltitopup/#api-endpoint","title":"API Endpoint","text":" - URL:
{{base_url}}/api/use/khalti-topup/ - TYPE: Single Step API
- METHOD: POST
"},{"location":"Khaltitopup/khaltitopup/#service-parameters","title":"Service Parameters","text":"Parameter Description token The token provided for authentication. reference A unique reference for the transaction. amount The amount to be recharged. number Khalti ID to which the top-up is to be done (e.g., 9841234567). remarks Optional field for any additional remarks. \n{\n \"token\": \"token-provided\",\n \"reference\": \"unique-reference\",\n \"amount\": \"amount to be recharged\",\n \"number\": \"Unique Khalti ID to which TOPUP is to be done, eg: 9841234567\",\n \"remarks\": \"Remarks (Optional Field)\"\n}\n
"},{"location":"Khaltitopup/khaltitopup/#regex-patterns","title":"Regex Patterns:","text":"\n\n[\n {\n \"name\": \"NTC\",\n \"slug\": \"ntc\",\n \"pattern\": \"(9[8][46][0-9]{7})\",\n \"error_message\": \"Invalid mobile number\"\n },\n {\n \"name\": \"Ncell\",\n \"slug\": \"ncell\",\n \"pattern\": \"(9[8][0-2][0-9]{7})\",\n \"error_message\": \"Invalid mobile number\"\n },\n {\n \"name\": \"Smartcell\",\n \"slug\": \"smartcell\",\n \"pattern\": \"(9[6][0-9]{8}|9[8][8][0-9]{7})\",\n \"error_message\": \"Invalid mobile number\"\n },\n {\n \"name\": \"NT CDMA\",\n \"slug\": \"nt-cdma\",\n \"pattern\": \"(9[7][4-5][0-9]{7})\",\n \"error_message\": \"Invalid mobile number\"\n },\n {\n \"name\": \"NT Postpaid\",\n \"slug\": \"nt-postpaid\",\n \"pattern\": \"(9[8][5][0-9]{7})\",\n \"error_message\": \"Invalid mobile number\"\n }\n]\n
"},{"location":"Khaltitopup/khaltitopup/#success-response","title":"Success Response","text":"\n{\n \"id\": 3116,\n \"extra_data\": {},\n \"state\": \"Success\",\n \"detail\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"status\": true\n}\n
"},{"location":"Khaltitopup/khaltitopup/#error-response","title":"Error Response","text":"\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": {\n \"user\": [\n \"User does not exist.\"\n ],\n \"http_status_code\": 400\n },\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"Khanepani/khanepani/","title":"Khanepani","text":""},{"location":"Khanepani/khanepani/#khanepani-counters","title":"Khanepani Counters","text":"URL: {{base_url}}/api/servicegroup/counters/khanepani/ Method: POST
Request Body:
\n{\n \"token\": \"token\"\n}\n
Response:
\n{\n \"counters\": [\n {\n \"name\": \"Sandhikharka\",\n \"value\": \"268:sandhikharka-khanepani\"\n },\n {\n \"name\": \"Itahari\",\n \"value\": \"3:itahari-khanepani\"\n }\n ],\n \"status\": true\n}\n
Description: Retrieve a list of available Khanepani counters.
"},{"location":"Khanepani/khanepani/#khanepani-details","title":"Khanepani Details","text":"URL: {{base_url}}/api/servicegroup/details/khanepani/ Method: POST
Request Body:
\n{\n \"month_id\": \"number (1 to 12 inclusive)\",\n \"customer_code\": \"numeric value, e.g., 12\",\n \"counter\": \"one of the 'value' fields from the response above (e.g., 268:sandhikharka-khanepani)\",\n \"token\": \"Provided token\"\n}\n
Response:
\n{\n \"status\": true,\n \"customer_code\": \"1235\",\n \"customer_name\": \"\u092a\u0941\u0930\u094d\u0923 \u0915\u0941\u092e\u093e\u0930\",\n \"address\": \"\u0907\u091f\u0939\u0930\u0940-6, \u0938\u0902\u0917\u0940\u0924 \u091a\u094c\u0915\",\n \"mobile_number\": \"9841123456\",\n \"current_month_dues\": \"3000\",\n \"current_month_discount\": \"50\",\n \"current_month_fine\": \"0\",\n \"total_credit_sales_amount\": \"100\",\n \"total_advance_amount\": \"1000\",\n \"previous_dues\": \"0\",\n \"total_dues\": \"2950\"\n}\n
Description: Fetch details for a specific Khanepani customer, including dues, discounts, and other relevant information.
"},{"location":"Khanepani/khanepani/#khanepani-service-charge","title":"Khanepani Service Charge","text":"URL: {{base_url}}/api/servicegroup/servicecharge/khanepani/
Note: Khanepani service charge is Rs. 5 per transaction.
Request Body:
\n{\n \"counter\": \"Counter Name\",\n \"token\": \"token\",\n \"amount\": \"Amount from detail fetch API\"\n}\n
Response:
\n{\n \"amount\": 600,\n \"service_charge\": 5,\n \"status\": true\n}\n
Description: Calculate the service charge for the specified amount. The service charge applies to every transaction.
"},{"location":"Khanepani/khanepani/#khanepani-payment","title":"Khanepani Payment","text":"URL: {{base_url}}/api/servicegroup/commit/khanepani/ Method: POST
Request Body:
\n{\n \"token\":\"token\",\n \"reference\": \"unique value sent for each request\",\n \"customer_code\": \"numeric value, e.g., 12\",\n \"counter\": \"one of the 'value' fields from the response above (e.g.268:sandhikharka-khanepani)\",\n \"amount\": 5000\n}\n
Note: The amount in the payment API is without the service charge; the charge amount will be deducted from the service account.
Response (Successful Payment):
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 309,\n \"credits_available\": 35456464.966469494,\n \"id\": 78897534\n}\n
Response (Due Amount):
\n{\n \"status\": true,\n \"detail\": {\n \"message\": \"Successful Payment\",\n \"due_amount\": \"1361\"\n },\n \"message\": \"Successfully Completed Transaction\",\n \"id\": 181868,\n \"extra_data\": {},\n \"state\": \"Success\",\n \"due_amount\": \"1361\"\n}\n
Description: Process the payment for the specified amount and handle due amounts accordingly.
"},{"location":"Khanepani/Kukl/Kukl-Details/","title":"KUKL Khanepani Customer Details Fetch","text":""},{"location":"Khanepani/Kukl/Kukl-Details/#api-endpoint","title":"API Endpoint","text":"URL: {{base_url}}/api/servicegroup/details/kukl/
Method: POST
"},{"location":"Khanepani/Kukl/Kukl-Details/#request","title":"Request","text":"The request must include the following body parameters:
"},{"location":"Khanepani/Kukl/Kukl-Details/#important-note","title":"Important Note:","text":" - If
customer_code is provided, the connection_no should not be sent. - If
connection_no is provided, the customer_code should not be sent. - One of these fields, customer_code or connection_no, is required but not both.
"},{"location":"Khanepani/Kukl/Kukl-Details/#example-request-body","title":"Example Request Body:","text":"\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"counter\": \"1114:test-kukl\",\n \"customer_code\": \"1114003014\"\n}\n
or
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"counter\": \"1114:test-kukl\",\n \"connection_no\": \"9352\"\n}\n
"},{"location":"Khanepani/Kukl/Kukl-Details/#response","title":"Response","text":"A successful response will return the following JSON format:
\n{\n \"status\": true,\n \"customer_code\": \"1114013895\",\n \"connection_no\": \"123321323\",\n \"customer_name\": \"RABI MAN MANNANDHAR\",\n \"address\": \"DHOKA BAHAL\",\n \"area_no\": \"27-03-25GHA\",\n \"bill_month\": \"207809\",\n \"current_month_fine\": 0,\n \"total_advance_amount\": 0,\n \"amount\": 141.85,\n \"unapproved_adjustment\": 123.12,\n \"unapproved_penalty\": 23.45,\n \"minimum_payable_amount\": 141.85,\n \"session_id\": 2630\n}\n
"},{"location":"Khanepani/Kukl/Kukl-payment/","title":"KUKL Commit Payment Details","text":""},{"location":"Khanepani/Kukl/Kukl-payment/#api-endpoint","title":"API Endpoint","text":"URL: {{base_url}}/api/servicegroup/commit/kukl/
Method: POST
"},{"location":"Khanepani/Kukl/Kukl-payment/#request","title":"Request","text":"The request must include the following body parameters:
"},{"location":"Khanepani/Kukl/Kukl-payment/#parameters","title":"Parameters:","text":" token: {{token}} (required)session_id: 953 (required)payment_type: \"Bill Payment\" (required)amount: 10 (required)
"},{"location":"Khanepani/Kukl/Kukl-payment/#example-request-body","title":"Example Request Body:","text":"\n{\n \"token\": \"{{token}}\",\n \"session_id\": 953,\n \"payment_type\": \"Bill Payment\",\n \"amount\": 10\n}\n
"},{"location":"Khanepani/Kukl/Kukl-payment/#response","title":"Response","text":"A successful response will return the following JSON format:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"receipt_no\": \"111410781000000063\"\n },\n \"detail\": \"Success\",\n \"credits_consumed\": 1000.0,\n \"credits_available\": -999.0300000000038,\n \"id\": 147494\n}\n
"},{"location":"Khanepani/Kukl/counter/","title":"KUKL Khanepani Counter Details","text":""},{"location":"Khanepani/Kukl/counter/#api-endpoint","title":"API Endpoint","text":"URL: {{base_url}}/api/servicegroup/counters/kukl/
Method: POST
"},{"location":"Khanepani/Kukl/counter/#request","title":"Request","text":"The request should include the following body:
\n{\n \"token\": \"{{token}}\"\n}\n
"},{"location":"Khanepani/Kukl/counter/#response","title":"Response","text":"A successful response will return the following JSON format:
\n{\n \"status\": true,\n \"counters\": [\n {\n \"name\": \"Chettrapati\",\n \"value\": \"1114:test-kukl\"\n }\n ]\n}\n
"},{"location":"MobileTopup/ncell/","title":"Ncell API","text":""},{"location":"MobileTopup/ncell/#overview","title":"Overview","text":"The Ncell API endpoint allows you to perform a single-step transaction. This API requires a POST request and provides information about the success or failure of the transaction.
URL: {{base_url}}/api/use/ncell/ Type: Single Step API Method: POST
"},{"location":"MobileTopup/ncell/#request-parameters","title":"Request Parameters","text":"The following parameters are required in the POST request:
- number: 10-digit mobile number
- token: Authentication token
- reference: Unique reference for the transaction
- amount: Amount between 50 to 25000
"},{"location":"MobileTopup/ncell/#valid-amounts","title":"Valid Amounts","text":" - From 50 to 5000
"},{"location":"MobileTopup/ncell/#request-example","title":"Request Example","text":"\n{\n \"token\": \"Token Provided\",\n \"reference\": \"unique-reference\",\n \"amount\": \"amount\",\n \"number\": \"number(eg:9801234567)\"\n}\n
"},{"location":"MobileTopup/nepal_telecom/","title":"Nepal Telecom (NTC) API","text":"The Nepal Telecom API endpoint allows you to perform a single-step transaction. This API requires a POST request and provides information about the success or failure of the transaction.
"},{"location":"MobileTopup/nepal_telecom/#api-details","title":"API Details","text":" - URL:
{{base_url}}/api/use/ntc/ - Type: Single Step API
- Request Type: POST
"},{"location":"MobileTopup/nepal_telecom/#parameters","title":"Parameters","text":" - number: 10-digit mobile number (NT Prepaid, NT Postpaid, NT CDMA Prepaid & Postpaid)
- token: Authentication token
- reference: Unique reference identifier
- amount: Between 10 to 25,000
"},{"location":"MobileTopup/nepal_telecom/#request-format","title":"Request Format","text":"The request body should be in JSON format:
\n{\n \"token\": \"Token Provided\",\n \"reference\": \"unique-reference\",\n \"amount\": \"amount\",\n \"number\": \"number\"\n}\n
"},{"location":"MobileTopup/nepal_telecom/#response-format","title":"Response Format","text":"\n{\n \"token\": \"Token Provided\",\n \"reference\": \"unique-reference\",\n \"amount\": \"amount\",\n \"number\": \"number\"\n}\n
"},{"location":"PSTN/landline/","title":"PSTN (Landline) API Documentation","text":""},{"location":"PSTN/landline/#overview","title":"Overview","text":"The PSTN (Landline) API allows you to process landline recharge operations. This API supports a single request method and requires specific parameters for successful processing.
"},{"location":"PSTN/landline/#endpoint","title":"Endpoint","text":"URL: {{base_url}}/api/use/landline/ Type: Single Step API Request Method: POST
"},{"location":"PSTN/landline/#request-parameters","title":"Request Parameters","text":" -
number: 8-digit number (area code without 0 and landline number) Example: 15522942 Regex Pattern: (\\[0-9\\]{8}) Error Message: \"Invalid LandLine number\"
-
token: <token-provided>
- reference:
<unique-reference> - amount:
<amount> Amount should be between Rs.10 and Rs.10,000
"},{"location":"PSTN/landline/#request-example","title":"Request Example","text":"\n{\n \"token\": \"token-provided\",\n \"reference\": \"unique-reference\",\n \"amount\": \"amount\",\n \"number\": \"number\"\n}\n
"},{"location":"PSTN/landline/#responses","title":"Responses","text":""},{"location":"PSTN/landline/#success-response","title":"Success Response","text":"\n{\n \"id\": 165,\n \"credits_consumed\": 10.0,\n \"status\": true,\n \"state\": \"Queued\",\n \"message\": \"Your operation has been submitted for processing.\",\n \"credits_available\": 1170\n\n}\n
"},{"location":"PSTN/landline/#unsuccessful-response","title":"Unsuccessful Response","text":"\n{\n \"error_code\": \"1010\",\n \"message\": \"Validation error\",\n \"status\": false,\n \"error_data\": {\n // Present for validation errors (codes 1010, 1011) specifying errors corresponding to fields\n },\n \"details\": \"\"\n}"},{"location":"Rc%20card/rccard/","title":"RC Card API Documentation","text":""},{"location":"Rc%20card/rccard/#overview","title":"Overview","text":"The RC Card API allows you to process recharge operations for various service providers. The API supports different methods for each service, with specific parameters and valid amounts for each.
"},{"location":"Rc%20card/rccard/#endpoint","title":"Endpoint","text":"URL: {{base_url}}/api/use/<method>/ Type: Single Step API Request Method: POST
"},{"location":"Rc%20card/rccard/#methods","title":"Methods","text":" - dishhome-erc
- ntc-erc
- utl-erc (Deprecated)
- smart-erc
- broadlink-erc
- nettv-erc (Deprecated)
"},{"location":"Rc%20card/rccard/#valid-amounts","title":"Valid Amounts","text":" - dishhome-erc: 500, 1000, 2000, 3000, 4000, 5000, 6000, 7000, 9000, 10000
- ntc-erc: 100, 200, 500, 1000
- utl-erc: 100, 250, 500 (This service is discontinued)
- smart-erc: 50, 100, 200
- broadlink-erc: 570, 1300, 2600, 2260
- nettv-erc: 50, 100, 200, 500, 1000 (This service is discontinued)
"},{"location":"Rc%20card/rccard/#request-parameters","title":"Request Parameters","text":"\n{\n \"token\": \"\",\n \"reference\": \"\",\n \"amount\": \"\"\n}"},{"location":"Rc%20card/rccard/#responses","title":"Responses","text":""},{"location":"Rc%20card/rccard/#success-response","title":"Success Response","text":"\n{\n \"id\": 165,\n \"status\": true,\n \"state\": \"Success\",\n \"serial\": \"\",\n \"pin\": \"\",\n \"message\": \"Your operation has been submitted for processing.\",\n \"credits_available\": 1170\n}"},{"location":"Rc%20card/rccard/#unsuccessful-response","title":"Unsuccessful Response","text":"\n{\n \"error_code\": \"1010\",\n \"message\": \"Validation error\",\n \"status\": false,\n \"error_data\": {\n // Present for validation errors (codes 1010, 1011) specifying errors corresponding to fields\n },\n \"details\": \"\"\n}"},{"location":"Ride/cabtm/","title":"12.2 CABTM","text":"Type: Multi-Step API
"},{"location":"Ride/cabtm/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: http://uatservices.khalti.com/api/servicegroup/details/cabtm/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"reference\": \"Unique Identifier\",\n \"mobile_number\": \"9779821587036\"\n}\n
Response:
\n{\n \"customer_name\": \"Test Shrestha\",\n \"balance\": 578.56,\n \"mobile_number\": \"+9779821587036\",\n \"status\": true,\n \"dob\": \"1994-09-30\",\n \"role\": \"driver\",\n \"session_id\": 2319\n}\n
Fields:
- customer_name: The name of the customer.
- balance: The current balance of the customer.
- mobile_number: The mobile number of the customer.
- status: Indicates whether the API call was successful (
true). - dob: The date of birth of the customer.
- role: The role of the customer (e.g., \"driver\").
- session_id: The unique session ID for the transaction.
"},{"location":"Ride/cabtm/#2-payment-api","title":"2. Payment API","text":"Request URL: http://uatservices.khalti.com/api/servicegroup/commit/cabtm/
Request Method: POST
Service Params:
\n{\n \"token\": \"\",\n \"mobile_number\": \"9779821587036\",\n \"amount\": \"1708.00\",\n \"reference\": \"Unique Reference\",\n \"session_id\": \"2319\" \n}\n\n\nResponse:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 1205.0,\n \"credits_available\": 9999553668.38,\n \"id\": 36223\n}\n
\n\nFields:
\n\n- status: Indicates whether the API call was successful (
true). \n- state: The state of the transaction (
Success). \n- message: A message indicating the result of the transaction (
Successfully Completed Transaction). \n- extra_data: Any additional data related to the transaction.
\n- detail: Additional details about the payment, including a confirmation message (
Success). \n- credits_consumed: The total credits consumed for this transaction.
\n- credits_available: The total credits available after this transaction.
\n- id: The unique ID associated with the transaction.
\n
"},{"location":"Ride/tootle/","title":"Tottle","text":""},{"location":"Ride/tootle/#12-ride","title":"12. Ride","text":""},{"location":"Ride/tootle/#121-tootle-topup","title":"12.1. Tootle Topup","text":""},{"location":"Ride/tootle/#tootle-fetch-detail-api","title":"Tootle Fetch Detail API","text":"Request URL: {{base_url}}/api/servicegroup/details/tootle/
Request Method: POST
Service Params:
\n{\n \"token\": \"token provided\",\n \"app\": \"client/partner\", \n \"number\": \"registered mobile number\"\n}\n
Note: Choose client for topping up the client application and partner for topping up the partner application.
Regex:
\n[\n {\n \"name\": \"Smart Card Id\",\n \"slug\": \"\",\n \"pattern\": \"^([9][678][0-9]{8})$\",\n \"error_message\": \"Invalid ID\"\n }\n]\n
Response:
\n{\n \"product_identity\": \"D-31\",\n \"status\": true,\n \"gender\": \"Female\",\n \"number\": \"9841579738\",\n \"name\": \"Bina Laxmi Shrestha\"\n}\n
Fields: - product_identity: The unique identity of the product. - status: Indicates whether the API call was successful (true). - gender: The gender of the customer. - number: The registered mobile number of the customer. - name: The name of the customer.
"},{"location":"Ride/tootle/#tootle-commit-api","title":"Tootle Commit API","text":"Request URL: {{base_url}}/api/servicegroup/commit/tootle/
Request Method: POST
Service Params:
\n{\n \"token\": \"token provided\",\n \"product_identity\": \"obtained from detail API\",\n \"number\": \"registered mobile number\",\n \"amount\": \"amount to topup\",\n \"reference\": \"Unique reference id\"\n}\n
Response:
\n{\n \"id\": 3856,\n \"state\": \"Success\",\n \"extra_data\": {},\n \"detail\": {\n \"message\": \"Tootle topped up successfully for user Bina\"\n },\n \"status\": true,\n \"message\": \"Successfully Completed Transaction\"\n}\n
Fields: - id: The unique ID associated with the transaction. - state: The state of the transaction (Success). - extra_data: Any additional data related to the transaction. - detail: Additional details about the top-up, including a confirmation message. - status: Indicates whether the API call was successful (true). - message: A message indicating the result of the transaction (Successfully Completed Transaction).
This documentation provides the details for fetching user information and processing top-ups for the Tootle service.
"},{"location":"Servicescodes/balance_check/","title":"Balance Check API Documentation","text":""},{"location":"Servicescodes/balance_check/#balance-check-api","title":"Balance Check API","text":" - URL: {{base_url}}/api/balance
- Method: GET
"},{"location":"Servicescodes/balance_check/#request-parameters","title":"Request Parameters","text":"\n\n{\n \"token\": \"Provided Token\"\n}\n\n
"},{"location":"Servicescodes/balance_check/#success-response","title":"Success Response","text":"\n\n{\n \"credits_consumed\": 777099.369900001,\n \"credits_available\": 161155.5\n}\n
"},{"location":"Servicescodes/balance_check/#credits-by-date-api","title":"Credits by Date API","text":"URL: {{base_url}}/api/credits/bydate/
Method: POST
Request Parameters
\n\n{\n \"token\": \"\",\n \"date\": \"yy-mm-dd\"\n}"},{"location":"Servicescodes/balance_check/#success-response_1","title":"Success Response","text":"\n\n{\n \"credits_available\": 454135.30317999,\n \"status\": true\n}\n
"},{"location":"Servicescodes/balance_check/#failure-response","title":"Failure Response","text":"\n{\n \"detail\": \"Something Went Wrong\",\n \"status\": false\n}\n
"},{"location":"Servicescodes/balance_check/#credit-request-api","title":"Credit Request API","text":"URL: {{base_url}}/api/public/creditrequest/
\nMethod: POST
\nRequest Parameters
\n\n{\n \"token\": \"provided_token\",\n \"credit\": \"Credit to be requested in float\"\n}\n
"},{"location":"Servicescodes/balance_check/#success-response_2","title":"Success Response","text":"HTTP Status: 200 OK
\n\n{\n \"status\": true,\n \"detail\": \"Credit Requested\"\n}\n
"},{"location":"Servicescodes/balance_check/#error-response","title":"Error Response","text":"HTTP Status: 400
\n\n{\n \"status\": false,\n \"detail\": \"Invalid Credit\"\n}\n
"},{"location":"Servicescodes/balance_check/#mobile-operator-regular-expressions","title":"Mobile Operator Regular Expressions","text":"\n{\n \"^([98][50-9][0-9]{7})$\": \"nt-postpaid\",\n \"^([98][46][0-9]{7})$\": \"ntc\",\n \"^([97][4-5][0-9]{7})$\": \"nt-cdma\",\n \"^([98][0-2][0-9]{7})$\": \"ncell\",\n \"^([96][0-9]{8}|[98][8][0-9]{7})$\": \"smartcell\"\n}\n
"},{"location":"Servicescodes/bulkservice/","title":"BULK SERVICE STATUS LOOKUP API","text":"URL: {{base_url}}/api/service/bulk/status/
METHOD: GET
Service Params:
\n{\n \"token\": \"\",\n \"references\": \"JNK123,JNK124\", # Comma separated references\n \"reference_length\": 2 # Number of references sent\n}\n\n\nResponse:
\n\n{\n \"status\": true,\n \"message\": \"Success\",\n \"detail\": [\n {\n \"status\": true,\n \"state\": \"Success\",\n \"details\": \"Payment made successfully. Account will be activated in few minutes\",\n \"reference\": \"cPCWiH2UPDjy8mjPyPXtPF\",\n \"response_id\": 15845,\n \"amount\": 1400.0\n },\n {\n \"status\": true,\n \"state\": \"Error\",\n \"details\": \"Invalid reference obtained for account\",\n \"reference\": \"JNK2\",\n \"response_id\": 0,\n \"amount\": 0\n },\n {\n \"status\": true,\n \"state\": \"Processing\",\n \"details\": \"\",\n \"reference\": \"8535\",\n \"response_id\": 15686,\n \"amount\": 2000.0\n },\n {\n \"status\": true,\n \"state\": \"Queued\",\n \"details\": \"\",\n \"reference\": \"f309e75f-3101-4139-bfa1-e7dff44e4276\",\n \"response_id\": 15524,\n \"amount\": 3046.0\n }\n ]\n}\n
\n\nNOTE: Always check the state to make success/failure decisions. The list of possible states is listed Previous Page.
"},{"location":"Servicescodes/changelog/","title":"Changelog","text":""},{"location":"Servicescodes/changelog/#change-log","title":"Change Log","text":"Version 7.2, Janaury 9th 2025
- Updated Worldlink docs
Version 7.1, Janaury 9th 2025
- Updated Vianet docs
Version 7.0, December 26 2024
- Added Kukl Docs
Version 6.9, Novemeber 12 2024
- Updated Service layer status
Version 6.8 October 24 2024
- Updated Typo mistake
Version 6.7 October 24 2024
-
Added Bus v2 API
-
Added Max tv
-
Update the bluebook api details
Version 6.6 October 3 2024
- Updated Typo mistake in Khanepani
Version 6.5 September 24 2024
- Shifted Internet Chitrawan Unique Net from Konnect (KCMS) : vns to Chitrawan Unique Net
Version 6.5 September 24 2024
- Added Nettv in Tv Section
Version 6.4 September 12 2024
- Updated Docs
Version 6.3 August 12 2024
- Updated Ncell Topup API. Please refer to 2.2 Ncell
Version 6.2 July 10 2024
- Updated Ncell data API. Please refer to 18/. Ncell Data Pack
- Updated Ntc data API. Please refer to 19/. NTC Data Pack
Version 6.1 June 24 2024
- Updated Shikhar Insurance API. Please refer to 11.26 Arhant Non Life Insurance
Version 6.0 June 18 2024
- Updated NT FTTH API Document.8.21. NT FTTH There is no change in API, updated the Note from \u201cInitial 6 characters are always constant /- ie. 100000\u201d to \u201cInitial 5 characters are always constant /- ie. 10000\u201d.
Version 5.9 June 11 2024
- Added New Service Wifi nepal in 8.44 Wifi Nepal
- Updated the Kaspersky API in 10.1. Kaspersky API
Version 5.8 May 31 2024
- Shifted Internet VNS from 8.42 Vns : vns to 8.25. HashCNet V2
Version 5.7 April 25 2024
- Updated ticket download API for Service Cable car in 21/. Cable Car
Version 5.6 March 26 2024
- Added New Service Cable car in 21/. Cable Car
Version 5.5 March 18 2024
- Updated the package response in 8.43 Dish Home
Version 5.4 Feb 18 2024
- Added the FAQ Section
- Updated the typo mistakes in 8.43 Dish Home
Version 5.3 Feb 15 2024
- Updated the typo mistakes in 8.43 Dish Home
Version 5.2 Feb 8 2024
- Updated the Dish home API 8.43 Dish Home Removed 8.40 Dishhome combo , 8.38. Dishhome ftth, 7.1 Dishhome
Version 5.1 Jan 28 2024
- Updated the typo mistakes in 20.4 Softlab Electricity
Version 5.0 Jan 18 2024
- Added Watermark electricity in the Community Electricity Section. 20.2 Watermark Electricity
- Added Dreamer electricity in the Community Electricity Section. 20.3 Dreamer Electricity
- Added Softlab electricity in the Community Electricity Section. 20.4 SoftLab Electricity
Version 4.9 Jan 10 2024
- Updated the typo mistakes. in 11.18. Arhant Life Insurance
- Added Nepal Insurance in insurance section (11.23) Nepal Insurance
- Added Rastriya Beema Sasthan in insurance section (11.24) Rastriya Beema Sansthan
- Added Surya Jyoti Loan Repayment in insurance section (11.25) Surya Jyoti Loan Repayment
- Added Sun Life Insurance in insurance section (11.26) Sun Life Insurance
Version 4.8 Nov 02 2023
- Clear TV API is obsolete now. Subisu API will be used for clear tv payment. 8.2 Subisu New
Version 4.7 Oct 11 2023
- Ime Life Insurance API has been updated, Please refer to Ime Life Insurance : ime-life-insurance (11.18) for new API.
Version 4.7 Oct 9 2023
- United insurance and Ajod insurance API merge. Please use the United insurance API. United Insurance : united-insurance
Version 4.6 Sept 21 2023
- Added ultranet to 8.25 Ultra Net
Version 4.5 Sept 17 2023
- Added Smart link ISP in internet section (8.28)
- Added Pathibara Internet in internet section (8.6)
Version 4.4 August 29 2023
- Added Rapid Unique Network in internet section (8.41)
- Added Iconwave /- VNS in internet section (8.42)
Version 4.3 August 20 2023
- Added sky internet under times in internet. (8.6.4)
- Updated Chitrawan Unique Net API. Added to Konnect. (8.33)
Version 4.2 August 15 2023
- Lumbini General insurance and Sagarmatha insurance API merge. Please use Sagarmatha insurance API. Sagarmatha Insurance API has been renamed to Sagarmatha Lumbini Insurance.
- Siddhartha insurance and Premier insurance API merge. Please use Siddhartha insurance API. Siddhartha Insurance API has been renamed to Siddhartha Premier Insurance.
Version 4.1 August 14 2023
- Reliance Insurance payment API response updated, added key extra/_data in payment API response.
Version 4.0 July 31 2023
- Prabhu life insurance and Mahalaxmi life insurance API merge. Please use Prabhu LIfe insurance API.
- Prime life insurance and Union life insurance API merge to Himalayan life insurance 11.9. Prime life insurance has been renamed to Himalayan life insurance. Please use Himalayan LIfe insurance API. 11.9
- Himalayan General Insurance and Everest insurance API merge. Please use Himalayan General (HG insurance) insurance API. 11.8
- Sanima General Insurance and GIC insurance API merge. Please use Sanima General insurance API. 11.3
Version 3.9 June 30 2023
- Surya Jyoti API updated (11.5).Surya life insurance and Jyoti life insurance API merge. Please use Surya Jyoti LIfe insurance API.
Version 3.8 June 30 2023
- Subisu API updated (8.2)
Version 3.7 June 20 2023
- Pokhara Internet Lekhnath API added (8.25)
- Asian life insurance API updated (11.18)
Version 3.6 June 16 2023
- Web Network API added (8.10)
- Acme Internet API added (8.33)
Version 3.5 June 1 2023
- Sky broadband API updated. (8.35)
Version 3.4 May 22 2023
- Status code was added
Version 3.3 May 15 2023
- Subisu Internet and Tv is updated to Api based from offline to online
Version 3.2 April 28 2023
- BBN Internet shifted from HashCnet v1 to HashCnet v2
Version 3.1 April 11 2023
- Surya life insurance and Jyoti life insurance API merge. Please use Jyoti LIfe insurance API.
- Sanima life insurance and Reliance life insurance API merge. Please use Reliance LIfe insurance API.
Version 3.1 April 11 2023
- Mero TV and Sky TV is shifter under Times /- TV API
- SKY Cable /- shifted to Times /- TV(7.9) and Times /- Internet (8.6)
- SKY Topup and websurfer top-up service is removed.
Version 3.0 March 29 2023
- Updated Konnect API. Added different usernames.
- Khanepani Charge API is added
- NEA Service charge API added
Version 2.9 March 2 2023
- Updated Chitrawan Unique Net API
- Added hashcnet v2 Under Internet
- These ISP are shifted from hashcnet v1 to hashcnet v2
Airson Internet
Broadband Solutions
Everest Wireless
Fast Speed
Fiberworld Communication
Hons
Janaki Cable Network
Sahaj Network
Super Eight Networks
Ultra Net
Unified Communication Isp
- Bbn Internet is removed
Version 2.8 Feb 19 2023
- Added citizen life insurance (11.21)
- Update on sim tv denomination
Version 2.7 Jan 20 2023
- Shifted Alsiha communication from hash cnet to merosoft.
- Shifted Loop Network to Konnect
- Shifted Fast speed to hash cnet
Version 2.6 Sept 6
- Added GRS Internet
Version 2.5 Aug 5
- Unified Communication, everest wireless changed to HashCNet
- Palsnet, Reliant Technology added under times
Version 2.4 Jul 18
- Added Nt FTTH (8.23)
Version 2.3 Jun 23
- Added IME Life Insurance (11.20)
Version 2.2 Jun 17
- Added Himchuli Electricity (20.1)
- Updated websurfer API (8.6)
Version 2.1, Nov 30
- Askina changed to HashCNet
Version 2.0, May 21
- Alisha Communication API update.
Version 1.9, Jan 7
- Removed 695 denos of SIM TV
Version 1.8, Dec 31
- Added reference parameter in all the multistep/session based API.
Version 1.6, Dec 17
- Added Prime Life Insurance, Sanima Life Insurance, Nepal Life Insurance, Shikhar Insurance, Sanima General Insurance, Mahalaxmi Life Insurance
Version 1.6, Oct 1
- Added P/&G, Jagriti cable in TV payment
Version 1.5, Aug 21
- Update on sim tv denomination
Version 1.4, Aug 21
- Removed denomination below 1000 from dishome
Version 1.3, July 29
- Added Ncell Data Pack API
Version 1.2, July 3
- Service Status Changes
Version 1.1, July 1
- Added Himilayan general Insurance API
- Added Ultranet ISP API
"},{"location":"Servicescodes/dlr/","title":"DLR Sample","text":"\nContent-Type: multipart/form-data\n{\n \"reference\": \"Unique id sent by you\",\n \"amount\": \"amount\",\n \"status\": \"status\",\n \"detail\": \"detail regarding the service\",\n \"response_id\": \"response id from ntc/ncell or other provider\"\n}\n
NOTE ON FIELD VALIDATION : Enforce a length of 50 alphanumeric characters as a default validation unless explicitly mentioned.
"},{"location":"Servicescodes/dlr/#service-layer-state","title":"Service Layer State","text":"HTTP Response Code Status act Remarks 200 Success Check state in response data and proceed based on state Check state in response data and proceed based on state 400 Error Hold Need to check the transaction state to proceed. 404 Error Refund Service not found >= 500 Server error Hold Server is failed to provide the response Third Party should hold the transaction and call lookup api after at least 5 mins to get transaction status to proceed further Other any status code or No status code received Timeout Hold Server is failed to provide the response Third Party should hold the transaction and call lookup api after at least 5 mins to get transaction status to proceed further State Act Description Success Process Transaction Successful. Deduct Client amount Queued Hold Transaction in pending state. Third Party should hold the transaction and call lookup api after at least after 5 mins to get transaction status to proceed further Processing Hold Transaction in pending state. Third Party should hold the transaction and call lookup api after atleast 5 mins to get transaction status to proceed further Expired Refund Transaction not possible. Refund client amount Error Refund Transaction error. Refund Client amount Failed Refund Transaction Error. Refund Client amount. Any other state or no state received Hold Server is failed the provide the response Third Party should hold the transaction and call lookup api after atleast 5 mins to get transaction status to proceed further Timeout Hold Third Party should hold the transaction and call lookup api after atleast 5 mins to get transaction status to proceed further"},{"location":"Servicescodes/faq/","title":"FAQ's","text":""},{"location":"Servicescodes/faq/#frequently-asked-questions","title":"Frequently Asked Questions","text":"1)What is this token and which token should we use? It is a unique secret key that you have to pass along with your request that helps us identify the source of the request.It can be generated from the portal that is provided to you. You can generate two types of token. For testing purpose,you need to generate test token; which is prefixed with TEST and looks something like: TEST:O7QxjFcdueNzAh9aBOsD and for live purpose, generate LIVE token which looks something like : tqZbd7v9ei3iDczA3osT.
2) Why am I getting the response \u2018Problem using the service\u2019 ? It is required that you first request our support team for addition of service. Unless a service is added to your account, you won\u2019t be able to use that service despite fulfilling all the requirements of a legitimate request.
3) Why am I getting \u2018token_not_found\u2019 ? It is because the token sent from your end is not consistent with the token you have generated in your portal. Make sure you send the same token that you have generated.
4) Why am I getting \u2018TEST API not available for this service\u2019 ? There are few services like Movie, flight for which, currently we don\u2019t have a test environment set up. You can use live credential for testing these services. However, be careful while calling the payment API since it issues the tickets for real. Also, make sure you book flights/hotels with dates far ahead of the current date to prevent booking congestion in real time.
5) Why is it that the status of my transaction is in \u2018Processing\u2019 state for so long ? It could be because of the long processing time taken from the service provider. If the status doesn\u2019t change for a long time, you can try refreshing the transaction manually from the portal given to you. If however the issue still persists, you can call our support for details.
6) How do I add balance to my Khalti Service account ? You can add Khalti Service balance by transferring it from your Khalti account. For this, go to the Credit section in your dashboard and select a subsection under it namely \u2018Add Request\u2019. Input the amount of credit to be added under the field Credit and you should see a button \u2018Load Directly from khalti\u2019 pop up at the bottom. Click it, put the OTP and transaction PIN and you should be done.
7) How to generate the UAT token ?
Link - Steps for staging(TEST) service account Login and Token Setup
8) What are the test credentials ?
LINK : TEST CREDENTIALS
"},{"location":"Servicescodes/faq/#error-codes","title":"Error Codes","text":""},{"location":"Servicescodes/faq/#error-codes-and-messages","title":"Error Codes and Messages","text":"Error Code Message 1001 Token not provided 1002 Invalid token 1003 Deleted token is provided 1004 Inactive token is provided 1005 Account associated with token is deleted 1006 Account associated with the token is inactive 1007 Account has expired 1008 Problem using the service 1009 Account doesn't have the permission 1010 Validation error 1011 Validation error 1012 Reference id not provided 1013 Request with duplicate reference id obtained 1014 Parse error 1015 Parse error 1016 Insufficient user credits 1017 Server error 1018 Error while using service 1019 Service in maintenance mode 1020 ERC for the amount could not be obtained 1021 Error from Provider 4000 Can\u2019t fulfill request Response from api
"},{"location":"Servicescodes/faq/#how-the-error-code-and-message-will-be-shown","title":"How the Error Code and Message Will be Shown","text":"If your API responds with an error code, it will be accompanied by a message that provides more context about the issue. Here\u2019s how it could be presented:
\n{\n \"error_code\": \"1002\",\n \"message\": \"Invalid token\"\n}\n
"},{"location":"Servicescodes/lookup/","title":"SERVICE STATUS LOOKUP API","text":"The Service Status Lookup API allows you to check the status of a transaction by providing a reference ID and token. This API is useful for tracking the state of a transaction to determine if it was successful, failed, or if there was an error.
"},{"location":"Servicescodes/lookup/#endpoint","title":"Endpoint","text":"URL: {{base_url}}/api/service/status/
METHOD: GET
"},{"location":"Servicescodes/lookup/#request-parameters","title":"Request Parameters","text":"The request requires the following parameters:
- token: The token provided for authorization.
- reference: The unique reference ID of the transaction for which the status needs to be checked.
Example Request:
\n{\n \"token\": \"ProvidedToken\",\n \"reference\": \"reference id against which status is to be checked\"\n}\n
"},{"location":"Servicescodes/lookup/#responses","title":"Responses","text":""},{"location":"Servicescodes/lookup/#success-response","title":"Success Response","text":"When the transaction is successful, you will receive a response with the following structure:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"original_status\": \"Success\",\n \"details\": \"Successful recharge\",\n \"reference\": \"7068074f-d04f-4262-8d9b-6a171da647b5\",\n \"response_id\": 123647,\n \"amount\": 10.0,\n \"refunded\": false,\n \"refunded_amount\": 0.0,\n \"refunds\": []\n}\n
Fields:
- state: The state of the transaction (
Success). - original_status: The original status of the transaction (
Success). - details: A description of the transaction status, e.g.,
\"Successful recharge\". - reference: The reference ID of the transaction.
- response_id: The unique ID associated with the response.
- amount: The amount involved in the transaction.
- refunded: Indicates if the amount was refunded (
false). - refunded_amount: The amount that was refunded.
- refunds: An array of refund objects, which is empty if no refunds occurred.
"},{"location":"Servicescodes/lookup/#failed-response","title":"Failed Response","text":"When the transaction fails, the response will look like this:
\n{\n \"status\": true,\n \"state\": \"Failed\",\n \"original_status\": \"Error\",\n \"details\": \"rtii\",\n \"reference\": \"813e70aa-889b-4b4b-b4f5-ede459d15a53\",\n \"response_id\": 123611,\n \"amount\": 100.0,\n \"refunded\": false,\n \"refunded_amount\": 0.0,\n \"refunds\": [\n {\n \"created_at\": \"2024-07-15\",\n \"remarks\": \"rtii\",\n \"amount\": 100.0\n }\n ]\n}\n
Fields:
- state: The state of the transaction (
Failed). - original_status: The original status of the transaction (
Error). - details: A description of the failure, e.g.,
\"rtii\". - reference: The reference ID of the transaction.
- response_id: The unique ID associated with the response.
- amount: The amount involved in the transaction.
- refunded: Indicates if the amount was refunded (
false). - refunded_amount: The amount that was refunded.
- refunds: An array of refund objects, each containing:
- created_at: The date when the refund was created.
- remarks: Comments about the refund.
- amount: The amount of the refund.
"},{"location":"Servicescodes/lookup/#failure-response-structure-no-such-transaction-at-our-end","title":"Failure Response Structure (No such Transaction at our end)","text":"If the reference ID is not valid, you will receive:
\n{\n \"status\": false,\n \"error_code\": \"002\",\n \"message\": \"The reference sent is not a valid reference.\",\n \"error\": \"invalid_reference\",\n \"details\": \"\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
Fields:
- status: Indicates whether the API call was successful (
false). - error_code: A code representing the error (
002). - message: A message explaining the error.
- error: The type of error (
invalid_reference). - details: Additional details about the error.
- error_data: An object containing additional error data.
- state: The state of the response (
Error).
"},{"location":"Servicescodes/lookup/#failure-response-structure-transaction-exists-but-failure","title":"Failure Response Structure (Transaction Exists but Failure)","text":"If the transaction exists but has failed, the response will be:
\n{\n \"status\": true,\n \"state\": \"Failed\",\n \"details\": \"Manually Failed\",\n \"reference\": \"Reference_092233\",\n \"response_id\": 10631926,\n \"amount\": 1.0\n}\n
Fields:
- state: The state of the transaction (
Failed). - details: A description of the failure, e.g.,
\"Manually Failed\". - reference: The reference ID of the transaction.
- response_id: The unique ID associated with the response.
- amount: The amount involved in the transaction.
"},{"location":"Servicescodes/lookup/#note","title":"NOTE","text":"Please refer to the state field in the response to determine the success or failure of the transaction, not the status field.
"},{"location":"Servicescodes/statecode/","title":"State List","text":"State Description Action Required Queued Transaction in unconfirmed state. Need to hold client amount. Expired Transaction not possible. Refund client amount. Processing Transaction in unconfirmed state. Need to hold client amount. Error Transaction errored. Refund client amount. Status Error Transaction errored. Refund client amount. Success Transaction Successful. Deduct client amount. Failed Transaction errored. Refund client amount."},{"location":"Servicescodes/statecode/#response-status-handling","title":"Response Status Handling","text":" - status: Check the
status key in the response: - True: The request is submitted successfully.
-
False: There is an issue with the request. Please fix your request.
-
State Handling:
- If the state is Queued or Processing, you will receive the final status of the transaction in the DLR callback later.
- If the state is Success, Failed, or Error, take action based on the state immediately. No need to wait for DLR.
"},{"location":"TV/Prabhutv/","title":"Max TV API Documentation","text":""},{"location":"TV/Prabhutv/#overview","title":"Overview","text":"The Max TV API provides functionality for retrieving details about Max TV services and processing payments. The API consists of two main endpoints: one for fetching service details and another for making payments. These endpoints are designed to facilitate the integration of Max TV services into your application or system.
"},{"location":"TV/Prabhutv/#detail-fetch-api","title":"Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/max-tv/
Request Method: POST
Service Parameters:
\n{\n \"token\": \"\",\n \"customer_id\": \"0000405146\", // Numeric value\n \"reference\": \"\"\n}\n\n\nResponse:
\n\n{\n \"customer_name\": \"vod test All\",\n \"cid_stb_smartcard\": \"0000405146\",\n \"amount\": 600,\n \"tvs\": [\n {\n \"stb_no\": \"6030637000423863\",\n \"smartcard_no\": \"6030637000423863\"\n }\n ],\n \"session_id\": 51,\n \"status\": true\n}\n
\n\nError Response:
\n\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Invalid customer id / stb no. / smartcard no.\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"TV/Prabhutv/#payment-api","title":"Payment API","text":"Request URL:\n{{base_url}}/api/use/max-tv/
\nRequest Method:\nPOST
\nService Parameters:
\n\n{\n \"token\": \"\",\n \"customer_id\": \"0000405146\",\n \"amount\": 100,\n \"session_id\": 51,\n \"reference\": \"\"\n}\n\n\nResponse:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Successful\",\n \"id\": 5035\n}\n
"},{"location":"TV/jagrititv/","title":"Jagriti Cable Network API","text":""},{"location":"TV/jagrititv/#overview","title":"Overview","text":"This document details the APIs for the Jagriti Cable Network service, including endpoints for fetching package information and processing payments.
"},{"location":"TV/jagrititv/#package-fetch-api","title":"Package Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/getpackages/jagriti-national-cable-network/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"type\": \"tv\" // \"tv\" for TV services, \"internet\" for ISP services\n}\n
Response:
\n{\n \"status\": true,\n \"detail\": {\n \"packages\": [\n {\n \"package_name\": \"TV HD Package - 1Month - 1TV\",\n \"amount\": 350\n },\n {\n \"package_name\": \"TV HD Package - 3Month - 1TV\",\n \"amount\": 1050\n },\n {\n \"package_name\": \"TV HD Package - 6Month - 1TV\",\n \"amount\": 1900\n },\n {\n \"package_name\": \"TV HD Package - 12Month - 1TV\",\n \"amount\": 3600\n },\n {\n \"package_name\": \"TV HD Package - 1Month - 2TV\",\n \"amount\": 525\n },\n {\n \"package_name\": \"TV HD Package - 3Month - 2TV\",\n \"amount\": 1575\n },\n {\n \"package_name\": \"TV HD Package - 6Month - 2TV\",\n \"amount\": 2800\n },\n {\n \"package_name\": \"TV HD Package - 12Month - 2TV\",\n \"amount\": 5250\n },\n {\n \"package_name\": \"TV HD Package - 1Month - 3TV\",\n \"amount\": 700\n },\n {\n \"package_name\": \"TV HD Package - 3Month - 3TV\",\n \"amount\": 2100\n },\n {\n \"package_name\": \"TV HD Package - 6Month - 3TV\",\n \"amount\": 3700\n },\n {\n \"package_name\": \"TV HD Package - 12Month - 3TV\",\n \"amount\": 6900\n }\n ]\n }\n}\n
"},{"location":"TV/jagrititv/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/use/jagriti-national-cable-network/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{TOKEN}}\",\n \"reference\": \"{{$guid}}\",\n \"package\": \"TV HD Package - 1Month - 1TV\",\n \"amount\": 350,\n \"stb_or_cas_id\": \"0123456789012345\", // Should be either 11 numbers or 16 numbers\n \"customer_name\": \"abc\",\n \"old_ward_number\": 10,\n \"customer_id\": \"1245\", // Optional\n \"mobile_number_1\": \"9841111111\",\n \"mobile_number_2\": \"9841111111\" // Optional\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 350.0,\n \"credits_available\": 106470545.045,\n \"extra_data\": {\n \"package\": \"TV HD Package - 1Month - 1TV\",\n \"customer_name\": \"12345\",\n \"old_ward_number\": \"10\",\n \"stb_or_cas_id\": \"0123456789012345\",\n \"customer_id\": \"Optional\",\n \"mobile_number_1\": \"9849324652\",\n \"mobile_number_2\": \"9818822421\"\n },\n \"id\": 8234\n}\n
"},{"location":"TV/maxtv/","title":"7.5 Max TV API Documentation","text":""},{"location":"TV/maxtv/#overview","title":"Overview","text":"This document describes the multi-step API for fetching details and processing payments related to Max TV services. It includes request and response formats for both the Detail Fetch API and the Payment API.
"},{"location":"TV/maxtv/#detail-fetch-api","title":"Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/max-tv/ Request Method: POST
"},{"location":"TV/maxtv/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"customer_id\": \"0000405146\", // (Numeric value)\n \"reference\": \"unique reference id\"\n}\n
"},{"location":"TV/maxtv/#response","title":"Response","text":"\n{\n \"customer_name\": \"vod test All\",\n \"cid_stb_smartcard\": \"0000405146\",\n \"amount\": 600,\n \"tvs\": [\n {\n \"stb_no\": \"6030637000423863\",\n \"smartcard_no\": \"6030637000423863\"\n }\n ],\n \"session_id\": 51,\n \"status\": true\n}\n
"},{"location":"TV/maxtv/#error-response","title":"Error Response","text":"\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Invalid customer id / stb no. / smartcard no.\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"TV/maxtv/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/use/max-tv/ Request Method: POST
"},{"location":"TV/maxtv/#service-params_1","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"customer_id\": \"0000405146\",\n \"amount\": 100,\n \"session_id\": 51,\n \"reference\": \"unique reference id\"\n}\n
"},{"location":"TV/maxtv/#response_1","title":"Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Successful\",\n \"id\": 5035\n}\n
"},{"location":"TV/nettv/","title":"Nettv API","text":""},{"location":"TV/nettv/#overview","title":"Overview","text":"The Nettv API allows you to interact with the Nettv service, providing functionality for fetching details, getting package rates, and processing payments. This documentation outlines the available endpoints, methods, and expected responses.
"},{"location":"TV/nettv/#details-fetch","title":"Details Fetch","text":"URL: {{base_url}}/api/servicegroup/details/nettv-v3/ Method: POST
Service Body Params:
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"username\": \"krustykrab\"\n}\n
"},{"location":"TV/nettv/#success-response","title":"Success Response","text":"\n{\n \"status\": true,\n \"stb_list\": [\n {\n \"serial\": \"00226D85984E\"\n },\n {\n \"serial\": \"00226DAB66F1\"\n },\n {\n \"serial\": \"D4226DBB50F4\"\n }\n ],\n \"username\": \"krustykrab\",\n \"session_id\": 27817\n}\n
"},{"location":"TV/nettv/#get-packages","title":"Get Packages","text":"URL: {{base_url}}/api/servicegroup/getpackagerates/nettv-v3/ Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"session_id\": \"25527\",\n \"serial_no\": \"00226D85984E\"\n}\n
"},{"location":"TV/nettv/#success-response_1","title":"Success Response","text":"\n{\n \"status\": true,\n \"username\": \"west\",\n \"stb\": \"00226D86F6DD\",\n \"package_status\": \"inactive\",\n \"expiry_date\": \"\",\n \"package_name\": \"\",\n \"stb_type\": \"primary\",\n \"user_id\": 424981,\n \"package_list\": [\n {\n \"name\": \"Platinum - Introductory 1 month\",\n \"duration\": \"1\",\n \"package_price\": 221.0,\n \"discount\": 0.0,\n \"amount\": 250.0,\n \"package_sales_id\": 123,\n \"package_id\": 1\n },\n {\n \"name\": \"Platinum - Introductory 3 month\",\n \"duration\": \"3\",\n \"package_price\": 663.0,\n \"discount\": 0.0,\n \"amount\": 750.0,\n \"package_sales_id\": 0,\n \"package_id\": 1\n },\n {\n \"name\": \"Platinum - Introductory 12 month\",\n \"duration\": \"12\",\n \"package_price\": 2654.0,\n \"discount\": 0.0,\n \"amount\": 3000.0,\n \"package_sales_id\": 0,\n \"package_id\": 1\n }\n ],\n \"session_id\": 25527\n}\n
"},{"location":"TV/nettv/#payment","title":"Payment","text":"URL: {{base_url}}/api/servicegroup/commit/nettv-v3/ Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"package_sales_id\": \"{{package_sales_id}}\",\n \"session_id\": \"{{session_id}}\",\n \"reference\": \"{{$guid}}\"\n}\n
"},{"location":"TV/nettv/#success-response_2","title":"Success Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Transaction Successful\",\n \"credits_consumed\": 250.0,\n \"credits_available\": -220.93,\n \"id\": 130121\n}\n
"},{"location":"TV/p%26g/","title":"P & G Network API","text":""},{"location":"TV/p%26g/#overview","title":"Overview","text":"This document provides details on the APIs for the P & G Network service. It includes endpoints for fetching package information and processing payments.
"},{"location":"TV/p%26g/#package-fetch-api","title":"Package Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/getpackages/png-network/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"package_type\": \"tv\"\n}\n
Response:
\n{\n \"status\": true,\n \"detail\": {\n \"packages\": [\n {\n \"package_name\": \"Silver 1TV - 1 Month\",\n \"amount\": 300.0\n },\n {\n \"package_name\": \"Silver 1TV - 3 Month\",\n \"amount\": 900.0\n },\n {\n \"package_name\": \"Silver 1TV - 6 Month\",\n \"amount\": 1800.0\n },\n {\n \"package_name\": \"Silver 1TV - 12 Month\",\n \"amount\": 3600.0\n },\n {\n \"package_name\": \"Gold HD 1TV - 1 Month\",\n \"amount\": 400.0\n },\n {\n \"package_name\": \"Gold HD 1TV - 3 Month\",\n \"amount\": 1200.0\n },\n {\n \"package_name\": \"Gold HD 1TV - 6 Month\",\n \"amount\": 2400.0\n },\n {\n \"package_name\": \"Gold HD 1TV - 12 Month\",\n \"amount\": 4800.0\n },\n {\n \"package_name\": \"Platinum Full HD 1TV - 1 Month\",\n \"amount\": 500.0\n },\n {\n \"package_name\": \"Platinum Full HD 1TV - 3 Month\",\n \"amount\": 1500.0\n },\n {\n \"package_name\": \"Platinum Full HD 1TV - 6 Month\",\n \"amount\": 3000.0\n },\n {\n \"package_name\": \"Platinum Full HD 1TV - 12 Month\",\n \"amount\": 6000.0\n }\n ]\n }\n}\n
"},{"location":"TV/p%26g/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/use/png-network/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{TOKEN}}\",\n \"reference\": \"{{$guid}}\",\n \"package\": \"Silver 1TV - 1 Month\",\n \"amount\": 300,\n \"user_name\": \"abcdef\", // Either 6 characters or 000{6 characters}\n \"contact_number\": \"9849324652\",\n \"customer_name\": \"abc\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 300.0,\n \"credits_available\": 106470895.045,\n \"extra_data\": {\n \"package\": \"Silver 1TV - 1 Month\",\n \"user_name\": \"0000abcdef\",\n \"contact_number\": \"9849324652\",\n \"customer_name\": \"abc\"\n },\n \"id\": 8230\n}\n
"},{"location":"TV/simtv/","title":"Sim TV API","text":""},{"location":"TV/simtv/#overview","title":"Overview","text":"The Sim TV API provides functionalities for retrieving user details and processing payments for Sim TV services. It is designed to help you integrate Sim TV functionalities into your application or service. There are two primary endpoints available: one for looking up user details and another for processing payments.
- User Detail API: Retrieve the user's name and due amount.
- Payment API: Process payments for a specified amount.
"},{"location":"TV/simtv/#user-detail-api","title":"User Detail API","text":"URL: {{base_url}}/api/lookup/simtv/
Method: GET
Parameters:
\n{\n \"token\": \"token provided\",\n \"customer_id\": \"customer_id of user, eg: 1000088047\"\n}\n
Success Response:
\n{\n \"status\": true,\n \"data\": {\n \"customer_name\": \"YADAV PRD KHAREL\",\n \"due_amount\": \"0\"\n }\n}\n
Unsuccessful Response:
\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Invalid information\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"TV/simtv/#payment-api","title":"Payment API","text":"URL: {{base_url}}/api/use/simtv/
Service Parameters:
\n{\n \"customer_id\": \"Customer Id (e.g., 1000159157)\",\n \"token\": \"\",\n \"reference\": \"\",\n \"amount\": \"\"\n}\n\n\nValid Amounts:
\n\n[\n 300, 325, 375, 400, 425, 475, 500, 550, 575, 600, 750, 800, 875, 975, 1000, \n 1050, 1065, 1125, 1190, 1275, 1425, 1440, 1625, 1875, 1900, 1950, 2000, 2125, \n 2250, 2375, 2550, 2875, 3250, 3800, 3900, 4250, 4275, 4500, 4750, 5000, 5100, \n 5175, 5750, 7000, 10000\n]\n
\n\nRegex for Customer ID:
\n\n{\n \"name\": \"Customer ID\",\n \"slug\": \"\",\n \"pattern\": \"([0-9]{10,11})\",\n \"error_message\": \"Invalid customer id\"\n}\n
\n\nRequest:
\n\n{\n \"token\": \"\",\n \"reference\": \"\",\n \"amount\": \"\",\n \"customer_id\": \"\"\n}\n\n\nSuccess Response:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Transaction successful\"\n}\n
\n\nUnsuccessful Response:
\n\n{\n \"error_code\": \"1010\",\n \"message\": \"Validation error\",\n \"status\": false,\n \"error_data\": {},\n \"details\": \"\"\n}\n
"},{"location":"TV/times/","title":"Times API","text":"Below is the list of TV services under Times and their respective service_slug:
"},{"location":"TV/times/#merotv-v2-merotv-v2","title":"Merotv v2 : merotv-v2","text":""},{"location":"TV/times/#sky-tv-sky-tv","title":"Sky TV : sky-tv","text":""},{"location":"TV/times/#multi-step-api","title":"Multi-Step API","text":""},{"location":"TV/times/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"URL: {{base_url}}/api/servicegroup/userlist/times/
METHOD: POST
Service Params:
\n{\n \"token\": \"Account_Token\",\n \"reference\": \"Unique Id sent from your side\",\n \"customer_id\": \"Customer_ID\", // [test customer id : 1000001]\n \"service_slug\": \"service_slug\"\n}\n
RESPONSE:
\n{\n \"customer\": {\n \"cuid\": \"1000001\",\n \"first_name\": \"KC HARI\",\n \"last_name\": \"BIKRAM\",\n \"status\": \"active\"\n },\n \"connection\": [\n {\n \"stb\": \"5001067801\",\n \"status\": \"active\"\n },\n {\n \"stb\": \"5001067803\",\n \"status\": \"active\"\n }\n ],\n \"session_id\": 7106,\n \"status\": true\n}\n
"},{"location":"TV/times/#2-package-fetch-api","title":"2. Package Fetch API","text":"URL: {{base_url}}/api/servicegroup/details/times/
METHOD: POST
Service Params:
\n{\n \"token\": \"\",\n \"stb\": \"\",\n \"session_id\": \"\",\n \"service_slug\": \"\",\n \"reference\": \"\"\n}\n\n\nRESPONSE:
\n\n{\n \"packages\": [\n {\n \"package_id\": \"391\",\n \"package_name\": \"SKY HD+ Monthly (MONTHLY)\",\n \"amount\": 550\n },\n {\n \"package_id\": \"392\",\n \"package_name\": \"FIFA WORLD CUP 2022 (MONTHLY) [AddOn]\",\n \"amount\": 565\n }\n ],\n \"session_id\": 7105,\n \"status\": true\n}\n
"},{"location":"TV/times/#3-payment-api","title":"3. Payment API","text":"URL: {{base_url}}/api/servicegroup/commit/times/
\nMETHOD: POST
\nService Params:
\n\n{\n \"token\": \"Account_Token\",\n \"session_id\": \"session_id from detail fetch API\",\n \"amount\": \"Package Amount from package fetch API\",\n \"package_id\": \"package ID from package fetch API\"\n}\n
\n\nRESPONSE:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 790.0,\n \"credits_available\": 9999378747.53,\n \"id\": 42353\n}\n
"},{"location":"antivirus/eset/","title":"Eset Antivirus API","text":""},{"location":"antivirus/eset/#overview","title":"Overview","text":"The Eset Antivirus API is a multi-step API that allows users to retrieve product details and make purchases of antivirus solutions. It consists of two primary endpoints: the Get Detail API for fetching product information and the Purchase API for completing transactions.
"},{"location":"antivirus/eset/#1-get-detail-api","title":"1. Get Detail API","text":"This endpoint retrieves the available Eset antivirus products along with their details.
"},{"location":"antivirus/eset/#request","title":"Request","text":" - Request URL:
{{base_url}}/api/products/eset-antivirus/ - Request Method:
GET - Service Params:
\n{\n \"token\": \"\\ token\\ \"\n}\n
"},{"location":"antivirus/eset/#response","title":"Response","text":"The response will return a JSON object containing the status and an array of product details.
\n{\n \"status\": true,\n \"data\": [\n {\n \"idx\": \"znR2fUJHM8YZ4GFh43fZKC\",\n \"name\": \"eset Mobile Security\",\n \"value\": \"EMS\",\n \"amount\": 900.0\n },\n {\n \"idx\": \"BnF4bGdc7BAzFoA2tSqQGK\",\n \"name\": \"eset Antivirus 1user 1year\",\n \"value\": \"EA11\",\n \"amount\": 900.0\n },\n {\n \"idx\": \"CWcNh6qYEorY4H4kpcqUPk\",\n \"name\": \"eset Antivirus 3user 1year\",\n \"value\": \"EA31\",\n \"amount\": 1800.0\n },\n {\n \"idx\": \"T6USwHFwNcyGLpr5kMqRbU\",\n \"name\": \"eset Antivirus 1user 3 year\",\n \"value\": \"EA13\",\n \"amount\": 2000.0\n },\n {\n \"idx\": \"WgoBqQAxF7TwEzzMYqJNsP\",\n \"name\": \"eset Antivirus 5user 1 year\",\n \"value\": \"EA51\",\n \"amount\": 2800.0\n },\n {\n \"idx\": \"cXSgMtPzCwU2uShVeE2FbJ\",\n \"name\": \"eset Internet Security 1user 1year\",\n \"value\": \"EIS11\",\n \"amount\": 1800.0\n },\n {\n \"idx\": \"Qw7dXmfNxVTBZWXgaCAABj\",\n \"name\": \"eset Internet Security 1user 3year\",\n \"value\": \"EIS13\",\n \"amount\": 3800.0\n },\n {\n \"idx\": \"gSJoYy3PZMqHob8iHGe5Z6\",\n \"name\": \"eset Internet Security 3user 1year\",\n \"value\": \"EIS31\",\n \"amount\": 3600.0\n },\n {\n \"idx\": \"ZBCh49vMaXCzuVzTJjzpV6\",\n \"name\": \"eset Internet Security 5user 1year\",\n \"value\": \"EIS51\",\n \"amount\": 5000.0\n },\n {\n \"idx\": \"hJS2GYFu2B5ELdsKfTXcwk\",\n \"name\": \"eset Smart Security Premium 1user 1year\",\n \"value\": \"ESSP11\",\n \"amount\": 4000.0\n },\n {\n \"idx\": \"YDhbheLfWBmqSFdmxHPeqj\",\n \"name\": \"eset Smart Security Premium 3user 1year\",\n \"value\": \"ESSP31\",\n \"amount\": 5500.0\n },\n {\n \"idx\": \"B7NiUMEoec4s9Pk9cUYCxA\",\n \"name\": \"eset Smart Security Premium 5user 1 year\",\n \"value\": \"ESSP51\",\n \"amount\": 6500.0\n }\n ]\n}\n
"},{"location":"antivirus/eset/#2-purchase-api","title":"2. Purchase API","text":"This endpoint allows users to purchase selected Eset antivirus products.
"},{"location":"antivirus/eset/#request_1","title":"Request","text":" - Request URL:
{{base_url}}/api/use/eset-antivirus/ - Request Method:
POST - Service Params:
\n{\n \"token\": \"\\ token\\ \",\n \"reference\": \"\\ unique identifier for each request\\ \",\n \"amount\": 6500,\n \"value\": \"ESSP51\"\n}\n
"},{"location":"antivirus/eset/#response_1","title":"Response","text":"The response will confirm the transaction and provide a PIN number along with other transaction details.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Your Pin number is '2098'\",\n \"serial\": \"1098\",\n \"pin\": \"2098\",\n \"credits_consumed\": 6500.0,\n \"credits_available\": 106407713.395,\n \"id\": 9733\n}\n
"},{"location":"antivirus/k7/","title":"K7 Antivirus API","text":""},{"location":"antivirus/k7/#overview","title":"Overview","text":"The K7 Antivirus API is a multi-step API that enables users to access product details and process payments for K7 antivirus products. The API includes two primary endpoints: the K7 Product Detail API for retrieving product information and the K7 Product Payment API for handling transactions.
"},{"location":"antivirus/k7/#1-k7-product-detail-api","title":"1. K7 Product Detail API","text":"This endpoint retrieves a list of available K7 antivirus products along with their details.
"},{"location":"antivirus/k7/#request","title":"Request","text":" - Request URL:
{{base_url}}/api/products/k7-antivirus/ - Request Method:
GET - Service Params:
\n{\n \"token\": \"\\ Token\\ \"\n}\n
"},{"location":"antivirus/k7/#response","title":"Response","text":"The response returns a JSON object indicating the status and an array of product details.
\n{\n \"status\": true,\n \"data\": [\n {\n \"idx\": \"NJfrJbEmsewrrEUE4rskhE\",\n \"name\": \"K7 Antivirus Premium 1PC-1Year\",\n \"value\": \"KAP 1PC-1Year\",\n \"amount\": 1000.0\n },\n {\n \"idx\": \"j8rQoSCnqN3jLvVBWqG6s7\",\n \"name\": \"K7 Antivirus Premium 3PC-1Year\",\n \"value\": \"KAP 3PC-1Year\",\n \"amount\": 2000.0\n },\n {\n \"idx\": \"uN89sY9KuGgv4ZCc2btxTM\",\n \"name\": \"K7 Total Security 1PC-1Year\",\n \"value\": \"KTS 1PC-1Year\",\n \"amount\": 1500.0\n },\n {\n \"idx\": \"hHd8YQNfhvtBKAmU64fBNF\",\n \"name\": \"K7 Total Security 1PC-2Year\",\n \"value\": \"KTS 1PC-2Year\",\n \"amount\": 2500.0\n },\n {\n \"idx\": \"DUjRTWf2o7MDYect9z9JfT\",\n \"name\": \"K7 Total Security 3PC-1Year\",\n \"value\": \"K7 Total Security 3PC-1Year\",\n \"amount\": 3000.0\n },\n {\n \"idx\": \"XJCSYM2hwgJsLiwpj3JtzX\",\n \"name\": \"K7 Total Security 1PC-3Year\",\n \"value\": \"KTS 1PC-3Year\",\n \"amount\": 3000.0\n },\n {\n \"idx\": \"kjyzc2ioAYyzn8Df4FVtGc\",\n \"name\": \"K7 Total Security 5PC-1Year\",\n \"value\": \"KTS 5PC-1Year\",\n \"amount\": 5000.0\n },\n {\n \"idx\": \"U5RLMAEt49jz68ZaeFJ3hU\",\n \"name\": \"K7 Ultimate Security 1PC-1Year\",\n \"value\": \"KUS 1PC-1Year\",\n \"amount\": 2500.0\n },\n {\n \"idx\": \"EMY25yWrtdC7cTDtuih5aY\",\n \"name\": \"K7 Ultimate Security 3PC-1Year\",\n \"value\": \"K7 Ultimate Security 3PC-1Year\",\n \"amount\": 5000.0\n },\n {\n \"idx\": \"S9rgyuRD3upbknVePoJcPP\",\n \"name\": \"K7 Ultimate Security 1PC-3Year\",\n \"value\": \"KUS 1PC-3Year\",\n \"amount\": 5000.0\n },\n {\n \"idx\": \"DQm3YvbKesFzmutm5ymm8M\",\n \"name\": \"K7 Ultimate Security 5Devices-1Year\",\n \"value\": \"KUS 5Devices-1Year\",\n \"amount\": 8500.0\n },\n {\n \"idx\": \"iZJ36Zk4yfMv7x2nVtXNsm\",\n \"name\": \"K7 Mobile Security 1Android Device-1Year\",\n \"value\": \"KMSA Device-1Year\",\n \"amount\": 1000.0\n }\n ]\n}\n
"},{"location":"antivirus/k7/#2-k7-product-payment-api","title":"2. K7 Product Payment API","text":"This endpoint processes the payment for the selected K7 antivirus product.
"},{"location":"antivirus/k7/#request_1","title":"Request","text":" - Request URL:
{{base_url}}/api/use/k7-antivirus/ - Request Method:
POST - Service Params:
\n{\n \"value\": \"KAP 1PC-1Year\", // from detail API\n \"amount\": 1000,\n \"reference\": \"\\ unique identifier for each request\\ \",\n \"token\": \"\\ token\\ \"\n}\n
"},{"location":"antivirus/k7/#response_1","title":"Response","text":"The response will indicate the transaction status and provide the PIN number along with other transaction details.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Your Pin number is 'PinKAP 1PC-1Year92'\",\n \"serial\": \"SerialKAP 1PC-1Year92\",\n \"pin\": \"AP 1PC-1Year01\",\n \"credits_consumed\": 1000.0,\n \"credits_available\": 96496048.0450002,\n \"id\": 7908\n}\n
"},{"location":"antivirus/kaspersky/","title":"Kaspersky Antivirus","text":"This document outlines the API for Kaspersky Antivirus, which includes functionalities for fetching package details and processing payments. It provides request URLs, methods, parameters, and example responses for both the package details fetch and payment APIs.
"},{"location":"antivirus/kaspersky/#kaspersky-antivirus_1","title":"Kaspersky Antivirus","text":"Type: Multi Step API
"},{"location":"antivirus/kaspersky/#1-package-details-fetch-api","title":"1. Package Details Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/antivirus-service/a
Request Method: POST
"},{"location":"antivirus/kaspersky/#service-params","title":"Service Params:","text":"\n{ \n \"token\": \"token\" \n}\n
"},{"location":"antivirus/kaspersky/#response","title":"Response:","text":"\n{ \n \"status\": true, \n \"detail\": [ \n { \n \"name\": \"Kaspersky Standard 1 Device 1 Year\", \n \"product_code\": \"KS-1D-1Y\", \n \"price\": 700 \n }, \n { \n \"name\": \"Kaspersky Plus 1 Device 1 Year\", \n \"product_code\": \"KP-1D-1Y\", \n \"price\": 1400 \n }, \n { \n \"name\": \"Kaspersky Standard 3 Devices 1 Year\", \n \"product_code\": \"KS-3D-1Y\", \n \"price\": 1400 \n }, \n { \n \"name\": \"Kaspersky Premium 1 Device 1 Year\", \n \"product_code\": \"KPR-1D-1Y\", \n \"price\": 2100 \n }, \n { \n \"name\": \"Kaspersky Plus 3 Devices 1 Year\", \n \"product_code\": \"KP-3D-1Y\", \n \"price\": 2100 \n }, \n { \n \"name\": \"Kaspersky Premium 3 Devices 1 Year\", \n \"product_code\": \"KPR-3D-1Y\", \n \"price\": 2800 \n } \n ] \n}\n
"},{"location":"antivirus/kaspersky/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/antivirus-service/
Request Method: POST
"},{"location":"antivirus/kaspersky/#service-params_1","title":"Service Params:","text":"\n{ \n \"token\": \"{{token}}\", \n \"product_code\": \"KS-1D-1Y\", \n \"amount\": 700, \n \"name\": \"Dev Dev\", \n \"email\": \"Dev Dev\", \n \"mobile\": \"1234567899\", \n \"reference\": \"{{$guid}}\" \n}\n
"},{"location":"antivirus/kaspersky/#response_1","title":"Response:","text":"\n{ \n \"status\": true, \n \"state\": \"Success\", \n \"message\": \"Successfully Completed Transaction\", \n \"extra_data\": {}, \n \"detail\": \"Transaction Successful\", \n \"credits_consumed\": 700, \n \"credits_available\": 1e+32, \n \"id\": 117671 \n}\n
"},{"location":"antivirus/mcafee/","title":"McAfee Antivirus API","text":""},{"location":"antivirus/mcafee/#overview","title":"Overview","text":"The McAfee Antivirus API is a multi-step API designed for users to access product details and process payments for McAfee antivirus products. This API consists of two main endpoints: the Product Detail API for retrieving product information and the Product Payment API for handling purchases.
"},{"location":"antivirus/mcafee/#1-product-detail-api","title":"1. Product Detail API","text":"This endpoint retrieves a list of available McAfee antivirus products along with their details.
"},{"location":"antivirus/mcafee/#request","title":"Request","text":" - Request URL:
{{base_url}}/api/products/mcafee-antivirus/?token={{token}} - Request Method:
GET - Service Params:
\n{\n \"token\": \"Token\"\n}\n
"},{"location":"antivirus/mcafee/#response","title":"Response","text":"The response returns a JSON object indicating the status and an array of product details.
\n{\n \"status\": true,\n \"data\": [\n {\n \"idx\": \"T8EBDkFt8VenB9ZJMKt7YS\",\n \"name\": \"Mcafee Antivirus 1PC / 1 Year\",\n \"value\": \"MA-1P-1Y\",\n \"amount\": 700.0\n },\n {\n \"idx\": \"FbZxh4eBziQFxLHT73oR7A\",\n \"name\": \"Mcafee Mobile Security 1 Phone / 1 Year\",\n \"value\": \"MMS-1P-1Y\",\n \"amount\": 700.0\n },\n {\n \"idx\": \"9jniFusARPdsYkMGarpRDc\",\n \"name\": \"Mcafee Internet Security 1 Device / 1 Year\",\n \"value\": \"MIS-1D-1Y\",\n \"amount\": 1350.0\n },\n {\n \"idx\": \"nouBj2b7CZuXcipSzf6zsi\",\n \"name\": \"Mcafee Antivirus 3PC / 1 Year\",\n \"value\": \"MA-3P-1Y\",\n \"amount\": 1500.0\n },\n {\n \"idx\": \"gWd9NT4YR6HXLNrCTqPHdV\",\n \"name\": \"Mcafee Total Protection 1 Device / 1 Year\",\n \"value\": \"MTP-1D-1Y\",\n \"amount\": 1550.0\n },\n {\n \"idx\": \"yGz5AJzv3nCjDCt33gw4sW\",\n \"name\": \"Mcafee Internet Security 3 Device / 1 Year\",\n \"value\": \"MIS-3D-1Y\",\n \"amount\": 2500.0\n },\n {\n \"idx\": \"Ussq53tPpygK3795XKnU3D\",\n \"name\": \"Mcafee Total Protection 3 Device / 1 Year\",\n \"value\": \"MTP-3D-1Y\",\n \"amount\": 3150.0\n }\n ]\n}\n
"},{"location":"antivirus/mcafee/#2-product-payment-api","title":"2. Product Payment API","text":"This endpoint processes the payment for the selected McAfee antivirus product.
"},{"location":"antivirus/mcafee/#request_1","title":"Request","text":" - Request URL:
{{base_url}}/api/use/mcafee-antivirus/ - Request Method:
POST - Service Params:
\n{\n \"value\": \"MA-1P-1Y\", // from detail API\n \"amount\": 700,\n \"reference\": \"unique identifier for each request\",\n \"token\": \"token\",\n \"name\": \"Mcafee Antivirus 1PC / 1 Year\"\n}\n
"},{"location":"antivirus/mcafee/#response_1","title":"Response","text":"The response will indicate the transaction status and provide the PIN number along with other transaction details.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Your Pin number is '123545'\",\n \"serial\": \"123545\",\n \"pin\": \"123545\",\n \"credits_consumed\": 700.0,\n \"credits_available\": 9999740618.32,\n \"id\": 33415\n}\n
"},{"location":"antivirus/wardwiz/","title":"Wardwiz Antivirus API","text":""},{"location":"antivirus/wardwiz/#overview","title":"Overview","text":"The Wardwiz Antivirus API is a multi-step API designed to allow users to retrieve product details and process payments for Wardwiz antivirus products. This API includes two main endpoints: the Wardwiz Product Detail API for fetching product information and the Wardwiz Product Payment API for handling transactions.
"},{"location":"antivirus/wardwiz/#1-wardwiz-product-detail-api","title":"1. Wardwiz Product Detail API","text":"This endpoint retrieves a list of available Wardwiz antivirus products along with their details.
"},{"location":"antivirus/wardwiz/#request","title":"Request","text":" - Request URL:
{{base_url}}/api/products/wardwiz-antivirus/?token={{token}} - Request Method:
GET - Service Params:
\n{\n \"token\": \"\\ Token\\ \"\n}\n
"},{"location":"antivirus/wardwiz/#response","title":"Response","text":"The response returns a JSON object indicating the status and an array of product details.
\n{\n \"status\": true,\n \"data\": [\n {\n \"idx\": \"vUHWcYKWR952FuxyncsmiB\",\n \"name\": \"Wardwiz Basic 1 user / 1 year\",\n \"value\": \"WWB11\",\n \"amount\": 700.0\n },\n {\n \"idx\": \"ho4kmG3hbtFAEgTRpaHA54\",\n \"name\": \"Wardwiz Essential 1 user / 1 year\",\n \"value\": \"WWE11\",\n \"amount\": 1300.0\n },\n {\n \"idx\": \"Viwiy6wgTWiPxSbTMu79D9\",\n \"name\": \"Wardwiz Basic 3 user / 1 year\",\n \"value\": \"WWB31\",\n \"amount\": 1300.0\n },\n {\n \"idx\": \"jqF6Ttc9UZ4srB9K5QqMUG\",\n \"name\": \"Wardwiz Essential Plus 1 user / 1 year\",\n \"value\": \"WWEP11\",\n \"amount\": 1500.0\n },\n {\n \"idx\": \"6iTVKEQMyddNDT6apN7y8S\",\n \"name\": \"Wardwiz Essential 3 user / 1 year\",\n \"value\": \"WWE31\",\n \"amount\": 2600.0\n },\n {\n \"idx\": \"iAK3UrBTxHVu5tW2FcKcNS\",\n \"name\": \"Wardwiz Essential Plus 3 user / 1 year\",\n \"value\": \"WWEP31\",\n \"amount\": 3000.0\n }\n ]\n}\n
"},{"location":"antivirus/wardwiz/#2-wardwiz-product-payment-api","title":"2. Wardwiz Product Payment API","text":"This endpoint processes the payment for the selected Wardwiz antivirus product.
"},{"location":"antivirus/wardwiz/#request_1","title":"Request","text":" - Request URL:
{{base_url}}/api/use/wardwiz-antivirus/ - Request Method:
POST - Service Params:
\n{\n \"value\": \"WWEP31\", // from detail API\n \"amount\": 3000,\n \"reference\": \"\\ unique identifier for each request\\ \",\n \"token\": \"\\ token\\ \",\n \"name\": \"Wardwiz Essential Plus 3 user / 1 year\"\n}\n
"},{"location":"antivirus/wardwiz/#response_1","title":"Response","text":"The response will indicate the transaction status and provide the PIN number along with other transaction details.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Your Pin number is 'PinWEP1234'\",\n \"serial\": \"SerialWWEP1234\",\n \"pin\": \"PinWWEP1234\",\n \"credits_consumed\": 3000.0,\n \"credits_available\": 9999771927.42,\n \"id\": 32303\n}\n
"},{"location":"bluebook/bluebook/","title":"Bluebook API","text":""},{"location":"bluebook/bluebook/#overview","title":"Overview","text":"The Bluebook API allows users to calculate and process bluebook renewals for vehicles. It consists of two main steps: the Calculate API and the Payment API. The Calculate API computes the required renewal charges, while the Payment API handles the transaction based on the results from the Calculate API.
"},{"location":"bluebook/bluebook/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"bluebook/bluebook/#1-calculate-api","title":"1. Calculate API","text":"Request URL: {{base_url}}/api/servicegroup/calculate/bluebook-renewal/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"reference\": \"unique reference\",\n \"vehicle_type\": \"vehicle_type\", // 4W, 2W\n \"cc\": \"cc\",\n \"valid_start_date\": \"valid_start_date in Nepali date \",\n \"valid_end_date\": \"valid_end_date in Nepali date \",\n \"manufacture_date\": \"manufacture_date Year only in English Year\",\n \"thirdparty_insurance\": \"True/False\"\n}\n
Response:
\n{\n \"status\": true,\n \"detail\": {\n \"unpaid_tax\": 10000,\n \"unpaid_tax_fine_amt\": 4720.0,\n \"tax_cy\": 0,\n \"tax_fine_cy\": 0.0,\n \"renewal_charge\": 600,\n \"renewal_fine\": 600,\n \"modal_tax\": 4750,\n \"total\": 20670,\n \"service_charge\": 0,\n \"insurance\": 1935,\n \"total_amount\": 22605\n },\n \"session_id\": 25871\n}\n
"},{"location":"bluebook/bluebook/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/bluebook-renewal/
Request Method: POST
Note: - If thirdparty_insurance is true in the Calculate API, you need to pass document_back_image and document_front_image in the Payment API params. - If thirdparty_insurance is false, you need to pass insurance_paper in the Payment API params.
Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"session_id\",\n \"full_name\": \"full name\",\n \"contact_no\": \"contact_no>\",\n \"email\": \"test@test.com\",\n \"pick_location\": \"pick_location\",\n \"city\": \"City\",\n \"vehicle_no\": \"vehicle_no\",\n \"document_back_image\": \"document_back_image\", // base 64 image\n \"document_front_image\": \"document_front_image\", // base 64 image\n \"insurance_paper\": \"insurance_paper\" // base 64 image\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"detail\": \"Transaction Completed.\",\n \"message\": \"Transaction Completed\",\n \"credits_consumed\": 22605.0,\n \"credits_available\": 999999998507583.0,\n \"extra_data\": {\n \"session_id\": \"25871\",\n \"full_name\": \"Test test\",\n \"contact_no\": \"9863636999\",\n \"email\": \"test@khalti.com\",\n \"pick_location\": \"location\",\n \"city\": \"City\",\n \"vehicle_no\": \"11221\",\n \"document_front_image\": \"https://cdn.example.com/media/bluebook/document_front_image_12345.png\",\n \"document_back_image\": \"https://cdn.example.com/media/bluebook/document_back_image_12345.png\"\n },\n \"id\": 126284\n}\n
"},{"location":"datapacks/NcellProduct/","title":"Ncell Data Pack API Documentation","text":""},{"location":"datapacks/NcellProduct/#overview","title":"Overview","text":"The Ncell Data Pack API provides two main functionalities:
-
Get Packages API: Retrieve available Ncell data pack options.
-
Ncell Data Pack Payment API: Process payment for a selected Ncell data pack.
"},{"location":"datapacks/NcellProduct/#1-get-packages-api","title":"1. Get Packages API","text":"Request URL: {{base_url}}/api/servicegroup/getpackages/ncell-product/
Request Method: POST
Service Parameters:
\n{\n \"token\": \"\"\n}"},{"location":"datapacks/NcellProduct/#success-response","title":"Success Response","text":"\n{\n \"status\": true,\n \"detail\": {\n \"packages\": [\n {\n \"priority_no\": 1,\n \"product_name\": \"100 Minute Call Time 1\",\n \"amount\": 50.55,\n \"short_detail\": \"100 Minute Call Time 1\",\n \"product_code\": \"PROD_001_inv\",\n \"description\": \"100 Minute Call Time 1\",\n \"prodcut_type\": \"All Packs\",\n \"validity\": \"1 Day\",\n \"package_priority\": 100\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"Seasonal Call offer 1\",\n \"amount\": 199.99,\n \"short_detail\": \"seasonal call offer\",\n \"product_code\": \"Test_Pr_001\",\n \"description\": \"Seasonal Call offer 1\",\n \"prodcut_type\": \"All Packs\",\n \"validity\": \"7 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 90,\n \"product_name\": \"Ncell Product\",\n \"amount\": 55.0,\n \"short_detail\": \"109\",\n \"product_code\": \"1_day_10min_India\",\n \"description\": \"At just Rs.55, get 15 minutes India talktime valid for 1 day.\",\n \"prodcut_type\": \"Voice Pack\",\n \"validity\": \"10 Days\",\n \"package_priority\": 1\n },\n {\n \"priority_no\": 90,\n \"product_name\": \"1 Day Voice Pack\",\n \"amount\": 10.0,\n \"short_detail\": \"1 Day Voice Pack\",\n \"product_code\": \"S173284\",\n \"description\": \"1 Day Voice Pack\",\n \"prodcut_type\": \"Voice Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n }\n ]\n }\n}\n
"},{"location":"datapacks/NcellProduct/#2-payment","title":"2. Payment","text":""},{"location":"datapacks/NcellProduct/#request-url","title":"Request URL:","text":"{{base_url}}/api/use/ncell-product/
\nRequest Method: POST
"},{"location":"datapacks/NcellProduct/#service-parameters","title":"Service Parameters:","text":"\n{\n \"token\": \"\",\n \"amount\": 98.99,\n \"number\": \"9809399558\",\n \"reference\": \"reference123\",\n \"product_code\": \"Per_Day_300MB\"\n}"},{"location":"datapacks/NcellProduct/#success-response_1","title":"Success Response:","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Transaction successful\",\n \"id\": 7276\n}\n
"},{"location":"datapacks/NcellProduct/#error-response","title":"Error Response","text":"\n{\n \"status\": false,\n \"error_code\": \"001\",\n \"message\": \"The parameters sent are not correct.\",\n \"error\": \"invalid_parameters\",\n \"details\": {\n \"product_code\": \"Invalid Product Code\"\n },\n \"error_data\": {\n \"product_code\": \"Invalid Product Code\"\n },\n \"state\": \"Error\"\n}\n\n
"},{"location":"datapacks/ntcProduct/","title":"NTC Data Pack API Documentation","text":""},{"location":"datapacks/ntcProduct/#overview","title":"Overview","text":"The NTC Data Pack API allows you to:
1. Get Packages: Retrieve a list of available NTC data and voice packs.
2. Process Payment: Make a payment for a selected NTC data or voice pack.
"},{"location":"datapacks/ntcProduct/#get-packages-api","title":"Get Packages API","text":"Request URL: {{base_url}}/api/servicegroup/getpackages/ntc-package/
Request Method: POST
Service Parameters:
\n{\n \"token\": \"token\"\n}\n
"},{"location":"datapacks/ntcProduct/#success-response","title":"Success Response","text":"\n{\n \"status\": true,\n \"detail\": {\n \"packages\": [\n {\n \"priority_no\": 0,\n \"product_name\": \"NT-NT Unlimited Voice/SMS/Data\",\n \"amount\": 20.0,\n \"short_detail\": \"Subscription is valid for one hour from the time of purchase.\",\n \"package_id\": \"20\",\n \"description\": \"\",\n \"product_type\": \"All Pack\",\n \"validity\": \"1 Hour\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 0,\n \"product_name\": \"NT-NT 300 SMS Offer\",\n \"amount\": 60.0,\n \"short_detail\": \"Get NT-NT 300 SMS Offer valid for 28 days just at Rs 60\",\n \"package_id\": \"27\",\n \"description\": \"\",\n \"product_type\": \"Sms Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"120 MB Day Data Pack (6AM - 6PM)\",\n \"amount\": 10.0,\n \"short_detail\": \"Get 120 MB Day Data Pack (6AM - 6PM) Valid for 6AM-6PM just at Rs 10\",\n \"package_id\": \"28\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"1 Day\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"100 MB All Time Data Pack\",\n \"amount\": 15.0,\n \"short_detail\": \"Get 100 MB All Time Data Pack valid for 1 day just at Rs 15\",\n \"package_id\": \"29\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"1 Day\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"250 MB Day Data Pack (6AM - 6PM)\",\n \"amount\": 15.0,\n \"short_detail\": \"Get 250 MB Day Data Pack (6AM - 6PM) valid for 6AM-6PM just at Rs 15\",\n \"package_id\": \"30\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"1 Day\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"250 MB All Time Data Pack\",\n \"amount\": 24.98,\n \"short_detail\": \"Get 250 MB All Time Data Pack valid for 1 day just at Rs 24.98\",\n \"package_id\": \"31\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"1 Day\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"1GB/day Data Pack\",\n \"amount\": 45.0,\n \"short_detail\": \"Get 1GB/day Data Pack valid for 1 day just at Rs 45\",\n \"package_id\": \"32\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"1 Day\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"Unlimited Youtube Pack\",\n \"amount\": 55.0,\n \"short_detail\": \"Get Unlimited Youtube Pack valid for 3 days just for Rs 55\",\n \"package_id\": \"22\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"3 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"Unlimited Facebook Pack\",\n \"amount\": 55.0,\n \"short_detail\": \"Get Unlimited Facebook Pack valid for 3 days just for Rs 55\",\n \"package_id\": \"21\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"3 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"500 MB All Time Data Pack\",\n \"amount\": 60.0,\n \"short_detail\": \"Get 500 MB All Time Data Pack valid for 3 days just at Rs 60\",\n \"package_id\": \"33\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"3 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"800 MB All Time Data Pack\",\n \"amount\": 99.99,\n \"short_detail\": \"Get 800 MB All Time Data Pack valid for 7 days just at Rs 99.99\",\n \"package_id\": \"34\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"7 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"1GB All network+3GB (4G Network only)\",\n \"amount\": 99.99,\n \"short_detail\": \"Get 1GB All network+3GB (4G Network only) valid for 7 days just at Rs 99.99\",\n \"package_id\": \"35\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"5 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"4GB(Main Data) + 1GB/day (Facebook+Youtube) Pack\",\n \"amount\": 179.99,\n \"short_detail\": \"Main data is for all applications and add on data per day is for Facebook and YouTube.\\nValid for 7 days\",\n \"package_id\": \"23\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"7 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"2GB All network+8GB (4G Network only)\",\n \"amount\": 200.0,\n \"short_detail\": \"Get 2GB All network+8GB (4G Network only) valid for 7 days just at Rs 200\",\n \"package_id\": \"36\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"7 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"2.5 GB All Time Data Pack\",\n \"amount\": 280.0,\n \"short_detail\": \"Get 2.5 GB Data valid for 28 days just at Rs 280\",\n \"package_id\": \"38\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"7 GB All Time Data Pack\",\n \"amount\": 499.99,\n \"short_detail\": \"Get 7 GB Data valid for 28 days just at Rs 499.99\",\n \"package_id\": \"39\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"10GB(Main Data) + 1GB/day (Facebook+Youtube) Pack\",\n \"amount\": 598.99,\n \"short_detail\": \"Main data is for all applications and add on data per day is for Facebook and YouTube.\\nValid for 28 days\",\n \"package_id\": \"24\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"16 GB All Time Data Pack\",\n \"amount\": 799.99,\n \"short_detail\": \"Get 16 GB Data valid for 28 days just at Rs 799.99\",\n \"package_id\": \"40\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"30 GB All Time Data Pack\",\n \"amount\": 1599.99,\n \"short_detail\": \"Get 30 GB Data valid for 28 days just at Rs 1599.99\",\n \"package_id\": \"41\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n }\n ]\n }\n}\n
"},{"location":"datapacks/ntcProduct/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/use/ntc-package/
Request Method: POST
Service Parameters:
\n\n{\n \"token\": \"token\",\n \"package_id\": \"package_id\",\n \"amount\": \"amount\"\n}\n
"},{"location":"datapacks/ntcProduct/#success-response_1","title":"Success Response:","text":"\n\n{\n \"status\": true,\n \"detail\": {\n \"transaction_id\": \"transaction_id\",\n \"amount\": \"amount\",\n \"package_id\": \"package_id\",\n \"status\": \"success\"\n }\n}\n
"},{"location":"datapacks/ntcProduct/#error-response","title":"Error Response:","text":"\n\n{\n \"status\": false,\n \"detail\": \"Error message describing what went wrong.\"\n}\n
"},{"location":"servicecharge/service-charge/","title":"Service Charges API","text":"This API allows you to create service charges for a specific service by providing relevant details such as the token, service identifier, and amount.
"},{"location":"servicecharge/service-charge/#endpoint","title":"Endpoint","text":"URL: {{base_url}}/api/account/service-charges/ Method: POST
"},{"location":"servicecharge/service-charge/#request-body","title":"Request Body","text":"To create a service charge, you must send a JSON object in the body of the request. The required fields are:
token: The authentication token (string).service_slug: A unique identifier for the service (string).amount: The amount on which the service charge is calculated (numeric).
Example request body:
\n{\n \"token\": \"your_auth_token\",\n \"service_slug\": \"example_service_slug\",\n \"amount\": 500\n}\n
"},{"location":"servicecharge/service-charge/#response","title":"Response","text":"If the request is successful, the response will include a status and the calculated service charge details.
Example response:
\n{\n \"status\": true,\n \"details\": {\n \"amount\": 500,\n \"service_charge\": 5.0\n }\n}\n
"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Khalti Services Documentation","text":""},{"location":"#version-72","title":"Version 7.2","text":""},{"location":"#last-update-16-janaury-2025","title":"Last Update 16 Janaury, 2025","text":"Check the Change Log here.
"},{"location":"#introduction","title":"Introduction","text":"Khalti is the new generation Payment Gateway, Digital Wallet and API provider for various services. We provide a dashboard where you will be able to see your available balance, list of services, commissions and real-time status of services consumed. We also provide dlr callback for all the requests, so that your system gets updated with the live status.
We provide REST API for consumption of services. Our single API serves all the services.
"},{"location":"#live-environment","title":"Live Environment","text":" - URL: https://services.khalti.com
"},{"location":"#test-environment","title":"Test Environment","text":" - URL: https://uatservices.khalti.com
"},{"location":"#test-credentials","title":"Test Credentials","text":" - Access the credentials: Test Credentials Spreadsheet
"},{"location":"#token-generation","title":"Token Generation","text":" - Generate a token: Token Generation Steps
"},{"location":"Bus/add-info/","title":"Add Info for API Documentation","text":""},{"location":"Bus/add-info/#overview","title":"Overview","text":"This document describes the API for adding passenger information after booking a bus ticket. The API allows users to provide details such as boarding points and passenger information before proceeding to payment.
"},{"location":"Bus/add-info/#api-endpoint","title":"API Endpoint","text":"Request URL: {{base_url}}/api/servicegroup/addinfo-v2/bus/ Request Method: POST
"},{"location":"Bus/add-info/#request-body","title":"Request Body","text":"\n{\n \"token\": \"{{token}}\",\n \"session_id\": \"{{session_id}}\",\n \"bus_id\": \"{{bus_id}}\",\n \"ticket_serial_no\": \"{{ticket_serial_no}}\", // Optional: Do not send if not obtained in Book Bus API\n \"mobile_number\": \"9843223423\",\n \"boarding_point\": \"{{boarding_point}}\",\n \"email\": \"test@okay.com\",\n \"name\": \"TEST\",\n \"seats\": \"[{\\\"seat\\\":\\\"{{seat1}}\\\",\\\"fullName0\\\":\\\"test trest A\\\",\\\"nationality\\\":\\\"nepali\\\",\\\"age0\\\":\\\"25\\\"},{\\\"seat\\\":\\\"{{seat2}}\\\",\\\"fullName0\\\":\\\"test trest A\\\",\\\"nationality\\\":\\\"nepali\\\",\\\"age0\\\":\\\"25\\\"}]\"\n}\n
"},{"location":"Bus/add-info/#api-response","title":"API Response","text":""},{"location":"Bus/add-info/#success-response","title":"Success Response","text":"\n{\n \"status\": true,\n \"detail\": \"Now you can proceed to the payment.\",\n \"ticket_serial_no\": \"\"\n}\n
"},{"location":"Bus/add-info/#conclusion","title":"Conclusion","text":"This API allows clients to add passenger information necessary for completing the bus booking process. Ensure all provided parameters are valid for successful processing before proceeding to payment.
"},{"location":"Bus/bus-booking/","title":"Bus Booking API Documentation","text":""},{"location":"Bus/bus-booking/#overview","title":"Overview","text":"This document describes the API for booking a bus ticket. The API allows users to specify their seat preferences and provides details about the booking confirmation.
"},{"location":"Bus/bus-booking/#api-endpoint","title":"API Endpoint","text":"Request URL: {{url}}/api/servicegroup/book-v2/bus/
Request Method: POST
"},{"location":"Bus/bus-booking/#request-parameters","title":"Request Parameters","text":"\n{\n \"token: \"{{live_token}}\",\n \"session_id\": \"{{session_id}}\",\n \"bus_id\": \"{{bus_id}}\",\n \"seats\": \"[\"{{seat1}}\", \"{{seat2}}\"] (array of selected seats)\"\n}\n
"},{"location":"Bus/bus-booking/#api-response","title":"API Response","text":""},{"location":"Bus/bus-booking/#success-response","title":"Success Response","text":"\n{\n \"status\": true,\n \"detail\": {\n \"boarding_point\": [\n \"Gongabu Bus Park(06:00 AM)\",\n \"Basundhara(06:15 AM)\",\n \"Chabahil(06:30 AM)\",\n \"Gaushala(06:45 AM)\",\n \"Koteshwor(07:00 AM)\",\n \"Jadibutti(07:05 AM)\",\n \"Kasaultar(07:10 AM)\",\n \"Thimi(07:25 AM)\",\n \"Jagati(07:45 AM)\",\n \"Banepa(08:00 AM)\",\n \"Dhulikhel(08:15 AM)\"\n ],\n \"ticket_serial_no\": \"5115799-B\"\n }\n}\n
"},{"location":"Bus/bus-booking/#conclusion","title":"Conclusion","text":"This API allows clients to book bus tickets by specifying their seat preferences. Ensure all provided parameters are valid for successful booking confirmation.
"},{"location":"Bus/payment/","title":"Commit Bus Booking API Documentation","text":""},{"location":"Bus/payment/#overview","title":"Overview","text":"This document describes the API for committing a bus booking transaction. The API finalizes the booking process and returns transaction details.
"},{"location":"Bus/payment/#api-endpoint","title":"API Endpoint","text":"Request URL: {{base_url}}/api/servicegroup/commit-v2/bus/ Request Method: POST
"},{"location":"Bus/payment/#request-parameters","title":"Request Parameters","text":" - token:
{{token}} - session_id:
{{session_id}}
"},{"location":"Bus/payment/#api-response","title":"API Response","text":""},{"location":"Bus/payment/#success-response","title":"Success Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": {\n \"bus_no\": \"\",\n \"message\": \"Booking Successfully Done\",\n \"ticket_serial_number\": \"810610-101576400\",\n \"contact_info\": [\n \"Counter: \",\n \"Contact Number: \"\n ]\n }\n}\n
"},{"location":"Bus/payment/#conclusion","title":"Conclusion","text":"This API allows clients to finalize their bus booking transaction and provides essential details regarding the booking. Ensure all provided parameters are valid for successful completion.
"},{"location":"Bus/route/","title":"Bus Routes API Documentation","text":""},{"location":"Bus/route/#overview","title":"Overview","text":"This document describes the API for fetching bus routes. The API provides a list of available bus routes and their corresponding labels.
"},{"location":"Bus/route/#api-endpoint","title":"API Endpoint","text":"Request URL: {{base_url}}/api/servicegroup/routes/bus/ Request Method: POST
"},{"location":"Bus/route/#parameters","title":"Parameters","text":"\n{\n \"token\": \"{{token}}\"\n}\n
"},{"location":"Bus/route/#api-response","title":"API Response","text":""},{"location":"Bus/route/#success-response","title":"Success Response","text":"\n{\n \"status\": true,\n \"routes\": [\n {\n \"label\": \"radhe radhe\",\n \"value\": \"radhe radhe\"\n },\n {\n \"label\": \"Bardibas chock\",\n \"value\": \"Bardibas chock\"\n },\n {\n \"label\": \"Kathmandu Valley\",\n \"value\": \"Kathmandu Valley\"\n },\n {\n \"label\": \"Lumbini\",\n \"value\": \"Lumbini\"\n },\n {\n \"label\": \"Kakadvitta\",\n \"value\": \"Kakadvitta\"\n },\n {\n \"label\": \"Sindhuli\",\n \"value\": \"Sindhuli\"\n },\n {\n \"label\": \"Gaur\",\n \"value\": \"Gaur\"\n },\n {\n \"label\": \"Nepalgunj\",\n \"value\": \"Nepalgunj\"\n },\n {\n \"label\": \"Damauli\",\n \"value\": \"Damauli\"\n },\n {\n \"label\": \"Hile\",\n \"value\": \"Hile\"\n },\n {\n \"label\": \"Khurkot\",\n \"value\": \"Khurkot\"\n },\n {\n \"label\": \"Budhabare\",\n \"value\": \"Budhabare\"\n },\n {\n \"label\": \"Kakarbhitta\",\n \"value\": \"Kakarbhitta\"\n },\n {\n \"label\": \"Surunga\",\n \"value\": \"Surunga\"\n },\n {\n \"label\": \"Biratnagar\",\n \"value\": \"Biratnagar\"\n },\n {\n \"label\": \"Gaushala\",\n \"value\": \"Gaushala\"\n },\n {\n \"label\": \"Besisahar\",\n \"value\": \"Besisahar\"\n },\n {\n \"label\": \"CG Shashwat Dham\",\n \"value\": \"CG Shashwat Dham\"\n },\n {\n \"label\": \"Dhangadhi\",\n \"value\": \"Dhangadhi\"\n },\n {\n \"label\": \"Jaleshwor\",\n \"value\": \"Jaleshwor\"\n }\n ]\n}\n
"},{"location":"Bus/route/#conclusion","title":"Conclusion","text":"This API allows clients to retrieve a list of bus routes. Ensure the token is valid for successful responses.
"},{"location":"Bus/search/","title":"Bus Search API Documentation","text":""},{"location":"Bus/search/#overview","title":"Overview","text":"This document describes the API for searching buses between specified locations. The API allows users to find available buses based on their travel preferences.
"},{"location":"Bus/search/#api-endpoint","title":"API Endpoint","text":"Request URL: {{url}}/api/servicegroup/search-v2/bus/ Request Method: GET
"},{"location":"Bus/search/#parameters","title":"Parameters","text":"\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"from\": \"from\",\n \"to\": \"to\",\n \"date\": \"date\"\n}\n
"},{"location":"Bus/search/#api-response","title":"API Response","text":""},{"location":"Bus/search/#success-response","title":"Success Response","text":"\n{\n \"status\": true,\n \"buses\": [\n {\n \"id\": \"gongabu-buspark:12746\",\n \"ticket_price\": 2170,\n \"departure_time\": \"05:30 AM\",\n \"is_tourist_bus\": false,\n \"bus_type\": \"NBus 43(C4 B2 L1)\",\n \"amenities\": [],\n \"date_en\": \"2024-09-26\",\n \"operator\": \"Chandika Yatayat\",\n \"bus_no\": \"C31P1D-HILE\",\n \"commission\": 0\n }\n ],\n \"session_id\": 15005\n}\n
"},{"location":"Bus/search/#error-response","title":"Error Response","text":"\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Buses for this day could not be found\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"Bus/search/#conclusion","title":"Conclusion","text":"This API allows clients to search for buses between specified locations. Ensure the provided parameters are correct for successful responses.
"},{"location":"Bus/seat/","title":"Bus Seats Information API Documentation","text":""},{"location":"Bus/seat/#overview","title":"Overview","text":"This document describes the API for retrieving seating information for a specific bus. The API provides details about the seat layout and their booking statuses.
"},{"location":"Bus/seat/#api-endpoint","title":"API Endpoint","text":"Request URL: {{base_url}}/api/servicegroup/seatsinfo/bus/ Request Method: POST
"},{"location":"Bus/seat/#parameters","title":"Parameters","text":"\n \"token\":\"{{token}}\",\n \"bus_id\": \"{{bus_id}}\",\n \"session_id\": \"{{session_id}}\",\n
"},{"location":"Bus/seat/#api-response","title":"API Response","text":""},{"location":"Bus/seat/#success-response","title":"Success Response","text":"\n{\n \"seat_layout\": [\n {\n \"display_name\": \"C1\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"C2\",\n \"booking_status\": \"Yes\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"C3\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"C4\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B\u0915\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B\u0916\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A1\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A2\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B1\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B2\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A3\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A4\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B3\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B4\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A5\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A6\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B5\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B6\",\n \"booking_status\": \"Yes\"\n },\n {\n \"display_name\": \"A7\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A8\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B7\",\n \"booking_status\": \"Yes\"\n },\n {\n \"display_name\": \"B8\",\n \"booking_status\": \"Yes\"\n },\n {\n \"display_name\": \"A9\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A10\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B9\",\n \"booking_status\": \"Yes\"\n },\n {\n \"display_name\": \"B10\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A11\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A12\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B11\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B12\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A13\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A14\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B13\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B14\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A15\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A16\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"na\",\n \"booking_status\": \"na\"\n },\n {\n \"display_name\": \"B15\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B16\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A17\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"A18\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"19\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B17\",\n \"booking_status\": \"No\"\n },\n {\n \"display_name\": \"B18\",\n \"booking_status\": \"No\"\n }\n ],\n \"no_of_column\": 5,\n \"status\": true\n}\n
"},{"location":"Bus/seat/#how-to-construct-bus-seat-layout","title":"How to Construct Bus Seat Layout","text":"These things must be considered while making the seat layout:
- Determine the Total Number of Columns For example, if
no_of_column is 5, then the seat layout must have 5 columns.
Note: The value for each seat must be checked from left to right as shown in the table below:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 - Iterate for Each Cell
displayName: - If \"na\", there is no seat.
- If other than \"na\", that is the seat name or number.
-
bookingStatus:
- If \"na\", there is no seat.
- If \"Yes\", the seat is booked.
- If \"No\", the seat is available.
-
Response for No Seat
\n {\n \"displayName\": \"na\",\n \"bookingStatus\": \"na\"\n }\n
- Response for Booked Seat
\n {\n \"displayName\": \"A1\",\n \"bookingStatus\": \"Yes\"\n }\n
- Response for Available Seat
\n {\n \"displayName\": \"A2\",\n \"bookingStatus\": \"No\"\n }\n
"},{"location":"Bus/seat/#example-seat-layout","title":"Example Seat Layout","text":"This is how the seat layout might look based on the above responses:
A1 A2 B1 B2 A3 A4 B3 B4 A5 A6 B5 B6 A7 A8 B7 B8 A9 A10 B9 B10 A11 A12 B11 B12 14 15 16 17 18"},{"location":"Bus/seat/#conclusion","title":"Conclusion","text":"This API allows clients to retrieve seating information for a specified bus. Ensure the provided parameters are valid for successful responses.
"},{"location":"Bus/ticket-download/","title":"Download Ticket API Documentation","text":""},{"location":"Bus/ticket-download/#overview","title":"Overview","text":"This document describes the API for downloading a bus ticket. The API allows users to retrieve a ticket in a specified format using their booking details.
"},{"location":"Bus/ticket-download/#api-endpoint","title":"API Endpoint","text":"Request URL: {{base_url}}/api/servicegroup/downloadticket/bus/ Request Method: POST
"},{"location":"Bus/ticket-download/#request-parameters","title":"Request Parameters","text":"\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"bus_id\": \"{{bus_id}}\",\n \"session_id\": \"{{session_id}}\"\n}\n
"},{"location":"Bus/ticket-download/#api-response","title":"API Response","text":""},{"location":"Bus/ticket-download/#success-response","title":"Success Response","text":"\n{\n \"status\": true,\n \"data\": \"JVBERi0xLjUKJbXtrvsKNCAwIG9iago8PCAvTGVuZ3RoIDUgMCBSCiAgIC9GaWx0ZXIgL0ZsYXRl\\nRGVjb2RlCj4+CnN0cmVhbQp4nN1V32/bNhB+119xj9QA0UeKFMUgCFbHKYIM8dpaRR/cPTCOHHuJ\\nrUSWt+a/31E/bNkuhuWlwArDsnnkfXff8e6TAKRPJOiRKgGzVfASfISXIJFcahDacqMkKIPcGAP0\\n1FDm8AXWAdae5QMMHMLDpvNIkCsrYQU6jjlKs7M87S1WcFtbWp/denEUt4fSWvoosrV0KN36FGX+\\nS59UG+6nIiW15orI/HdSUidcUsh9Op1ln45MDTe1pfXZrRdHcfsojaWPkraWDqVbn6IckmrD/VSk\\n4lgRwBs4eYeDZFrDPpc4IY77VHbLxWHIQwSUBwimMXQI7fIE4ZBKE+j/TeU402EWpP5crYv1v3bw\\njOVSoI1TyFbBYB5hhCAgmwdT9j4UKSuLFZzBb65arNz6fhv+kd0EXloFT1CJxEB2H7BhUTzm93D3\\nCmH2p9+2XEuMk3rzslhXblbBKK/c8mnjT1xlvXoTlRg1GN9tVGvVFfslMG2+tV2nwrZJ24Rjgn5N\\nyt4QhME3A6Mi+Pg29pJkRyY6kcfsWbacPeYVeGbL9QMQCZ/4YPLs1nB+DoN3s2rrnrL8WwXn83w+\\nR0wS+toLuLiA4eiyQRMN2jkiigtP/PbyMEy5ctWyxZ5HorN70iTFcWyEr+GUXZa5q6jE70JhWAUS\\npYxQRCKuL6QPKSVPpZapgijmGpWJdQORhUJoVtBtfgilYcXjwpWuc99FZtDmsgOMeoiSa2O1qhHZ\\nKH92ZbWl68qWq/yYAgMUZ4jw4fYEccpuim25zl/hmn6bFP6lsA53RZ1Sev54Xccf49KjNGUaTuo9\\nZZPFcl69hcUh5o9mNGXj5cOiOmWCJEr+46851omOVdM4w+0GfPMge33OwyiRVrDfn/PSVUVzeVKR\\nZ6rQ0njtPMZFGKk0lqwboRE1cG0S1IpGstL9lT811uMmjPaIkSApSWxqG+Sb7equgOulm+Ut/Ji6\\n8Alul7OyuNtuaijSTGGUEUmXT\"\n}\n
"},{"location":"Bus/ticket-download/#conclusion","title":"Conclusion","text":"This API allows clients to download their bus tickets after a successful booking. Ensure that all provided parameters are valid for successful retrieval of the ticket.
"},{"location":"Cable%20Car/cablecar/","title":"21. Cable Car","text":"Please find the name of the cable car and their respective slug.
- Manakamana Cable Car: manakamana-cable-car
- Annapurna Cable Car: annapurna-cable-car
Type: Multi-Step API
"},{"location":"Cable%20Car/cablecar/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/cable-car/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"unique reference\",\n \"service\": \"slug\",\n \"trip_type\": \"One Way/Two Way\"\n}\n
Response:
\n{\n \"trips\": [\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Normal\",\n \"price\": 395.0,\n \"vat\": 45.44,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Normal\"\n },\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Child\",\n \"price\": 240.0,\n \"vat\": 27.61,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Child\"\n },\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Student\",\n \"price\": 300.0,\n \"vat\": 34.51,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Student\"\n },\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Elderly\",\n \"price\": 275.0,\n \"vat\": 31.64,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Elderly\"\n },\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Diff-Able\",\n \"price\": 190.0,\n \"vat\": 21.86,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Differently Able\"\n },\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Indian\",\n \"price\": 496.0,\n \"vat\": 57.06,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Indian Normal\"\n },\n {\n \"trip_type\": \"One Way\",\n \"passenger_type\": \"Indian-CH\",\n \"price\": 320.0,\n \"vat\": 36.81,\n \"lc\": 0.0,\n \"passenger_type_desc\": \"Indian Child\"\n }\n ],\n \"session_id\": 3971,\n \"status\": true\n}\n
"},{"location":"Cable%20Car/cablecar/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/cable-car/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"unique reference\",\n \"session_id\": \"session_id\", // obtained from Detail Fetch API\n \"trip_type\": \"One Way/Two Way\", // obtained from Detail Fetch API\n \"contact_name\": \"contact_name\",\n \"mobile_number\": \"mobile_number\",\n \"tickets\": [\n {\n \"passenger_type\": \"passenger_type\", // obtained from Detail Fetch API\n \"passenger_count\": passenger_count\n }\n ],\n \"amount\": \"amount\" // obtained from Detail Fetch API\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"transaction_id\": \"443\",\n \"bill_number\": \"T4767711565\"\n },\n \"detail\": \"Payment Successful\",\n \"credits_consumed\": 395.0,\n \"credits_available\": \"xxxxx\",\n \"id\": 115044\n}\n
"},{"location":"Cable%20Car/cablecar/#3-ticket-api","title":"3. Ticket API","text":"Request URL: {{base_url}}/api/servicegroup/downloadticket/cable-car/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"session_id\": 3969, // obtained from Detail Fetch API\n \"service\": \"slug\",\n \"base64\": true\n}\n
"},{"location":"Electricity/Himchuli/","title":"Himchuli Electricity","text":"Type: Multi-Step API
Service_slug: himchuli
"},{"location":"Electricity/Himchuli/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/easternhawk/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"reference\": \"Unique Identifier\",\n \"service_slug\": \"himchuli\",\n \"customer_number\": \"356\"\n}\n
Response:
\n{\n \"amount\": \"1708.00\",\n \"customer_id\": \"567\",\n \"name\": \"Gyan bahadur majhi\",\n \"capacity\": \"15A\",\n \"area\": \"03-7430\",\n \"session_id\": 2318,\n \"status\": true\n}\n
Fields:
- amount: The total amount due for payment.
- customer_id: The unique identifier for the customer.
- name: The name of the customer.
- capacity: The electrical capacity (e.g., \"15A\").
- area: The area code or identifier for the location.
- session_id: The unique session ID for the transaction.
"},{"location":"Electricity/Himchuli/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/easternhawk/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"amount\": \"1708.00\",\n \"reference\": \"Unique Reference\",\n \"session_id\": \"2318\" \n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 400.0,\n \"credits_available\": 9999558289.38,\n \"id\": 36219\n}\n
Fields:
- state: The state of the transaction (
Success). - message: A message indicating the result of the transaction (
Successfully Completed Transaction). - extra_data: Any additional data related to the transaction.
- detail: Additional details about the payment, including a confirmation message (
Success). - credits_consumed: The total credits consumed for this transaction.
- credits_available: The total credits available after this transaction.
- id: The unique ID associated with the transaction.
"},{"location":"Electricity/dreamer/","title":"20.3 Dreamer Electricity","text":"Below is the list of Life Insurances under Dreamer Electricity and their service_slug:
\u2026 others to be added
Type: Multi-Step API
"},{"location":"Electricity/dreamer/#khamari-khola-electricity-khamari-khola-electricity","title":"Khamari Khola Electricity: khamari-khola-electricity","text":""},{"location":"Electricity/dreamer/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/dreamer-electricity/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"customer_code\": \"01-1\",\n \"reference\": \"unique_reference\",\n \"service_slug\": \"service_slug\"\n}\n
Response:
\n{\n \"consumer_id\": 13,\n \"consumer_no\": \"01-1\",\n \"consumer_name\": \"01-1 Bryan Hamal\",\n \"address\": \"Tole\",\n \"total_payable_amount\": 180,\n \"total_discount\": 20,\n \"total_penalty\": 0,\n \"total_bill_amount\": 200,\n \"due_bills\": [\n {\n \"bill_id\": 58,\n \"bill_year\": \"2078\",\n \"bill_month\": \"Baishak\",\n \"bill_amount\": 200,\n \"penalty\": 0,\n \"discount\": 20,\n \"no_of_days\": 2,\n \"total_amount\": 180\n }\n ],\n \"session_id\": 119,\n \"status\": true\n}\n
Fields:
- consumer_id: The unique ID of the consumer.
- consumer_no: The consumer number.
- consumer_name: The name associated with the consumer number.
- address: The address of the consumer.
- total_payable_amount: The total amount payable after discounts and penalties.
- total_discount: The total discount applied.
- total_penalty: The total penalty incurred.
- total_bill_amount: The total amount of the bill before discounts and penalties.
- due_bills: An array containing details of the due bills, including:
- bill_id: The unique ID of the bill.
- bill_year: The year of the bill.
- bill_month: The month of the bill.
- bill_amount: The amount of the bill.
- penalty: The penalty amount.
- discount: The discount applied.
- no_of_days: The number of days overdue.
- total_amount: The total amount due after applying the penalty and discount.
- session_id: The unique session ID for the transaction.
"},{"location":"Electricity/dreamer/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/dreamer-electricity/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"unique_reference\",\n \"session_id\": \"obtained from previous API\",\n \"amount\": \"obtained from previous API 'total_payable_amount'\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"receipt_no\": 2\n },\n \"detail\": \"Payment Successful\",\n \"credits_consumed\": 180.0,\n \"credits_available\": \"xxxxx\",\n \"id\": 107743\n}\n
Fields:
- state: The state of the transaction (
Success). - message: A message indicating the result of the transaction (
Successfully Completed Transaction). - extra_data: Any additional data related to the transaction, including:
- receipt_no: The receipt number for the transaction.
- detail: Additional details about the payment, including:
- message: A message indicating the success of the payment (
Payment Successful). - credits_consumed: The total credits consumed for this transaction.
- credits_available: The total credits available after this transaction.
- id: The unique ID associated with the transaction.
Note This
This documentation outlines the request and response formats for the Dreamer Electricity API, including details for both the Detail Fetch API and the Payment API.
"},{"location":"Electricity/nea/","title":"Electricity Payment API Documentation","text":""},{"location":"Electricity/nea/#overview","title":"Overview","text":"This document provides details on how to interact with the Electricity Payment APIs. The process involves retrieving counters, fetching bill details, calculating service charges, and making payments.
"},{"location":"Electricity/nea/#1-get-counters","title":"1. Get Counters","text":"URL: {{base_url}}/api/servicegroup/counters/nea/ Method: POST
Request Body:
\n{\n \"token\": \"token\"\n}\n
"},{"location":"Electricity/nea/#success-response","title":"Success Response","text":"\n{\n \"status\": true,\n \"counters\": [\n {\n \"name\": \"AANBU DC\",\n \"value\": \"243:aanbu-dc\"\n },\n {\n \"name\": \"ACHHAM DC\",\n \"value\": \"391:achham-dc\"\n },\n {\n \"name\": \"RATNAPARK DC\",\n \"value\": \"201:ratnapark-dc\"\n }\n ]\n}\n
"},{"location":"Electricity/nea/#2-get-details-api","title":"2. Get details API","text":"URL:{{url}}/api/servicegroup/details/nea/
Request: POST
Service Params:
\n{\n \"token\": \"token\",\n \"sc_no\": \"customer sc number, e.g. 02A.12.512\",\n \"reference\": \"unique-reference\",\n \"office_code\":\"one of the 'value' fields from Get Counters response\",\n \"consumer_id\": \"consumer ID, e.g. 3042\"\n}\n
Note : sc_no : 3 alphanumeric string separated by dot.
"},{"location":"Electricity/nea/#success-response_1","title":"Success Response","text":"\n{\n \"session_id\": 5,\n \"consumer_name\": \"Michael Jackson\",\n \"due_bills\": [\n {\n \"bill_amount\": \"200\",\n \"bill_date\": \"2017-02-24\",\n \"days\": 5,\n \"payable_amount\": 200,\n \"due_bill_of\": \"2073 Magh\",\n \"status\": \"Normal\"\n },\n {\n \"bill_amount\": \"200\",\n \"bill_date\": \"2017-02-24\",\n \"days\": 13,\n \"payable_amount\": 250,\n \"due_bill_of\": \"2073 Falgun\",\n \"status\": \"-25% Penalty\"\n }\n ],\n \"total_due_amount\": 450,\n \"status\": true\n}\n
Important
- The minimum payable amount for NEA (Electricity) is the due amount of the oldest bill.
- For the provided bill details, the minimum payable amount is
200 (2073 Magh). - Partial payments are allowed.
"},{"location":"Electricity/nea/#3-get-service-charge","title":"3. Get service charge","text":"URL:{{url}}/api/servicegroup/servicecharge/nea/
Request: POST
Service Params:
\n{\n \"amount\": \"Total amount intended to pay\",\n \"session_id\": \"value obtained during detail fetch step\",\n \"token\": \"token\"\n}\n
"},{"location":"Electricity/nea/#success-response_2","title":"Success Response","text":"\n{\n \"service_charge\": 5.0,\n \"amount\": 600.0,\n \"status\": true\n}\n\n
Description: Calculate the service charge for the payment amount. The service charge applies only for amounts greater than 500.
Note: - For amounts less than 500, the service charge is 0. - This API only calculates the charge. The amount provided to the Make Payment API should exclude the service charge.
"},{"location":"Electricity/nea/#4-make-payment","title":"4. Make Payment","text":"URL: {{url}}/api/servicegroup/commit/nea/
Method: POST
Response Body
\n{\n \"token\": \"token\",\n \"amount\": \"Total amount intended to pay (excluding service charge)\",\n \"session_id\": \"value obtained during detail fetch step\",\n \"reference\": \"unique reference\"\n}\n
"},{"location":"Electricity/nea/#success-response_3","title":"Success Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Amount Paid Successfully\",\n \"credits_consumed\": 600.0,\n \"credits_available\": 9996,\n \"id\": 61892\n}\n
"},{"location":"Electricity/nea/#error-response","title":"Error Response","text":"\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Max number exceeding\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"Electricity/softlab/","title":"** SoftLab Electricity**","text":"Type: Multi-Step API
"},{"location":"Electricity/softlab/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/softlab-electricity/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"customer_code\": \"12\",\n \"month\": \"0\",\n \"reference\": \"unique_reference\",\n \"service_slug\": \"badagaun-electricity\"\n}\n
Response:
\n{\n \"customer_code\": \"12\",\n \"customer_name\": \"\u0905\u0930\u094d\u091c\u0941\u0928 \u0936\u094d\u0930\u0947\u0937\u094d\u0920 (H2O Software)\",\n \"address\": \"\u0907.\u0917\u093e.\u092a\u093e.-3, \u092b\u093f\u0938\u094d\u0932\u093f\u0919\u094d\u0917\",\n \"mobile_number\": \"\",\n \"current_month_dues\": \"0\",\n \"current_month_discount\": \"0\",\n \"current_month_fine\": \"0\",\n \"total_credit_sales_amount\": \"0\",\n \"total_advance_amount\": \"0.0000\",\n \"previous_dues\": \"2810\",\n \"total_dues\": \"2810\",\n \"minimum_payable_amount\": \"2810\",\n \"session_id\": 207,\n \"status\": true\n}\n
Fields:
- customer_code: The code associated with the customer.
- customer_name: The name of the customer.
- address: The address of the customer.
- mobile_number: The mobile number of the customer (if available).
- current_month_dues: Dues for the current month.
- current_month_discount: Discount applied for the current month.
- current_month_fine: Fine for the current month.
- total_credit_sales_amount: Total amount from credit sales.
- total_advance_amount: Total advance amount paid.
- previous_dues: Outstanding dues from previous months.
- total_dues: Total amount due.
- minimum_payable_amount: Minimum amount that must be paid.
- session_id: Unique session ID for the transaction.
- status: Indicates if the API call was successful (
true).
"},{"location":"Electricity/softlab/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/softlab-electricity/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"session_id\": \"obtained from previous API\",\n \"amount\": \"obtained from previous API 'total_dues'\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"due_amount\": \"0\",\n \"detail\": {\n \"message\": \"Successful Payment\",\n \"due_amount\": \"0\"\n },\n \"credits_consumed\": 2810.0,\n \"credits_available\": 98639503.46,\n \"id\": 107793\n}\n
Fields:
- state: The state of the transaction (
Success). - message: A message indicating the result of the transaction (
Successfully Completed Transaction). - extra_data: Any additional data related to the transaction (empty in this case).
- due_amount: The remaining amount due after payment.
- detail: Additional details about the payment, including:
- message: A message indicating the success of the payment (
Successful Payment). - due_amount: The remaining amount due (
0). - credits_consumed: The total credits consumed for this transaction.
- credits_available: The total credits available after this transaction.
- id: The unique ID associated with the transaction.
Note
This documentation provides a clear and detailed view of how to use the SoftLab Electricity API, including the request and response structures for both the Detail Fetch API and the Payment API.
"},{"location":"Electricity/watermark/","title":"Watermark Electricity","text":"Note: Below is the list of electricity services under Watermark Electricity and their respective service_slug:
"},{"location":"Electricity/watermark/#watermark-electricity-slugs","title":"WaterMark Electricity Slugs","text":"Name service_slug Badagaun Samudayik Gramin Bidyut badagaun-samudayik-gramin-bidyut Bhimad Electricity bhimad-electricity Bungdikali Samudayik Bidhutikaran bungdikali-samudayik-bidhutikaran Chhongpulunglaparata Khola Sana chhongpulunglaparata-khola-sana Deep Jyoti Community Electricity deep-jyoti-community-electricity Gramin Bidhut gramin-bidhut Gramin Prubadhar gramin-prubadhar Halesi Community Rural Electricity halesi-community-rural-electricity Handikhola Ditiya Gramin handikhola-ditiya-gramin Kachanapur Gramin Bidhut kachanapur-gramin-bidhut Kalikapur Gramin Community Electricity kalikapur-gramin-community-electricity Khumbu Bijuli khumbu-bijuli Kusum Community Electricity kusum-community-electricity Maha Shivashakti Gramin Bidhyut maha-shivashakti-gramin-bidhyut Marsyandi Electricity marsyandi-electricity Matribhumi Gramin Vidhyut Sahakari Sanstha matribhumi-gramin-vidhyut-sahakari-sanstha Morang Community Electricity morang-community-electricity Nagre Gagarche Gramin Eletricity nagre-gagarche-gramin-eletricity Nawadip Samudayik Bidhut nawadip-samudayik-bidhut Pragatinagar Electricity V2 pragatinagar-electricity-v2 Purandhara Samudayik Bidyut purandhara-samudayik-bidyut Roshani Gramin Bidhyut roshani-gramin-bidhyut Samudayik Bidhut Dhorfirdi samudayik-bidhut-dhorfirdi Samudayik Bidhut Upabhokta Samiti, Syangja samudayik-bidhut-upabhokta-samiti-syangja Samudayik Gramin Bidhutikaran Upabhokta Samiti samudayik-gramin-bidhutikaran-upabhokta-samiti Samudayik Gramin Bidhut Panchkhal samudayik-gramin-bidhut-panchkhal Samudayik Gramin Bidyut Sahakari samudayik-gramin-bidyut-sahakari Shankhamul Gramin Bidhutikaran shankhamul-gramin-bidhutikaran Shishaghat Community Rural Electricity shishaghat-community-rural-electricity Shree Barpipal Chautari Gramin Vidhut shree-barpipal-chautari-gramin-vidhut Shree Behada Baba Gramin Bidhyut shree-behada-baba-gramin-bidhyut Shree Gauriganga Gramin Bidhut shree-gauriganga-gramin-bidhut Shree Jay Maa Durga Gramin Vidhut Sahakari Sanstha shree-jay-maa-durga-gramin-vidhut-sahakari-sanstha Shree Maa Badimalika Gramin Bidhut Sahakari shree-maa-badimalika-gramin-bidhut-sahakari Shree Manusmriti Gramin Vidhut shree-manusmriti-gramin-vidhut Shree Mohanyal Gramin Vidhut shree-mohanyal-gramin-vidhut Shree Naba Pasupati Gramin Bidhut shree-naba-pasupati-gramin-bidhut Shree Netra Jyoti Gramin Vidhut shree-netra-jyoti-gramin-vidhut Shree Pragatishil Gramin Vidhut shree-pragatishil-gramin-vidhut Shree Prithivi Bahuudhyasyiya Bidhut Upobhokta Samiti shree-prithivi-bahuudhyasyiya-bidhut-upobhokta-samiti Shree Shiv Shaktiman Gramin Vidhut shree-shiv-shaktiman-gramin-vidhut Shree Siddhababa Gramin Bidhut shree-siddhababa-gramin-bidhut Shree Subha Laxmi Gramin Bidhyut shree-subha-laxmi-gramin-bidhyut South Lalitpur Electricity south-lalitpur-electricity Swargadwari Community Electricity swargadwari-community-electricity Thalachowk Bidhut thalachowk-bidhut Thoksila Electricity thoksila-electricity"},{"location":"Electricity/watermark/#_1","title":"Watermark Electricity","text":"Type: Multi-Step API
"},{"location":"Electricity/watermark/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/watermark-electricity/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"customer_code\": \"590-11\",\n \"reference\": \"unique_reference\",\n \"service_slug\": \"service_slug\"\n}\n
Response:
\n{\n \"customer_code\": \"590-11\",\n \"customer_name\": \"Kedar Nath Timilsina\",\n \"address\": \"Devichaur-04\",\n \"meter_no\": \"11086508\",\n \"zone\": \"Devichaur(01)\",\n \"ward\": \"01-01\",\n \"type\": \"Domestic\",\n \"advance_amount\": 82.5,\n \"total_due_amount\": 330.0,\n \"due_bills\": [\n {\n \"description\": \"Tariff of 2078-Baisakh\",\n \"date\": \"2078-1-9\",\n \"amount\": 257.0\n },\n {\n \"description\": \"Penal of 2078-Baisakh\",\n \"date\": \"2078-1-9\",\n \"amount\": 64.25\n },\n {\n \"description\": \"Demand Fee\",\n \"date\": \"2078-1-9\",\n \"amount\": 65.0\n },\n {\n \"description\": \"Penal of 2078-Baisakh Demand Fee\",\n \"date\": \"2078-1-9\",\n \"amount\": 16.25\n },\n {\n \"description\": \"Service Charge\",\n \"date\": \"2078-1-9\",\n \"amount\": 10.0\n },\n {\n \"description\": \"Penal of 2078-Baisakh Service Charge\",\n \"date\": \"2078-1-9\",\n \"amount\": 0.0\n }\n ],\n \"session_id\": 442,\n \"status\": true\n}\n
Fields:
- customer_code: The unique code assigned to the customer.
- customer_name: The name of the customer.
- address: The address of the customer.
- meter_no: The meter number for the electricity connection.
- zone: The zone where the customer is located.
- ward: The ward within the zone.
- type: The type of service (e.g., Domestic).
- advance_amount: The amount of advance payment made.
- total_due_amount: The total amount due for payment.
- due_bills: An array of due bills, including:
- description: The description of the charge.
- date: The date of the bill.
- amount: The amount of the bill.
- session_id: The unique session ID for the transaction.
"},{"location":"Electricity/watermark/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/watermark-electricity/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"unique_reference\",\n \"session_id\": \"btained from previous API\",\n \"amount\": \"obtained from previous API 'total_due_amount'\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 330.0,\n \"credits_available\": \"xxxx\",\n \"id\": 107598\n}\n
Fields:
- state: The state of the transaction (
Success). - message: A message indicating the result of the transaction (
Successfully Completed Transaction). - extra_data: Any additional data related to the transaction.
- detail: Additional details about the payment, including:
- detail: A message indicating the success of the payment (
Success). - credits_consumed: The total credits consumed for this transaction.
- credits_available: The total credits available after this transaction.
- id: The unique ID associated with the transaction.
"},{"location":"Insurance/Reliable_life/","title":"Reliable Life Insurance","text":""},{"location":"Insurance/Reliable_life/#overview","title":"Overview","text":"The Reliable Life Insurance API facilitates a multi-step process for fetching policy details and processing payments. It enables users to retrieve information about their insurance policies and make payments for premiums.
"},{"location":"Insurance/Reliable_life/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Insurance/Reliable_life/#1-detail-fetch","title":"1. Detail Fetch","text":"Request URL: {{base_url}}/api/servicegroup/details/reliable-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"reference\": \"Unique_Identifier\",\n \"policy_no\": \"101000000008\",\n \"dob\": \"2018-09-26\"\n}\n
Response:
\n{\n \"premium_amount\": 100.0,\n \"customer_name\": \"test test1\",\n \"address\": \"Malakheti\",\n \"total_amount\": 180.0,\n \"policy_no\": \"701000000052\",\n \"product_name\": \"Endowment Cum Whole Life Plan - Amulya\",\n \"fine_amount\": 80.0,\n \"next_due_date\": \"2020-04-24\",\n \"pay_mode\": \"Yearly\",\n \"session_id\": 1013,\n \"status\": true\n}\n
"},{"location":"Insurance/Reliable_life/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/reliable-life-insurance/
Request Method: POST
Service Params:
\n{\n \"reference\": \"Unique_identifier\",\n \"token\": \"token\",\n \"session_id\": \"1013\",\n \"amount\": \"180\"\n}\n
Response:
\n{\n \"id\": 70282,\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 180.0,\n \"credits_available\": 742509.83,\n \"extra_data\": {}\n}\n
"},{"location":"Insurance/neco_insurance/","title":"Neco Insurance API","text":"Type: Multi Step API
"},{"location":"Insurance/neco_insurance/#insurance-policy-categories","title":"Insurance Policy Categories","text":"Request URL: {{base_url}}/api/servicegroup/details/neco-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"Token\",\n \"insurance_slug\": \"neco-insurance\"\n}\n
Regex:
\n[\n {\n \"name\": \"Mobile\",\n \"slug\": \"\",\n \"pattern\": \"([9][678][0-6][0-9]{7})\",\n \"error_message\": \"Invalid mobile number\"\n }\n]\n
Response:
\n{\n \"category_list\": {\n \"neco-insurance\": [\n \"Cardamon Agr\",\n \"AGR / CAD GROUP\",\n \"Agriculture\",\n \"AGR / CAT GROUP\",\n \"AGR / POU GROUP\",\n \"AGR / CRP GROUP\",\n \"AGR / FSH GROUP\",\n \"Cattle agr\",\n \"Poultry agr\",\n \"Fish agr\",\n \"Rice agr\",\n \"Vegetable agr\",\n \"Potato agr\",\n \"Fruit agr\",\n \"tmcy (motorcycle)\",\n \"tpc (private vehicle)\",\n \"tcvb (Public Bus)\",\n \"tcvo (Other)\",\n \"tcvt (Truck and Tanker)\",\n \"tcvv (Private Bus)\",\n \"tcvx (Taxi)\",\n \"Personnel Accident(Micro)\",\n \"Health Insurance(Micro)\",\n \"Crop\",\n \"Bee agr\",\n \"AGR / BEE GROUP\",\n \"Mushroom agr\"\n ]\n },\n \"status\": true\n}\n
"},{"location":"Insurance/neco_insurance/#neco-insurance-payment","title":"Neco Insurance Payment","text":"Request URL: {{base_url}}/api/servicegroup/commit/neco-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"Account_Token\",\n \"policy_type\": \"Fresh OR Renew OR\",\n \"customer_name\": \"RamLal\",\n \"policy_category\": \"Any one value from categories above\",\n \"amount\": 100.0,\n \"reference\": \"unique identifier for each request\",\n \"policy_number\": \"Optional Field | 12\",\n \"mobile_number\": \"9843664612\",\n \"service_name\": \"neco-insurance\",\n \"insurance_slug\": \"insurance_slug_from_search_step\"\n}\n
Response:
\n{\n \"credits_available\": 681649.199999999,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"status\": true,\n \"credits_consumed\": 1,\n \"id\": 442\n}\n
"},{"location":"Insurance/nepal_non_life/","title":"Nepal Life s Insurance","text":""},{"location":"Insurance/nepal_non_life/#overview","title":"Overview","text":"The Nepal Insurance API provides a multi-step process for fetching insurance details and processing payments. This API enables users to retrieve information about available policies, branches, and insurance types, and allows for the submission of payment requests for chosen insurance plans.
"},{"location":"Insurance/nepal_non_life/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Insurance/nepal_non_life/#1-detail-fetch","title":"1. Detail Fetch","text":"Request URL: {{base_url}}/api/servicegroup/info/nepal-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\"\n}\n
Response:
\n{\n \"policies\": [\n {\n \"label\": \"Endorsement\",\n \"value\": \"1\"\n },\n {}\n ],\n \"insurance_types\": [\n {\n \"label\": \"Motor/ Vehicle Insurance\",\n \"value\": \"1\"\n },\n {\n \"label\": \"Micro/ Agriculture Insurance\",\n \"value\": \"22\"\n }\n ],\n \"branches\": [\n {\n \"label\": \"Abukhaireni\",\n \"value\": \"1\"\n },\n {\n \"label\": \"Tulsipur\",\n \"value\": \"51\"\n }\n ]\n}\n
"},{"location":"Insurance/nepal_non_life/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/nepal-insurance/
Request Method: POST
Service Params:
\n{\n \"policy_type\": \"{{policy value}}\", // from detail fetch API\n \"branch\": \"{{branch value}}\", // from detail fetch API\n \"insurance_type\": \"{{insurance value}}\", // from detail fetch API\n \"amount\": \"1000\",\n \"debit_note_number\": \"11111\",\n \"customer_name\": \"customer_name\",\n \"customer_address\": \"Thimi\",\n \"mobile_number\": \"9851168561\",\n \"policy_description\": \"11111\",\n \"bill_no\": \"bill no\", // user input\n \"email\": \"babubaiyaa@gmail.com\", // user input\n \"token\": \"token\",\n \"reference\": \"Unique_identifier\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"detail\": \"Successful Payment\",\n \"message\": \"Successfully Completed Transaction\",\n \"credits_consumed\": 1000.0,\n \"credits_available\": 92900.0,\n \"extra_data\": {},\n \"id\": null\n}\n
"},{"location":"Insurance/prabhu_life/","title":"Prabhu Life Insurance","text":""},{"location":"Insurance/prabhu_life/#overview","title":"Overview","text":"The Prabhu Life Insurance API allows users to fetch policy details and process payments efficiently through a multi-step process.
"},{"location":"Insurance/prabhu_life/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Insurance/prabhu_life/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/prabhu-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"policy_no\": \"701000000052\",\n \"dob\": \"1996-12-11\",\n \"reference\": \"Unique Reference\"\n}\n
Response:
\n{\n \"premium_amount\": 100.0,\n \"customer_name\": \"test test1\",\n \"address\": \"Malakheti\",\n \"total_amount\": 180.0,\n \"policy_no\": \"701000000052\",\n \"product_name\": \"Endowment Cum Whole Life Plan - Amulya\",\n \"fine_amount\": 80.0,\n \"next_due_date\": \"2020-04-24\",\n \"pay_mode\": \"Yearly\",\n \"session_id\": 320,\n \"status\": true\n}\n
"},{"location":"Insurance/prabhu_life/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/prabhu-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"320\", // session id received from detail fetch API\n \"amount\": \"amount\",\n \"reference\": \"Unique Reference\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"assured_name\": \"test test1\",\n \"fine_amount\": 80.0,\n \"premium_amount\": 100.0,\n \"next_due_date\": \"2021-04-24\",\n \"policy_no\": \"701000000052\",\n \"total_amount\": 180.0,\n \"invoice_number\": \"RP30137\"\n },\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 180.0,\n \"credits_available\": 9999633558.47,\n \"id\": 34846\n}\n
"},{"location":"Insurance/rastriyabeema/","title":"Rastriya Beema Sansthan","text":"Type: Multi-Step API
"},{"location":"Insurance/rastriyabeema/#1-detail-fetch","title":"1. Detail Fetch","text":"Request URL: {{base_url}}/api/servicegroup/details/rastriya-beema-sasthan/
Request Method: POST
Service Params:
\n{\n \"reference\": \"unique_identifier\",\n \"token\": \"token\",\n \"policy_no\": \"49726\",\n \"dob\": \"1962-08-10\"\n}\n
Request Example:
\n{\n \"reference\": \"unique_ref_123\",\n \"token\": \"your_token_here\",\n \"policy_no\": \"49726\",\n \"dob\": \"1962-08-10\"\n}\n
Response:
\n{\n \"premium_amount\": 8392.0,\n \"customer_name\": \"NAVA NIDHI PANT\",\n \"address\": \"ILIT ENGLISH SCHOOL BUTWAL\",\n \"total_amount\": 100.0,\n \"policy_no\": \"49726\",\n \"product_name\": \"Endowment\",\n \"fine_amount\": 80,\n \"next_due_date\": \"1999-07-19\",\n \"current_due_date\": \"1999-07-19\",\n \"pay_mode\": \"Yearly\",\n \"session_id\": 1913,\n \"status\": true\n}\n
"},{"location":"Insurance/rastriyabeema/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/rastriya-beema-sasthan/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"{{session_id}}\", // From Detail Fetch API\n \"amount\": \"{{total_amount}}\" // From Detail Fetch API\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"assured_name\": \"test test1\",\n \"fine_amount\": 80.0,\n \"premium_amount\": 100.0,\n \"next_due_date\": \"2021-04-24\",\n \"policy_no\": \"701000000052\",\n \"total_amount\": 180.0,\n \"invoice_number\": \"RP30137\"\n },\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 180.0,\n \"credits_available\": 92720.0,\n \"id\": 105658\n}\n
"},{"location":"Insurance/sagarmatha_insurance/","title":"Sagarmatha Lumbini Insurance API","text":""},{"location":"Insurance/sagarmatha_insurance/#detail-fetch-api","title":"Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/sagarmatha-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"Provided Token\",\n \"debit_note_no\": \"Debit Note no of client> (TEST DEBIT NOTE NO : 001618/198500779)\",\n \"reference\": \"unique identifier\"\n}\n
Response:
\n{\n \"contact_no\": \"9861233462\",\n \"debit_note_no\": \"001618/198500778\",\n \"session_id\": 171,\n \"address\": \"Tathali - 3, Bhaktapur, Bagmati\",\n \"name\": \"Bal Sundar Raut\",\n \"status\": true,\n \"payable_amount\": \"1010\"\n}\n
"},{"location":"Insurance/sagarmatha_insurance/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/sagarmatha-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"Account_Token\",\n \"session_id\": \"session_id returned during user lookup\",\n \"amount\": \"premium amount to be paid from details step\"\n}\n
Response:
\n{\n \"bill_info\": {\n \"tax_invoice_no\": \"18740\",\n \"receipt_no\": \"24211\",\n \"document_no\": \"111618/198500702\"\n },\n \"id\": 3523,\n \"extra_data\": {},\n \"state\": \"Success\",\n \"detail\": \"Successful Payment\",\n \"message\": \"Successfully Completed Transaction\",\n \"status\": true\n}\n
"},{"location":"Insurance/suryajoytiloan/","title":"Surya Jyoti Loan Repayment","text":"Type: Multi-Step API
"},{"location":"Insurance/suryajoytiloan/#1-detail-fetch","title":"1. Detail Fetch","text":"Request URL: {{base_url}}/api/servicegroup/details/surya-jyoti-loan-repayment/
Request Method: POST
Service Params:
\n{\n \"reference\": \"unique_identifier\",\n \"token\": \"token\",\n \"policy_no\": \"49726\",\n \"dob\": \"1962-08-10\",\n \"date_format\": \"AD / BS\"\n}\n
Request Example:
\n{\n \"reference\": \"unique_ref_123\",\n \"token\": \"your_token_here\",\n \"policy_no\": \"49726\",\n \"dob\": \"1962-08-10\",\n \"date_format\": \"AD\"\n}\n
Response:
\n{\n \"policy_no\": \"7330000152\",\n \"name\": \"Melina Magar\",\n \"policy_type\": \"Loan Repayment\",\n \"total_payable_amount\": 18056.0,\n \"minimum_payable\": 10.0,\n \"int_to_pay\": 5.0,\n \"loan_amount\": 22000,\n \"interest_calculated_from\": \"20/07/2022\",\n \"interest_calculated_to\": \"22/07/2022\",\n \"total_due_interest\": 10.0,\n \"principal_amount\": 18051.0,\n \"session_id\": 17118,\n \"status\": true\n}\n
"},{"location":"Insurance/suryajoytiloan/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"{{session_id}}\", // From Detail Fetch API\n \"amount\": \"{{total_amount}}\", // From Detail Fetch API\n \"reference\": \"unique_identifier\"\n}\n
Request Example:
\n{\n \"token\": \"your_token_here\",\n \"session_id\": \"17118\",\n \"amount\": \"18056.0\",\n \"reference\": \"unique_ref_123\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"policy_no\": \"7330000152\"\n },\n \"detail\": \"Transaction Successful\",\n \"credits_consumed\": 18056.0,\n \"credits_available\": 75502.0,\n \"id\": 105663\n}\n
"},{"location":"Insurance/Arhant%20Insurance/life/","title":"Arhant Life Insurance","text":""},{"location":"Insurance/Arhant%20Insurance/life/#overview","title":"Overview","text":"The Arhant Life Insurance API allows users to fetch details about their life insurance policies and process payments. This multi-step API supports various life insurance products under Arhant, including Asian Life Insurance and Ime Life Insurance.
"},{"location":"Insurance/Arhant%20Insurance/life/#type-multi-step-api","title":"Type: Multi Step API","text":"Below is the list of Life Insurances under Arhant and their service_slug:
"},{"location":"Insurance/Arhant%20Insurance/life/#asian-life-insurance-asian-life-insurance","title":"Asian Life Insurance : asian-life-insurance","text":""},{"location":"Insurance/Arhant%20Insurance/life/#ime-life-insurance-ime-life-insurance","title":"Ime Life Insurance : ime-life-insurance","text":""},{"location":"Insurance/Arhant%20Insurance/life/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{url}}/api/servicegroup/details/arhant-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"policy_no\": \"51080000258\", // User input\n \"dob_year\": \"1984\", // User input\n \"insurance_slug\": \"service_slug\",\n \"reference\": \"unique-reference\"\n}\n
Response:
\n{\n \"request_id\": \"51080000258-1984\",\n \"amount\": 4803,\n \"properties\": {\n \"policy_no\": \"51080000258\",\n \"customer_name\": \"Chandra Kala Ghimire\",\n \"address\": \"Fidim-4\",\n \"product_name\": \"Endowment\",\n \"premium\": \"4803\",\n \"late_fee\": \"0\",\n \"waive_amount\": \"0\",\n \"previous_excess_short\": \"0.00\"\n },\n \"session_id\": 8867,\n \"status\": true\n}\n
"},{"location":"Insurance/Arhant%20Insurance/life/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/arhant-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"137\",\n \"amount\": \"amount\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 4803,\n \"credits_available\": 999999998060930.6,\n \"id\": 62849\n}\n
"},{"location":"Insurance/Arhant%20Insurance/non_life/","title":"Arhant Non-Life Insurances","text":"Overview: This document provides information on the non-life insurance services offered by Arhant, including the endpoints for retrieving proforma details and completing payments.
"},{"location":"Insurance/Arhant%20Insurance/non_life/#available-non-life-insurance-services","title":"Available Non-Life Insurance Services:","text":"Insurance Company Service Slug Notes Ajod Insurance ajod-insurance Obsolete. Merged with United Insurance. Use United Insurance API. Everest Insurance everest-insurance Obsolete. GIC Insurance gic-insurance Obsolete. Lumbini General Insurance lumbini-general-insurance Merged with Sagarmatha Insurance API. Lumbini General Insurance is obsolete. NLG Insurance nlg-insurance Premier Insurance premier-insurance Obsolete. Merged with Siddhartha Insurance. Use Siddhartha Insurance API. Sanima General Insurance sanima-general-insurance Shikhar Insurance shikhar-insurance Obsolete. Siddhartha Insurance siddhartha-insurance United Insurance united-insurance"},{"location":"Insurance/Arhant%20Insurance/non_life/#details","title":"Details","text":" - URL:
{{base_url}}/api/servicegroup/details/arhant-non-life-insurance/ - Method: POST
"},{"location":"Insurance/Arhant%20Insurance/non_life/#request-parameters","title":"Request Parameters:","text":"To get the proforma details, send a POST request with the following parameters:
\n{\n \"token\": \"token\", \n \"reference\": \"reference\", \n \"proforma_no\": \"01458110\", \n \"service_slug\": \"service_slug\" \n}\n
"},{"location":"Insurance/Arhant%20Insurance/non_life/#example-response","title":"Example Response:","text":"The response provides detailed information about the proforma, such as premium amounts, insured details, and vehicle information.
\n{\n \"success_message\": \"Proforma is valid\",\n \"request_id\": 2176242,\n \"proforma_no\": \"2176242\",\n \"class_name\": \"Motor,Third Party Motorcycle\",\n \"sum_insured\": 0,\n \"net_premium\": 1700,\n \"stamp_duty\": 10,\n \"vat_amount\": 221,\n \"subsidized_premium\": 0,\n \"total_premium\": 1931,\n \"vehicle_no\": \"NA 59 PA 2511\",\n \"insured\": \"Tanknath Pokharel,Hariwan-01, Sarlahi\",\n \"session_id\": 20327,\n \"status\": true\n}\n
"},{"location":"Insurance/Arhant%20Insurance/non_life/#payment","title":"Payment","text":" - URL:
{{base_url}}/api/servicegroup/commit/arhant-non-life-insurance/ - Method: POST
"},{"location":"Insurance/Arhant%20Insurance/non_life/#request-parameters_1","title":"Request Parameters:","text":"To finalize the payment, send a POST request with these parameters:
\n{\n \"token\": \"token\", \n \"reference\": \"reference\", \n \"session_id\": \"session_id\" \n}\n
"},{"location":"Insurance/Arhant%20Insurance/non_life/#example-response_1","title":"Example Response:","text":"The response confirms the transaction status and provides details about credits consumed and remaining.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 4803,\n \"credits_available\": \"xxxxxxxx\",\n \"id\": 62849\n}\n
"},{"location":"Insurance/Citizen/citizen/","title":"Citizen Life Insurance","text":""},{"location":"Insurance/Citizen/citizen/#overview","title":"Overview","text":"The Citizen Life Insurance API allows users to retrieve details about their insurance policies and process payments. This multi-step API provides access to policy information and facilitates secure transactions for premium payments.
"},{"location":"Insurance/Citizen/citizen/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Insurance/Citizen/citizen/#1-detail-fetch","title":"1. Detail Fetch","text":"Request URL: {{base_url}}/api/servicegroup/details/citizen-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"reference\": \"Unique_Identifier\",\n \"policy_no\": \"101000315\",\n \"dob\": \"1976-09-22\"\n}\n
Response:
\n{\n \"premium_amount\": 100.0,\n \"customer_name\": \"test test1\",\n \"address\": \"Malakheti\",\n \"total_amount\": 180.0,\n \"policy_no\": \"701000000052\",\n \"product_name\": \"Endowment Cum Whole Life Plan - Amulya\",\n \"fine_amount\": 80.0,\n \"next_due_date\": \"2020-04-24\",\n \"pay_mode\": \"Yearly\",\n \"session_id\": 994,\n \"status\": true\n}\n
"},{"location":"Insurance/Citizen/citizen/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/citizen-life-insurance/
Request Method: POST
Service Params:
\n{\n \"reference\": \"Unique_identifier\",\n \"token\": \"token\",\n \"session_id\": \"994\",\n \"amount\": \"180\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"assured_name\": \"test test1\",\n \"fine_amount\": 80.0,\n \"premium_amount\": 100.0,\n \"next_due_date\": \"2021-04-24\",\n \"policy_no\": \"701000000052\",\n \"total_amount\": 180.0,\n \"invoice_number\": \"RP30137\"\n },\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 180.0,\n \"credits_available\": 9995400876.57663,\n \"id\": 68751\n}\n
"},{"location":"Insurance/Himalayan%20Insurance/hg-general-insurance/","title":"Himalayan General Insurance","text":""},{"location":"Insurance/Himalayan%20Insurance/hg-general-insurance/#overview","title":"Overview","text":"This document outlines the APIs for fetching user details and processing payments related to Himalayan General Insurance.
"},{"location":"Insurance/Himalayan%20Insurance/hg-general-insurance/#user-detail-fetch-api","title":"User Detail Fetch API","text":" - Request URL:
{{base_url}}/api/servicegroup/details/hg-insurance/ - Request Method: POST
- Service Params: N/A
"},{"location":"Insurance/Himalayan%20Insurance/hg-general-insurance/#response-example","title":"Response Example:","text":"\n{\n \"insured_party\": \"Jeetendra Maharjan\",\n \"policy_no\": \"KTM/MCY/11/18/19/95868\",\n \"premium_amount\": 4875.56,\n \"expiry_date\": \"2019-05-24\",\n \"insured_amount\": 200000,\n \"coverage_type\": \"Comprehensive\",\n \"ids\": \"5cff2e048c36076fac6a4d0d\",\n \"session_id\": 161,\n \"status\": true\n}\n
"},{"location":"Insurance/Himalayan%20Insurance/hg-general-insurance/#payment-api","title":"Payment API","text":" - Request URL:
{{base_url}}/api/servicegroup/commit/hg-insurance/ - Request Method: POST
- Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": 161,\n \"reference\": \"reference123\",\n \"amount\": 4875.56\n}\n
"},{"location":"Insurance/Himalayan%20Insurance/hg-general-insurance/#response-example_1","title":"Response Example:","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"premium_amount\": 4875.56,\n \"policy_no\": \"KTM/MCY/11/18/19/95868\",\n \"coverage_type\": \"Comprehensive\",\n \"insured_amount\": 200000\n },\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 4875.56,\n \"credits_available\": 96786310.1950002,\n \"id\": 5878\n}\n
"},{"location":"Insurance/Nepal/nepal_Life_Insurace/","title":"Nepal Life Insurance","text":""},{"location":"Insurance/Nepal/nepal_Life_Insurace/#user-detail-fetch-api","title":"User Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/nepal-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{TOKEN}}\",\n \"reference\": \"unique reference id\",\n \"policy_no\": \"401059698\",\n \"dob\": \"2008-03-20\"\n}\n
Response:
\n{\n \"customer_name\": \"TUSARA SINGH THAKURI\",\n \"policy_no\": \"401059698\",\n \"due_date\": \"2020-12-20\",\n \"premium_amount\": 2500.0,\n \"amount\": 2500.0,\n \"fine_amount\": 0.0,\n \"rebate_amount\": 0.0,\n \"session_id\": 102,\n \"status\": true\n}\n
Error Response:
\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Policy does not exist or not active.\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"Insurance/Nepal/nepal_Life_Insurace/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/nepal-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{TOKEN}}\",\n \"reference\": \"unique reference id\",\n \"amount\": 2500,\n \"session_id\": 2121345\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"policy_no\": \"401059698\"\n },\n \"detail\": \"Success\",\n \"credits_consumed\": 2500.0,\n \"credits_available\": 105844058.084999,\n \"id\": 10959\n}\n
"},{"location":"Insurance/Reliance%20Insurance/reliance_insurance/","title":"Sanima Insurance API","text":"Note: Reliance and Sanima Life Insurance have merged. Please use the Reliance Life Insurance API.
Type: Multi Step API
"},{"location":"Insurance/Reliance%20Insurance/reliance_insurance/#overview","title":"Overview","text":"The Reliance Insurance API facilitates interactions with Reliance Insurance services, including retrieving user details and processing payments. The API involves two primary steps:
-
USER DETAIL API: Fetches policy details and user information based on the provided policy number and date of birth.
-
Payment API: Handles the payment process for the insurance policy using the information retrieved from the USER DETAIL API.
"},{"location":"Insurance/Reliance%20Insurance/reliance_insurance/#user-detail-api","title":"USER DETAIL API","text":"Request URL: {{base_url}}/api/servicegroup/details/reliance-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"provided_token\",\n \"policy_no\": \"301000003781\",\n \"dob\": \"YYYY-MM-DD\"\n}\n
Sample Response:
Success:
\n{\n \"paymode\": \"Yearly\",\n \"transaction_id\": \"100373\",\n \"product_name\": \"Endowment Assurance Cum Whole Life Policy\",\n \"customer_id\": \"301000000277\",\n \"next_due_date\": \"2019-02-20\",\n \"status\": true,\n \"invoice_number\": \"\",\n \"amount\": \"43845.00\",\n \"customer_name\": \"HARI CHANDRA YADAV\",\n \"address\": \"Auradi\",\n \"fine_amount\": \"949.0000\"\n}\n
Overview: The USER DETAIL API allows you to fetch detailed information about an insurance policy using the policy number and date of birth. It provides details such as the product name, next due date, amount payable, and customer information.
"},{"location":"Insurance/Reliance%20Insurance/reliance_insurance/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/reliance-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"\",\n \"amount\": \"\",\n \"policy_no\": \"\",\n \"transaction_id\": \"\",\n \"reference\": \"\"\n}\n\n\nSample Response:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"customer_id\": \"101000000008\",\n \"customer_name\": \"BIBEK KUMAR DEV\",\n \"next_due_date\": \"11/04/2019\",\n \"product_name\": \"Child Assurance Plan\",\n \"fine_amount\": \"0.00\",\n \"invoice_number\": \"RP001\",\n \"transaction_id\": \"100051\"\n },\n \"detail\": {\n \"customer_id\": \"101000000008\",\n \"customer_name\": \"BIBEK KUMAR DEV\",\n \"next_due_date\": \"11/04/2019\",\n \"product_name\": \"Child Assurance Plan\",\n \"fine_amount\": \"0.00\",\n \"invoice_number\": \"RP001\",\n \"transaction_id\": \"100051\"\n },\n \"credits_consumed\": 43845.0,\n \"credits_available\": 9993994136.51662,\n \"id\": 93762\n}\n
\n\nOverview: \nThe Payment API processes payments for the insurance policy. It requires details such as the policy number, transaction ID, amount to be paid, and a unique reference identifier. Upon successful payment, it returns information about the transaction, including customer details and payment status.
"},{"location":"Insurance/Sunlife/sunlife/","title":"Sun Life Insurance","text":"Type: Multi Step API
"},{"location":"Insurance/Sunlife/sunlife/#1-detail-fetch","title":"1. Detail Fetch","text":"Request URL: {{base_url}}/api/servicegroup/details/sun-life-insurance/
Request Method: POST
Service Params:
\n{\n \"reference\": \"\",\n \"token\": \"\",\n \"policy_no\": \"66160014378\",\n \"dob\": \"1968-06-01\"\n}\n\n\nResponse:
\n\n{\n \"premium_amount\": 100.0,\n \"customer_name\": \"test test1\",\n \"address\": \"Malakheti\",\n \"total_amount\": 180.0,\n \"policy_no\": \"701000000052\",\n \"product_name\": \"Endowment Cum Whole Life Plan - Amulya\",\n \"fine_amount\": 80.0,\n \"next_due_date\": \"2020-04-24\",\n \"current_due_date\": \"2020-04-24\",\n \"pay_mode\": \"Yearly\",\n \"session_id\": 1916,\n \"status\": true\n}\n
"},{"location":"Insurance/Sunlife/sunlife/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/sun-life-insurance/
\nRequest Method: POST
\nService Params:
\n\n{\n \"token\": \"\",\n \"session_id\": \"{{session_id}}\", // From Detail Fetch API\n \"amount\": \"{{total_amount}}\", // From Detail Fetch API\n \"reference\": \"\"\n}\n\n\nResponse:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"assured_name\": \"test test1\",\n \"fine_amount\": 80.0,\n \"premium_amount\": 100.0,\n \"next_due_date\": \"2021-04-24\",\n \"policy_no\": \"701000000052\",\n \"total_amount\": 180.0,\n \"invoice_number\": \"RP30137\"\n },\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 180.0,\n \"credits_available\": 75322.0,\n \"id\": 105695\n}\n
"},{"location":"Insurance/ime/ime_general/","title":"IME General Insurance","text":""},{"location":"Insurance/ime/ime_general/#overview","title":"Overview","text":"The IME General Insurance API provides a structured approach to handle insurance-related operations, including fetching details of various insurance types and processing payments for those insurance policies.
"},{"location":"Insurance/ime/ime_general/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Insurance/ime/ime_general/#1-detail-api","title":"1. Detail API","text":"Request URL: {{base_url}}/api/servicegroup/info/ime-general-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\"\n}\n
Response:
\n{\n \"policy_type\": [\n { \"label\": \"Endorsement\", \"value\": \"1\" },\n { \"label\": \"New\", \"value\": \"2\" },\n { \"label\": \"Renewal\", \"value\": \"3\" }\n ],\n \"insurance_type\": [\n { \"label\": \"Motor/Vehicle Insurance\", \"value\": \"1\" },\n { \"label\": \"Property Insurance\", \"value\": \"2\" },\n { \"label\": \"Engineering Insurance\", \"value\": \"3\" },\n { \"label\": \"Group Personal Accidental Insurance\", \"value\": \"4\" },\n { \"label\": \"Money Insurance\", \"value\": \"5\" },\n { \"label\": \"Banker's Blanket Insurance\", \"value\": \"6\" },\n { \"label\": \"Personal Accidental Insurance\", \"value\": \"7\" },\n { \"label\": \"Professional Indemnity Insurance\", \"value\": \"8\" },\n { \"label\": \"Cash In Transit Insurance\", \"value\": \"9\" },\n { \"label\": \"Public Liability Insurance\", \"value\": \"10\" },\n { \"label\": \"Medi Claim Insurance\", \"value\": \"11\" },\n { \"label\": \"Travel Insurance\", \"value\": \"12\" },\n { \"label\": \"Cash Counter Insurance\", \"value\": \"13\" },\n { \"label\": \"Gold Insurance\", \"value\": \"14\" },\n { \"label\": \"Press Accident Insurance\", \"value\": \"15\" },\n { \"label\": \"Adventure Sports Insurance\", \"value\": \"16\" },\n { \"label\": \"Tracking Insurance\", \"value\": \"17\" },\n { \"label\": \"Cyber Insurance\", \"value\": \"18\" },\n { \"label\": \"Critical Illness Insurance\", \"value\": \"19\" },\n { \"label\": \"Marine Insurance\", \"value\": \"20\" },\n { \"label\": \"Micro/Agriculture Insurance\", \"value\": \"21\" }\n ],\n \"branches\": [\n { \"label\": \"Head Office\", \"value\": \"1\" },\n { \"label\": \"Pokhara\", \"value\": \"2\" },\n { \"label\": \"Butwal\", \"value\": \"3\" },\n { \"label\": \"Narayangadh\", \"value\": \"4\" },\n { \"label\": \"Nepalgunj\", \"value\": \"5\" },\n { \"label\": \"Birgunj\", \"value\": \"6\" },\n { \"label\": \"Dhangadhi\", \"value\": \"7\" },\n { \"label\": \"Banepa\", \"value\": \"8\" },\n { \"label\": \"Biratnagar\", \"value\": \"9\" },\n { \"label\": \"Janakpur\", \"value\": \"10\" },\n { \"label\": \"Hetauda\", \"value\": \"11\" },\n { \"label\": \"Okhaldhunga\", \"value\": \"12\" },\n { \"label\": \"Bardibas\", \"value\": \"13\" },\n { \"label\": \"Solukhumbu\", \"value\": \"14\" },\n { \"label\": \"Gongabu\", \"value\": \"15\" },\n { \"label\": \"Kalanki\", \"value\": \"16\" },\n { \"label\": \"Koteshwor\", \"value\": \"17\" },\n { \"label\": \"Bhaktapur\", \"value\": \"18\" },\n { \"label\": \"Bhairahawa\", \"value\": \"19\" },\n { \"label\": \"Dolakha\", \"value\": \"20\" },\n { \"label\": \"Dang\", \"value\": \"21\" },\n { \"label\": \"Jawalakhel\", \"value\": \"22\" },\n { \"label\": \"Aabukhaireni\", \"value\": \"23\" },\n { \"label\": \"Birtamod\", \"value\": \"24\" },\n { \"label\": \"Baglung\", \"value\": \"25\" },\n { \"label\": \"Kawasoti\", \"value\": \"26\" },\n { \"label\": \"New Road\", \"value\": \"27\" },\n { \"label\": \"Surkhet\", \"value\": \"28\" },\n { \"label\": \"Dhading\", \"value\": \"29\" },\n { \"label\": \"Manthali\", \"value\": \"30\" },\n { \"label\": \"Boudha\", \"value\": \"31\" },\n { \"label\": \"Itahari\", \"value\": \"32\" },\n { \"label\": \"Damak\", \"value\": \"33\" },\n { \"label\": \"Teku\", \"value\": \"34\" },\n { \"label\": \"Tulsipur\", \"value\": \"35\" },\n { \"label\": \"Nuwakot\", \"value\": \"36\" },\n { \"label\": \"Syangja\", \"value\": \"37\" },\n { \"label\": \"Tandi\", \"value\": \"38\" },\n { \"label\": \"Dadeldhura\", \"value\": \"39\" },\n { \"label\": \"Lahan\", \"value\": \"40\" },\n { \"label\": \"Kirtipur\", \"value\": \"41\" },\n { \"label\": \"Simara\", \"value\": \"42\" },\n { \"label\": \"Mahendranagar\", \"value\": \"43\" },\n { \"label\": \"Damauli\", \"value\": \"44\" },\n { \"label\": \"Ilam\", \"value\": \"45\" }\n ]\n}\n
"},{"location":"Insurance/ime/ime_general/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/use/ime-general-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"policy_type\": \"Endorsement\",\n \"insurance_type\": \"Property Insurance\",\n \"branch\": \"Pokhara\",\n \"full_name\": \"test test\",\n \"address\": \"address\",\n \"mobile_number\": \"9841111111\",\n \"policy_description\": \"Description\",\n \"debit_note_no\": \"123465789\",\n \"bill_no\": \"12346589\",\n \"email\": \"user_email_id\",\n \"amount\": \"10\",\n \"reference\": \"Unique Reference\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 10.0,\n \"credits_available\": 9999633548.47,\n \"extra_data\": {\n \"policy_type\": \"Endorsement\",\n \"insurance_type\": \"Property Insurance\",\n \"branch\": \"Pokhara\",\n \"full_name\": \"test test\",\n \"address\": \"test test\",\n \"mobile_number\": \"9841111111\",\n \"policy_description\": \"test test\",\n \"debit_note_no\": \"123465789\",\n \"bill_no\": \"12346589\",\n \"email\": \"ressrew\"\n },\n \"id\": 34849\n}\n
"},{"location":"Insurance/prudential/prudential/","title":"Prudential Insurance","text":"Type: Multi Step API
"},{"location":"Insurance/prudential/prudential/#1-get-branches-api","title":"1. Get Branches API","text":" - Request URL:
{{base_url}}/api/servicegroup/getpackages/prudential-insurance/ - Request Method: POST
"},{"location":"Insurance/prudential/prudential/#service-params","title":"Service Params:","text":"\n{\n \"token\": \"token\"\n}\n
"},{"location":"Insurance/prudential/prudential/#response","title":"Response:","text":"\n{\n \"status\": true,\n \"detail\": {\n \"branches\": [\n {\n \"branch_name\": \"Kathmandu\",\n \"id\": 1\n },\n {\n \"branch_name\": \"Birgunj\",\n \"id\": 2\n }\n ]\n }\n}\n
"},{"location":"Insurance/prudential/prudential/#2-payment-api","title":"2. Payment API","text":" - Request URL:
{{base_url}}/api/use/prudential-insurance/ - Request Method: POST
"},{"location":"Insurance/prudential/prudential/#service-params_1","title":"Service Params:","text":"\n{\n \"token\": \"\",\n \"issue_branch\": \"Kathmandu\", // branches fetched from get branch API\n \"customer_name\": \"Babu rao\",\n \"mobile_number\": \"9818822421\",\n \"email\": \"baburao@gmail.com\",\n \"debit_note_or_bill_number\": \"123456\",\n \"amount\": \"amount\",\n \"reference\": \"unique-reference\"\n}"},{"location":"Insurance/prudential/prudential/#response_1","title":"Response:","text":"\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 1200.0,\n \"credits_available\": 9999611980.48,\n \"extra_data\": {\n \"issue_branch\": \"Kathmandu\",\n \"customer_name\": \"Babu rao\",\n \"mobile_number\": \"9818822421\",\n \"email\": \"baburao@gmail.com\",\n \"debit_note_or_bill_number\": \"123456\"\n },\n \"id\": 35444\n}\n
"},{"location":"Insurance/surya/Suryalife/","title":"11.5 Surya Jyoti Life Insurance API","text":"Note: Jyoti and Surya Life Insurance have merged. Please use the Surya Life Insurance API.
"},{"location":"Insurance/surya/Suryalife/#overview","title":"Overview","text":"The Surya Jyoti Life Insurance API provides functionalities for retrieving policy details and processing payments for Surya Life Insurance policies. The API involves two main operations:
-
Detail Fetch API: Retrieves detailed information about an insurance policy using the policy number and date of birth.
-
Payment API: Processes payments for the insurance policy using the information retrieved from the Detail Fetch API.
"},{"location":"Insurance/surya/Suryalife/#surya-jyoti-life-detail-fetch-api","title":"Surya Jyoti Life Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/surya-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"\",\n \"policy_no\": \"7000000019\",\n \"dob\": \"1988-02-21\",\n \"reference\": \"\"\n}\n\n\nSuccess Response:
\n\n{\n \"policy_no\": \"207001096\",\n \"plan_code\": \"71\",\n \"pay_mode\": \"YRLY\",\n \"name\": \"Ram Thakur\",\n \"premium_amount\": 10211,\n \"fine_amount\": 85,\n \"adjustment_amount\": 0,\n \"amount\": \"10296\",\n \"payment_date\": \"06/07/2023\",\n \"due_date\": \"20/05/2023\",\n \"next_due_date\": \"20/05/2024\",\n \"policy_status\": \"ACTIVE\",\n \"term\": \"15\",\n \"maturity_date\": \"20/05/2025\",\n \"session_id\": 9470,\n \"status\": true\n}\n
\n\nError Response:
\n\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Invalid Date of Birth/Policy Number\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
\n\nOverview: \nThe Detail Fetch API retrieves comprehensive details about a specific insurance policy based on the policy number and date of birth. It provides information such as the policy number, premium amount, fine amount, due dates, and policy status.
"},{"location":"Insurance/surya/Suryalife/#surya-jyoti-life-payment-api","title":"Surya Jyoti Life Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/surya-life-insurance/
\nRequest Method: POST
\nService Params:
\n\n{\n \"token\": \"\",\n \"session_id\": \"\",\n \"reference\": \"reference123\",\n \"amount\": 1305\n}\n\n\nSuccess Response:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"customer_name\": \"Parbati Kunwar Karki\",\n \"fine_amount\": 0.0,\n \"adjustment_amount\": 0.0,\n \"premium_amount\": 8430.0,\n \"payment_date\": \"02/06/2020\",\n \"next_due_date\": \"20/05/2021\",\n \"policy_no\": \"111001524\",\n \"total_amount\": 8430.0\n },\n \"detail\": \"Transaction Successful\",\n \"credits_consumed\": 8430.0,\n \"credits_available\": 477719.77,\n \"id\": 85407\n}\n
\n\nError Response:
\n\n{\n \"status\": false,\n \"error_code\": \"1011\",\n \"message\": \"Validation error\",\n \"error\": \"validation_error\",\n \"details\": {\n \"amount\": \"Invalid Amount\"\n },\n \"error_data\": {\n \"amount\": \"Invalid Amount\"\n },\n \"state\": \"Error\"\n}\n
\n\nOverview: \nThe Payment API processes payments for a Surya Life Insurance policy. It requires details such as the session ID (from the Detail Fetch API), payment amount, and a unique reference identifier. On successful completion, it returns transaction details including customer name, payment date, and total amount. If there are issues, such as invalid payment amounts, the API will return an error response with relevant details.
"},{"location":"Insurance/surya/surya_life_insurance/","title":"Surya Life Insurance First Payment","text":""},{"location":"Insurance/surya/surya_life_insurance/#overview","title":"Overview","text":"The Surya Life Insurance API facilitates the first payment process for policyholders. It includes a detail retrieval step that provides essential information about the policy, followed by a payment submission step.
"},{"location":"Insurance/surya/surya_life_insurance/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Insurance/surya/surya_life_insurance/#1-detail-api","title":"1. Detail API","text":"Request URL: {{base_url}}/api/servicegroup/first_payment/surya-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"policy_no\": \"132468\",\n \"reference\": \"Unique_Reference\",\n \"service_slug\": \"surya-life-first-payment\"\n}\n
Response:
\n{\n \"customer_name\": \"Suresh Raj Joshi\",\n \"address\": \"Sabhapokhari\",\n \"plan_name\": \"Surya Surachhit (Limited Payment)\",\n \"policy_no\": \"77777780079\",\n \"sum_assured\": 100000,\n \"premium_amount\": 40,\n \"payment_date\": \"31/05/2021\",\n \"term_year\": \"1\",\n \"pay_mode\": \"SNGL\",\n \"amount\": \"40\",\n \"session_id\": 286,\n \"status\": true\n}\n
"},{"location":"Insurance/surya/surya_life_insurance/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/surya-life-insurance/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"286\", // Obtained from detail API\n \"reference\": \"Unique Identifier\",\n \"service_slug\": \"surya-life-first-payment\",\n \"amount\": \"40\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"customer_name\": \"Suresh Raj Joshi\",\n \"fine_amount\": 0.0,\n \"adjustment_amount\": 0.0,\n \"premium_amount\": 40.0,\n \"payment_date\": \"31/05/2021\",\n \"next_due_date\": \"\",\n \"policy_no\": \"77777780079\",\n \"total_amount\": 40.0\n },\n \"detail\": \"Transaction Successful\",\n \"credits_consumed\": 40.0,\n \"credits_available\": 9999625028.47,\n \"id\": 34864\n}\n
"},{"location":"Internet/3g-vision/","title":"3G Vision","text":"This document outlines the API for 3G Vision, which includes two main functionalities: retrieving available packages and processing payments. It details the request URLs, methods, parameters, and example responses for both the package retrieval and payment APIs.
"},{"location":"Internet/3g-vision/#get-packages-api","title":"Get Packages API","text":"Request URL: {{base_url}}/api/servicegroup/getpackages/three-g-vision/
Request Method: POST
"},{"location":"Internet/3g-vision/#service-params","title":"Service Params:","text":"\n{ \n \"token\": \"token\", \n \"reference\": \"unique reference\" \n}\n
"},{"location":"Internet/3g-vision/#response","title":"Response:","text":"\n{ \n \"status\": true, \n \"detail\": { \n \"packages\": [ \n { \n \"label\": \"5 Mbps unlimited - Internet\", \n \"value\": \"5 Mbps unlimited - Internet\" \n }, \n { \n \"label\": \"10 Mbps unlimited - Internet\", \n \"value\": \"10 Mbps unlimited - Internet\" \n }, \n { \n \"label\": \"15 Mbps unlimited - Internet\", \n \"value\": \"15 Mbps unlimited - Internet\" \n }, \n { \n \"label\": \"30 Mbps unlimited - Internet\", \n \"value\": \"30 Mbps unlimited - Internet\" \n }, \n { \n \"label\": \"75 Mbps unlimited - Internet\", \n \"value\": \"75 Mbps unlimited - Internet\" \n }, \n { \n \"label\": \"Basic Package - Tv\", \n \"value\": \"Basic Package - Tv\" \n }, \n { \n \"label\": \"Basic Plus Package - Tv\", \n \"value\": \"Basic Plus Package - Tv\" \n }, \n { \n \"label\": \"Premium Package - Tv\", \n \"value\": \"Premium Package - Tv\" \n } \n ] \n } \n}\n
"},{"location":"Internet/3g-vision/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/use/three-g-vision/
Request Method: POST
"},{"location":"Internet/3g-vision/#service-params_1","title":"Service Params:","text":"\n{ \n \"token\": \"{{live}}\", \n \"reference\": \"{{$guid}}\", \n \"name\": \"udeep\", \n \"contact_number\": \"9849324652\", \n \"user_id\": \"aoubeceoa\", \n \"amount\": 100, \n \"package\": \"5 Mbps unlimited - Internet\", \n \"remarks\": \"This is an optional field\" \n}\n
"},{"location":"Internet/3g-vision/#response_1","title":"Response:","text":"\n{ \n \"status\": true, \n \"state\": \"Queued\", \n \"detail\": \"Transaction Queued\", \n \"message\": \"Your operation is in queue.\", \n \"credits_consumed\": 100.0, \n \"credits_available\": \"**********\", \n \"extra_data\": { \n \"name\": \"udeep\", \n \"contact_number\": \"9849324652\", \n \"user_id\": \"aoubeceoa\", \n \"package\": \"5 Mbps unlimited - Internet\", \n \"remarks\": \"This is an optional field\" \n }, \n \"id\": 20274 \n}\n
"},{"location":"Internet/Fibertel/","title":"Fibertel Fibernet","text":"This document outlines the API for initiating a transaction with Fibertel Fibernet, including the required parameters and expected response format.
Type: Single Step API
"},{"location":"Internet/Fibertel/#request-details","title":"Request Details","text":" - Request URL:
{{base_url}}/api/use/fibertel-fibernet/ - Request Method: POST
"},{"location":"Internet/Fibertel/#service-params","title":"Service Params","text":"\n{\n \"token\": \"{{live}}\",\n \"username\": \"abin\",\n \"contact_number\": \"9843666888\",\n \"package\": \"Residential Plan 1 Month 30 Mbps\", // User Input\n \"amount\": 15501, // User Input\n \"reference\": \"sky12\",\n \"remarks\": \"TEST\"\n}\n
"},{"location":"Internet/Fibertel/#response","title":"Response","text":"\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 15501.0,\n \"credits_available\": 101197089.864999,\n \"extra_data\": {\n \"username\": \"abin\",\n \"contact_number\": \"9843666888\",\n \"package\": \"Residential Plan 1 Month 30 Mbps\",\n \"remarks\": \"TEST\",\n \"name\": \"ABin\"\n },\n \"id\": 20211\n}\n
"},{"location":"Internet/Virtual-network/","title":"Virtual Network API","text":"The Virtual Network API allows users to make payments for virtual network services.
"},{"location":"Internet/Virtual-network/#type-single-step-api","title":"Type: Single Step API","text":""},{"location":"Internet/Virtual-network/#endpoint","title":"Endpoint","text":" - URL:
{{base_url}}/api/use/virtual-network/ - Method:
POST
"},{"location":"Internet/Virtual-network/#service-parameters","title":"Service Parameters","text":"The request must include the following parameters:
\n{\n \"token\": \"token\",\n \"username\": \"Username, eg: khaltiUser\",\n \"mobile_number\": \"9818766122\",\n \"amount\": 100, // Minimum Amount 100\n \"reference\": \"virtualnetwork1\"\n}\n
"},{"location":"Internet/Virtual-network/#regex-validation","title":"Regex Validation","text":"For the username parameter, the following regex validation applies:
\n[\n {\n \"name\": \"Username\",\n \"slug\": \"\",\n \"pattern\": \"([a-zA-Z0-9_]+)\",\n \"error_message\": \"Invalid Username\"\n }\n]\n
"},{"location":"Internet/Virtual-network/#response","title":"Response","text":"Upon successful operation, the API will return a response in the following format:
\n{\n \"status\": true,\n \"id\": 1266,\n \"credits_available\": 9200.0,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"credits_consumed\": 100.0\n}\n
"},{"location":"Internet/adsl/","title":"ADSL","text":""},{"location":"Internet/adsl/#overview","title":"Overview","text":"The ADSL API allows you to perform operations related to both Unlimited and Volume Based ADSL services. Depending on your choice, you can submit requests for ADSL services using the provided API endpoints. This API requires parameters such as a token, a unique reference, the amount, and the landline number to process the request.
"},{"location":"Internet/adsl/#type-single-step-api","title":"Type: Single Step API","text":""},{"location":"Internet/adsl/#url","title":"URL:","text":" - Unlimited:
{{base_url}}/api/use/adsl-ul/ - Volume Based:
{{base_url}}/api/use/adsl-vb/
"},{"location":"Internet/adsl/#service-params","title":"Service Params:","text":" - number: 8-digit number (area code without 0 and landline number), e.g., 15522942
- token: Your authentication token
- reference: A unique reference for the transaction
- amount: The amount to be processed
- number: The landline number in the required format
"},{"location":"Internet/adsl/#valid-amounts-for-both-unlimited-volume-based","title":"Valid Amounts for Both Unlimited & Volume Based:","text":" - 9 < Amount < 10001
"},{"location":"Internet/adsl/#regex","title":"Regex:","text":"\n[ \n { \n \"name\": \"LandLine\", \n \"slug\": \"\", \n \"pattern\": \"([0-9]{8})\", \n \"error_message\": \"Invalid LandLine number\" \n } \n]\n
"},{"location":"Internet/adsl/#request","title":"Request:","text":"\n{ \n \"token\": \"token-provided\", \n \"reference\": \"unique-reference\", \n \"amount\": \"amount\", \n \"number\": \"number\" \n}\n
"},{"location":"Internet/adsl/#response","title":"Response:","text":""},{"location":"Internet/adsl/#success-response","title":"Success Response:","text":"\n{ \n \"id\": 165, \n \"credits_consumed\": 10.0, \n \"status\": true, \n \"state\": \"Queued\", \n \"message\": \"Your operation has been submitted for processing.\", \n \"credits_available\": 1170 \n}\n
"},{"location":"Internet/adsl/#unsuccessful-response","title":"Unsuccessful Response:","text":"\n{ \n \"error_code\": \"1010\", \n \"message\": \"Validation error\", \n \"status\": false, \n \"error_data\": , \n \"details\": \"**\" \n}"},{"location":"Internet/adsl/#note","title":"Note:","text":"Check the status key in the response to verify the response. If status is false, there is an issue with the request, and you should correct it. If status is true, the request is successfully submitted but is subject to third-party provider processing. If the state is Queued, the request is being sent to the third-party provider, and you will receive an update on the final status (success or failure) via our DLR callback.
"},{"location":"Internet/adsl/#dlr-sample","title":"DLR Sample:","text":"\n{ \n \"reference\": \"Unique id sent by you\", \n \"amount\": \"amount\", \n \"status\": \"status\", \n \"detail\": \"detail regarding the service\" \n}\n
"},{"location":"Internet/airlink/","title":"Airlink Communication","text":"This document provides details for the Airlink Communication Single Step API, which is used for processing payments related to their services. It includes the request URL, method, parameters, and example responses.
Airlink is an ISP.
"},{"location":"Internet/airlink/#type-single-step-api","title":"Type: Single Step API","text":""},{"location":"Internet/airlink/#payment-api","title":"Payment API:","text":"Request URL: {{base_url}}/api/use/airlink-communication/
Request Method: POST
"},{"location":"Internet/airlink/#service-params","title":"Service Params:","text":"\n{\n \"token\": \"token\",\n \"mobile_number\": \"user-mobile-number\",\n \"username\": \"sashant\",\n \"address\": \"bhaktapur\",\n \"amount\": 10,\n \"reference\": \"unique reference\"\n}\n
"},{"location":"Internet/airlink/#response","title":"Response:","text":"\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 10.0,\n \"credits_available\": 9999767335.42,\n \"extra_data\": {\n \"mobile_number\": \"9843007232\",\n \"username\": \"sashant\",\n \"address\": \"bhaktapur\"\n },\n \"id\": 32438\n}\n
"},{"location":"Internet/arrownet/","title":"Arrownet","text":""},{"location":"Internet/arrownet/#87-arrownet","title":"8.7 Arrownet","text":""},{"location":"Internet/arrownet/#multi-step-api","title":"Multi-Step API","text":""},{"location":"Internet/arrownet/#1-user-details","title":"1. User Details","text":"URL: {{base_url}}/api/servicegroup/details/arrownet/
Service Params:
\n{\n \"token\": \"token-provided\",\n \"username\": \"username\"\n}\n
Request Example:
\n{\n \"token\": \"your_token_here\",\n \"username\": \"Pradhanang\"\n}\n
Response:
- Success:
\n{\n \"status\": true,\n \"plan_details\": [\n {\n \"duration\": 1,\n \"amount\": \"1695.00\"\n },\n {\n \"duration\": 3,\n \"amount\": \"5085.00\"\n },\n {\n \"duration\": 6,\n \"amount\": \"9492.00\"\n },\n {\n \"duration\": 12,\n \"amount\": \"17628.00\"\n }\n ],\n \"days_remaining\": 464,\n \"current_plan\": \"50Mbps\",\n \"accept_advance_payment\": true,\n \"has_due\": false,\n \"full_name\": \"Ashish Pradhanang - Home\"\n}\n
- Error:
Note: For all client errors, error_code is 4000.
\n{\n \"status\": false,\n \"message\": \"Can't fulfill request\",\n \"state\": \"Error\",\n \"error\": \"client_error\",\n \"details\": \"Username not found\",\n \"error_data\": {},\n \"error_code\": \"4000\"\n}\n
"},{"location":"Internet/arrownet/#2-arrownet-payment","title":"2. Arrownet Payment","text":"URL: {{base_url}}/api/servicegroup/commit/arrownet/
Service Params:
\n{\n \"username\": \"username\",\n \"amount\": \"amount\",\n \"duration\": \"1,3,6,12\", // According to Requirement\n \"reference\": \"unique value\",\n \"token\": \"token provided by khalti\"\n}\n
Request Example:
\n{\n \"username\": \"Pradhanang\",\n \"amount\": \"1695.00\",\n \"duration\": 1,\n \"reference\": \"unique_ref_123\",\n \"token\": \"your_token_here\"\n}\n
Response:
- Success:
\n{\n \"status\": true,\n \"message\": \"Successfully Completed Transaction\",\n \"detail\": \"Transaction successful\",\n \"extra_data\": {},\n \"state\": \"Success\",\n \"id\": 1440\n}\n
- Error:
\n{\n \"error_code\": \"1010\",\n \"message\": \"Validation error\",\n \"status\": false,\n \"error_data\": {\n // present for validation error (codes 1010, 1011) specifying errors corresponding to fields\n },\n \"details\": \"error details (string) for other errors\"\n}\n
"},{"location":"Internet/broadlink/","title":"Broadlink","text":"Introduction:
This documentation provides the APIs to fetch details and make payments for Broadlink internet users.
"},{"location":"Internet/broadlink/#broadlink-payment-types","title":"Broadlink Payment Types:","text":""},{"location":"Internet/broadlink/#outstanding-payment","title":"Outstanding Payment","text":"Users who inform Broadlink to activate their internet and generate an invoice for the payable amount. In this case, you will not find the \u201cpackages\u201d key in the response. Use the \u201camount\u201d key for payment and skip the getDiscount API before proceeding to the commit API.
- Example Customer ID: 53905
"},{"location":"Internet/broadlink/#package-payment","title":"Package Payment","text":"Users can choose a package. The \u201camount\u201d key in the detail API will be 0 in this case. Use the \u201cpackages\u201d key for package details and proceed to the checkDiscount API to get the final discounted amount.
- Example Customer ID: 47531
"},{"location":"Internet/broadlink/#1-broadlink-detail-fetch-api","title":"1. Broadlink Detail Fetch API","text":" - Request URL:
{{base_url}}/api/servicegroup/details/broadlink/ - Request Method: POST
"},{"location":"Internet/broadlink/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"customer_id\": 53905,\n \"reference\": \"Broadlink\"\n}\n
"},{"location":"Internet/broadlink/#response-for-outstanding-payment","title":"Response for Outstanding Payment","text":"\n{\n \"name\": \"sujansir home\",\n \"email\": \"sujan@broadlink.com\",\n \"mobile_no\": \"9801011844\",\n \"customer_id\": \"53905\",\n \"amount\": \"1129\",\n \"invoice_no\": \"343327\",\n \"session_id\": 5,\n \"status\": true\n}\n
"},{"location":"Internet/broadlink/#response-for-package-payment","title":"Response for Package Payment","text":"\n{\n \"name\": \"sujansir home\",\n \"mobile_no\": \"9801011844\",\n \"customer_id\": \"53905\",\n \"email\": \"sujan@broadlink.com\",\n \"amount\": 0,\n \"invoice_no\": 0,\n \"packages\": [\n {\n \"package\": \"Supernet 10 mbps@999 MID BasePlan\",\n \"package_id\": \"4\",\n \"package_sub_id\": \"4\",\n \"amount\": \"1129\"\n },\n {\n \"package\": \"Supernet 20 mbps@1499 KTM BasePlan\",\n \"package_id\": \"16\",\n \"package_sub_id\": \"16\",\n \"amount\": \"1694\"\n },\n {\n \"package\": \"Supernet 20 mbps@1499 KTM BasePlan\",\n \"package_id\": \"16\",\n \"package_sub_id\": \"258\",\n \"amount\": \"17684\"\n },\n {\n \"package\": \"Supernet 20 mbps@1499 KTM BasePlan\",\n \"package_id\": \"16\",\n \"package_sub_id\": \"259\",\n \"amount\": \"9553\"\n },\n {\n \"package\": \"Doen OLD 5mbps@599 EAST BasePlan\",\n \"package_id\": \"35\",\n \"package_sub_id\": \"35\",\n \"amount\": \"677\"\n },\n {\n \"package\": \"30 mbps Dhamaka - OV\",\n \"package_id\": \"158\",\n \"package_sub_id\": \"350\",\n \"amount\": \"13560\"\n },\n {\n \"package\": \"test icon\",\n \"package_id\": \"224\",\n \"package_sub_id\": \"528\",\n \"amount\": \"0\"\n }\n ],\n \"session_id\": 6,\n \"status\": true\n}\n
"},{"location":"Internet/broadlink/#2-broadlink-get-discount-api","title":"2. Broadlink Get Discount API","text":" - Request URL:
{{base_url}}/api/servicegroup/get_discounted_amount/broadlink/ - Request Method: POST
"},{"location":"Internet/broadlink/#service-params_1","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"session_id\": 5,\n \"package_id\": 4,\n \"package_sub_id\": 4\n}\n
"},{"location":"Internet/broadlink/#response","title":"Response","text":"\n{\n \"status\": true,\n \"detail\": {\n \"amount\": \"1129.00\",\n \"package\": \"Supernet 10 mbps@999 MID BasePlan\"\n }\n}\n
"},{"location":"Internet/broadlink/#3-broadlink-commit-api","title":"3. Broadlink Commit API","text":" - Request URL:
{{base_url}}/api/servicegroup/commit/broadlink/ - Request Method: POST
"},{"location":"Internet/broadlink/#service-params_2","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"session_id\": 5,\n \"amount\": 1129\n}\n
"},{"location":"Internet/broadlink/#response_1","title":"Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 1129.0,\n \"credits_available\": 95727.0,\n \"id\": 5373\n}\n
"},{"location":"Internet/chitrawan/","title":"Chitrawan Unique Net","text":"This document outlines the API for Chitrawan Unique Net services, including details about the service, the methods to request information, and the payment process. It includes the request URLs, methods, parameters, and example success responses for both service details and payment.
"},{"location":"Internet/chitrawan/#service-details-api","title":"Service Details API","text":"Request URL: {{base_url}}/api/servicegroup/details/chitrawan-unique-net/
Request Method: POST
"},{"location":"Internet/chitrawan/#request-params","title":"Request Params:","text":"\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"request_id\": \"khalti_test\"\n}\n
"},{"location":"Internet/chitrawan/#success-response","title":"Success Response:","text":"\n{\n \"amount\": 0,\n \"customer_name\": \"Khalti Test\",\n \"phone\": \"9800000000\",\n \"address\": \"Basnetgaun, Lalitpur-04, Lalitpur\",\n \"packages\": [\n {\n \"amount\": 1500,\n \"package_id\": 202,\n \"name\": \"100 mbps 1 month\"\n }\n ],\n \"session_id\": 26015,\n \"status\": true\n}\n
"},{"location":"Internet/chitrawan/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/chitrawan-unique-net/
Request Method: POST
"},{"location":"Internet/chitrawan/#request-params_1","title":"Request Params:","text":"\n{\n \"reference\": \"{{$guid}}\",\n \"token\": \"{{token}}\",\n \"session_id\": {{session_id}},\n \"package_id\": {{package_id}},\n \"amount\": {{package_amount}}\n}\n
"},{"location":"Internet/chitrawan/#success-response_1","title":"Success Response:","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"SUCCESS\",\n \"credits_consumed\": 1500,\n \"credits_available\": 999999997280694,\n \"id\": 126362\n}\n
"},{"location":"Internet/classictech/","title":"Classic Tech","text":""},{"location":"Internet/classictech/#overview","title":"Overview","text":"The Classic Tech API provides two main endpoints to manage user details and process payments:
- User Detail API: Retrieves details about a user's available plans and session information.
- Payment API: Commits a payment using the details obtained from the User Detail API.
"},{"location":"Internet/classictech/#user-detail-api","title":"User Detail API","text":"URL: {{base_url}}/api/servicegroup/details/classictech-isp/
METHOD: POST
Service Params:
\n{\n \"token\": \"provided_token\",\n \"reference\": \"unique reference id\",\n \"username\": \"classitech_username, e.g., ctdeveloper\"\n}\n
Response:
"},{"location":"Internet/classictech/#success","title":"Success","text":"\n{\n \"status\": true,\n \"token\": \"d95f1f947faf32d131c01a6e77d75938\",\n \"session_id\": 8,\n \"available_plans\": [\n {\n \"package\": \"Classic-30Mbps\",\n \"duration\": \"1\",\n \"amount\": 1695\n },\n {\n \"package\": \"Classic-30Mbps\",\n \"duration\": \"3\",\n \"amount\": 4403.61\n },\n {\n \"package\": \"Classic-30Mbps\",\n \"duration\": \"15\",\n \"amount\": 12430\n }\n ]\n}\n
"},{"location":"Internet/classictech/#payment-api","title":"Payment API","text":"URL: {{base_url}}/api/servicegroup/commit/classictech-isp/
METHOD: POST
Service Params:
\n{\n \"token\": \"\",\n \"session_id\": \"\",\n \"plan_id\": \"\"\n}\n\n\nSample Response:
"},{"location":"Internet/classictech/#success-response","title":"Success Response","text":"\n{\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"status\": true,\n \"id\": 2420\n}\n
"},{"location":"Internet/dishhome/","title":"Dish Home API","text":"Dishhome is a TV/ISP payment service that allows users to pay for various services, including regular recharges, Dishhome FTTH (ISP), Dishhome combos, and special offers. This API consists of two main endpoints for fetching service details and processing payments.
"},{"location":"Internet/dishhome/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Internet/dishhome/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"This endpoint retrieves detailed information about the user's Dish Home package.
"},{"location":"Internet/dishhome/#request","title":"Request","text":" - Request URL:
{{base_url}}/api/servicegroup/details/dishhome-updated/ - Request Method:
POST - Service Params:
\n{\n \"token\": \"token\",\n \"customer_id\": \"customer_id\",\n \"reference\": \"unique reference\"\n}\n
"},{"location":"Internet/dishhome/#response","title":"Response","text":"The response includes various details about the customer's package, including available recharge options.
\n{\n \"response_code\": 200,\n \"package\": \"Basic Package\",\n \"quantity\": 1,\n \"expiry_date\": \"2037-11-28T11:15:00\",\n \"zone\": \"Mid-West | Bheri Zone\",\n \"district\": \"Surkhet\",\n \"customer_type\": \"House\",\n \"customer_status\": \"Prepaid On\",\n \"customer_id\": 1111,\n \"customer_class\": \"1-Residential\",\n \"isp_customer_id\": \"\",\n \"yearly_price\": 4800.0,\n \"packages\": [\n {\n \"description\": \"1 Month\",\n \"price\": 400.0,\n \"duration_type\": 1,\n \"bonus\": 0.0,\n \"is_regular\": false,\n \"idx\": 1\n },\n {\n \"description\": \"3 Months\",\n \"price\": 1200.0,\n \"duration_type\": 3,\n \"bonus\": 400.0,\n \"is_regular\": false,\n \"idx\": 2\n },\n {\n \"description\": \"6 Months\",\n \"price\": 2399.0,\n \"duration_type\": 6,\n \"bonus\": 1201.0,\n \"is_regular\": false,\n \"idx\": 3\n },\n {\n \"description\": \"12 Months\",\n \"price\": 4800.0,\n \"duration_type\": 12,\n \"bonus\": 4800.0,\n \"is_regular\": false,\n \"idx\": 4\n },\n {\n \"description\": \"Regular\",\n \"price\": 2000.0,\n \"duration_type\": 0,\n \"bonus\": 400.0,\n \"is_regular\": true,\n \"idx\": 5\n },\n {\n \"description\": \"Regular\",\n \"price\": 1000.0,\n \"duration_type\": 0,\n \"bonus\": 100.0,\n \"is_regular\": true,\n \"idx\": 6\n },\n {\n \"description\": \"Regular\",\n \"price\": 700.0,\n \"duration_type\": 0,\n \"bonus\": 35.0,\n \"is_regular\": true,\n \"idx\": 7\n },\n {\n \"description\": \"Regular\",\n \"price\": 600.0,\n \"duration_type\": 0,\n \"bonus\": 30.0,\n \"is_regular\": true,\n \"idx\": 8\n },\n {\n \"description\": \"Regular\",\n \"price\": 500.0,\n \"duration_type\": 0,\n \"bonus\": 25.0,\n \"is_regular\": true,\n \"idx\": 9\n }\n ],\n \"session_id\": 20520,\n \"status\": true\n}\n
"},{"location":"Internet/dishhome/#2-payment-api","title":"2. Payment API","text":"This endpoint processes the payment for the selected Dish Home package.
"},{"location":"Internet/dishhome/#request_1","title":"Request","text":" - Request URL:
{{base_url}}/api/servicegroup/commit/dishhome-updated/ - Request Method:
POST - Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"\\ session_id\\ \",\n \"package_id\": \"\\ idx\\ \"\n}\n
"},{"location":"Internet/dishhome/#response_1","title":"Response","text":"The response provides details about the transaction status, including updated balance and transaction ID.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": {\n \"response_code\": 200,\n \"response_description\": \"Successfully Recharged\",\n \"updated_balance\": -1591.5836,\n \"expiry_date\": \"2024-06-14T11:15:00\",\n \"customer_status\": \"Active\",\n \"transaction_id\": 140251146,\n \"recharged_amount\": 500,\n \"is_bonus_added\": true\n },\n \"credits_consumed\": 500,\n \"credits_available\": 19987322608.1098,\n \"id\": 109657\n}\n
"},{"location":"Internet/dolfin-internet/","title":"Dolfin Internet","text":"This document provides the necessary information for interacting with the Dolfin Internet service APIs, detailing the required parameters and expected responses for both fetching details and processing payments.
"},{"location":"Internet/dolfin-internet/#detail-fetch-api","title":"Detail Fetch API","text":" - Request URL:
{{base_url}}/api/servicegroup/details/dolfin-net-communication/ - Request Method: POST
"},{"location":"Internet/dolfin-internet/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"reference\": \"{{$guid}}\",\n \"user\": \"user1\"\n}\n
"},{"location":"Internet/dolfin-internet/#response-example","title":"Response Example","text":"\n{\n \"customer_name\": \"K.PATRA\",\n \"bill_date\": \"17 May, 2024\",\n \"invoice_number\": \"4494fd025d3b367ebfa1\",\n \"partner_code\": \"ARCR1RVPMU6HVNTA6Q\",\n \"due_date\": \"26 Oct, 2024\",\n \"bill_period\": \"MONTHLY\",\n \"packages\": [\n {\n \"id\": 630,\n \"name\": \"50Mbps_1 Month (FUP) [Rs. 850] 1 Month\",\n \"price\": 50\n },\n {\n \"id\": 631,\n \"name\": \"120Mbps_1 Month (FUP) [Rs. 1230] 1 Month\",\n \"price\": 50\n },\n {\n \"id\": 914,\n \"name\": \"80Mbps_1 Month (FUP) [Rs. 1080] 1 Month\",\n \"price\": 50\n },\n {\n \"id\": 915,\n \"name\": \"200Mbps_1 Month (FUP) [Rs. 1480] 1 Month\",\n \"price\": 50\n },\n {\n \"id\": 916,\n \"name\": \"300Mbps_1 Month (FUP) [Rs. 1875] 1 Month\",\n \"price\": 50\n },\n {\n \"id\": 1051,\n \"name\": \"25Mbps_Unlimited_FUP 1 Month\",\n \"price\": 50\n },\n {\n \"id\": 1184,\n \"name\": \"50Mbps_3 Months (FUP) [Rs. 2000] 3 Months\",\n \"price\": 50\n },\n {\n \"id\": 1185,\n \"name\": \"80Mbps_3 Months (FUP) [Rs. 2300] 3 Months\",\n \"price\": 50\n },\n {\n \"id\": 1186,\n \"name\": \"120Mbps_3 Months (FUP) [Rs. 2700] 3 Months\",\n \"price\": 50\n },\n {\n \"id\": 1188,\n \"name\": \"50Mbps_12 Months (FUP) [Rs. 7500] 12 Months\",\n \"price\": 50\n },\n {\n \"id\": 1189,\n \"name\": \"80Mbps_12 Months (FUP) [Rs. 9000] 12 Months\",\n \"price\": 50\n },\n {\n \"id\": 1190,\n \"name\": \"120Mbps_12 Months (FUP) [Rs. 10000] 12 Months\",\n \"price\": 50\n }\n ],\n \"amount\": 50,\n \"session_id\": 23100,\n \"status\": true\n}\n
"},{"location":"Internet/dolfin-internet/#payment-api","title":"Payment API","text":" - Request URL:
{{base_url}}/api/servicegroup/commit/dolfin-net-communication/ - Request Method: POST
"},{"location":"Internet/dolfin-internet/#service-params_1","title":"Service Params","text":"\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"package_id\": \"package_id\",\n \"session_id\": \"session_id\"\n}\n
"},{"location":"Internet/dolfin-internet/#response-example_1","title":"Response Example","text":"\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 1100.0,\n \"credits_available\": 102009144.984999,\n \"extra_data\": {\n \"username\": \"joker_a\",\n \"mobile_number\": \"9818822421\",\n \"package\": \"20Mbps - 1 Month\",\n \"branch\": \"Saljhandi\"\n },\n \"id\": 18806\n}\n
"},{"location":"Internet/eastlink/","title":"East Link API","text":""},{"location":"Internet/eastlink/#overview","title":"Overview","text":"The East Link API allows users to initiate a transaction by submitting a POST request. This API requires user authentication through a token and supports transactions with specified parameters, such as the username, mobile number, amount, and a reference. The API response indicates the status of the operation and provides information about credits available and consumed.
"},{"location":"Internet/eastlink/#api-details","title":"API Details","text":" - Type: Single Step API
- URL:
{{base_url}}/api/use/eastlink/ - Method: POST
"},{"location":"Internet/eastlink/#service-parameters","title":"Service Parameters","text":"To make a request, send the following JSON object in the body of your POST request:
\n{\n \"token\": \"token\",\n \"username\": \"Username, eg: khaltiUser\",\n \"mobile_number\": \"9818766122\",\n \"amount\": 100, // Minimum Amount 100\n \"reference\": \"eastlink1\"\n}\n
"},{"location":"Internet/eastlink/#response-format","title":"Response Format","text":"Upon a successful request, the API will return a response in the following format:
\n{\n \"status\": true,\n \"id\": 1256,\n \"credits_available\": 9700.0,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"credits_consumed\": 100.0\n}\n
"},{"location":"Internet/eastlink/#response-fields","title":"Response Fields","text":" - status: Indicates if the request was successful (true/false).
- id: A unique identifier for the transaction.
- credits_available: The remaining credits available after the transaction.
- message: A message indicating the state of the transaction.
- state: The current state of the transaction (e.g., \"Queued\").
- credits_consumed: The amount of credits used for the transaction.
"},{"location":"Internet/eastlink/#conclusion","title":"Conclusion","text":"The East Link API is designed for easy and efficient transaction processing, providing necessary information for user account management and real-time updates on transaction status.
"},{"location":"Internet/first-link/","title":"First Link","text":"This document outlines the API for First Link, which includes functionalities for retrieving user details, getting package rates, and processing payments. It includes request URLs, methods, parameters, and example responses for each API.
"},{"location":"Internet/first-link/#user-detail-api","title":"User Detail API","text":"Request URL: {{base_url}}/api/servicegroup/details/firstlink/
Request Method: POST
"},{"location":"Internet/first-link/#service-params","title":"Service Params:","text":"\n{ \n \"token\": \"{{token}}\", \n \"reference\": \"{{$guid}}\", \n \"username\": \"url_ramesh_kafle\"\n}\n
"},{"location":"Internet/first-link/#response","title":"Response:","text":"\n{ \n \"email\": \"ramesh@firstlink.net.np\", \n \"user_identifier\": \"2\", \n \"session_id\": 55, \n \"status\": true \n}\n
"},{"location":"Internet/first-link/#get-packages-api","title":"Get Packages API","text":"Request URL: {{base_url}}/api/servicegroup/getpackagerates/firstlink/
Request Method: POST
"},{"location":"Internet/first-link/#service-params_1","title":"Service Params:","text":"\n{ \n \"token\": \"{{token}}\", \n \"session_id\": 55 \n}\n
"},{"location":"Internet/first-link/#response_1","title":"Response:","text":"\n{ \n \"active_internet_services\": [ \n { \n \"mac\": \"A4BE2BB9926C\", \n \"description\": \"Fiberhome 40Mbps-1Month\", \n \"status\": \"active\", \n \"unit_price\": \"1921.0000\" \n } \n ], \n \"tariff\": { \n \"title\": \"Fiberhome 40Mbps-1Month\", \n \"service_name\": \"Fiberhome 40Mbps-1Month\", \n \"billing_days_count\": \"30\" \n }, \n \"session_id\": 55, \n \"status\": true \n}\n
"},{"location":"Internet/first-link/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/firstlink/
Request Method: POST
"},{"location":"Internet/first-link/#service-params_2","title":"Service Params:","text":"\n{ \n \"token\": \"{{token}}\", \n \"amount\": 1921, \n \"session_id\": 4, \n \"comment\": \"Optional\" \n}\n
"},{"location":"Internet/first-link/#response_2","title":"Response:","text":"\n{ \n \"status\": true, \n \"state\": \"Queued\", \n \"detail\": \"Transaction Queued [Exception in Payment]\", \n \"message\": \"Your operation is in queue.\", \n \"credits_consumed\": 1921.0, \n \"credits_available\": \"**********\", \n \"extra_data\": {}, \n \"id\": 20276 \n}\n
"},{"location":"Internet/grs-internet/","title":"GRS Internet","text":"GRS Internet is an ISP.
Type: Multi Step API
"},{"location":"Internet/grs-internet/#1-detail-fetch-api","title":"1. Detail Fetch API","text":" - Request URL:
{{base_url}}/api/servicegroup/details/grs/ - Request Method: POST
"},{"location":"Internet/grs-internet/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"username\": \"blya-test\",\n \"reference\": \"unique reference\"\n}\n
"},{"location":"Internet/grs-internet/#response","title":"Response","text":"\n{\n \"username\": \"blya-test\",\n \"address\": \"Ganeshpur\",\n \"package\": [\n {\n \"package_id\": \"1\",\n \"package_name\": \"10Mbps\",\n \"amount\": 1000.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"2\",\n \"package_name\": \"20Mbps\",\n \"amount\": 1150.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"3\",\n \"package_name\": \"25Mbps\",\n \"amount\": 1150.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"4\",\n \"package_name\": \"40Mbps\",\n \"amount\": 1650.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"5\",\n \"package_name\": \"60Mbps\",\n \"amount\": 1800.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"6\",\n \"package_name\": \"30Mbps\",\n \"amount\": 1250.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"7\",\n \"package_name\": \"15Mbps\",\n \"amount\": 1050.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"8\",\n \"package_name\": \"100Mbps\",\n \"amount\": 2550.0,\n \"valid_days\": \"30\"\n },\n {\n \"package_id\": \"9\",\n \"package_name\": \"50Mbps\",\n \"amount\": 1750.0,\n \"valid_days\": \"30\"\n }\n ],\n \"session_id\": 4603,\n \"status\": true\n}\n
"},{"location":"Internet/grs-internet/#2-payment-api","title":"2. Payment API","text":" - Request URL:
{{base_url}}/api/servicegroup/commit/grs/ - Request Method: POST
"},{"location":"Internet/grs-internet/#service-params_1","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"package_id\": \"\\ Obtained from detail fetch API\\ \",\n \"session_id\": \"\\ Obtained from detail fetch API\\ \",\n \"amount\": \"\\ Obtained from detail fetch API\\ \",\n \"reference\": \"\\ unique reference\\ \"\n}\n
"},{"location":"Internet/grs-internet/#response_1","title":"Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 300.0,\n \"credits_available\": 9999711067.15,\n \"id\": 34081\n}\n
This document outlines the APIs for fetching user details and processing payments for GRS Internet services.
"},{"location":"Internet/infonet/","title":"Infonet Communication API","text":""},{"location":"Internet/infonet/#overview","title":"Overview","text":"The Infonet Communication API enables users to process communication service transactions. By sending a POST request with the required parameters, users can manage their communication services effectively. The API provides a status update on the transaction and the remaining credits.
"},{"location":"Internet/infonet/#api-details","title":"API Details","text":" - Type: Single Step API
- Test URL: {{base_url}}/api/use/infonet-communication/
- Method: POST
"},{"location":"Internet/infonet/#service-parameters","title":"Service Parameters","text":"To make a request, send the following JSON object in the body of your POST request:
\n{\n \"token\": \"token\",\n \"username\": \"Username, eg: khaltiUser\",\n \"number\": \"9818766122\",\n \"amount\": 100, // Minimum Amount 100, Max: 50,000\n \"address\": \"kathmandu\",\n \"reference\": \"infonetcommunication1\"\n}\n
"},{"location":"Internet/infonet/#response-format","title":"Response Format","text":"Upon a successful request, the API will return a response in the following format:
\n{\n \"status\": true,\n \"id\": 1259,\n \"credits_available\": 9400.0,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"credits_consumed\": 100.0\n}\n
"},{"location":"Internet/infonet/#response-fields","title":"Response Fields","text":" - status: Indicates if the request was successful (true/false).
- id: A unique identifier for the transaction.
- credits_available: The remaining credits available after the transaction.
- message: A message indicating the state of the transaction.
- state: The current state of the transaction (e.g., \"Queued\").
- credits_consumed: The amount of credits used for the transaction.
"},{"location":"Internet/infonet/#conclusion","title":"Conclusion","text":"The Infonet Communication API streamlines the process of managing communication services, providing users with essential updates and ensuring efficient transaction handling.
"},{"location":"Internet/konnect/","title":"Konnect (KCMS)","text":"Note: Below is the list of ISPs under KCMS and their service slugs:
"},{"location":"Internet/konnect/#izone-izone","title":"Izone: izone","text":""},{"location":"Internet/konnect/#world-fiber-net-world-fiber-net","title":"World Fiber Net: world-fiber-net","text":""},{"location":"Internet/konnect/#dg-link-dg-link","title":"DG Link: dg-link","text":""},{"location":"Internet/konnect/#loop-network-loop-network","title":"Loop Network: loop-network","text":""},{"location":"Internet/konnect/#acme-internet-acme-internet","title":"Acme Internet: acme-internet","text":""},{"location":"Internet/konnect/#chitrawan-unique-net-chitrawan-unique-net-has-been-shifted-in-chitrawan","title":"Chitrawan Unique Net: chitrawan-unique-net (has been Shifted in Chitrawan)","text":"Type: Multi-Step API
"},{"location":"Internet/konnect/#test-username","title":"Test Username:","text":"There are 3 different types of users. New users cannot make online payments:
- New
- Active
- Expired
"},{"location":"Internet/konnect/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/konnect/
Request Method: POST
Service Slug: service_slug
Service Parameters:
\n{\n \"token\": \"token\",\n \"username\": \"username\",\n \"reference\": \"unique_reference\",\n \"service_slug\": \"service_slug\" // e.g., izone, world-fiber-net, etc.\n}\n
Responses:
- Response for username: new
\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"This customer's first subscription payment cannot be paid online. Please contact the nearest office.\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
- Response for username: active
\n{\n \"customer\": {\n \"username\": \"9779869045195\",\n \"name\": \"Chandra Mani Neupane\",\n \"mobile\": \"9869045195\",\n \"status\": \"Active\"\n },\n \"current_subscription\": {\n \"package\": \"Fiber Internet (First Installation 20Mbps Home)\",\n \"end_date\": \"2021-04-30\",\n \"status\": \"Active\"\n },\n \"due\": {\n \"amount\": \"0.00000\",\n \"message\": \"Due Amount is NIL\"\n },\n \"packages\": [\n {\n \"package_id\": \"1-13286-5-3\",\n \"package_name\": \"Fiber Internet (First Installation) - 3 Month(s)\",\n \"amount\": 5999,\n \"current\": true\n },\n {\n \"package_id\": \"1-13286-5-12\",\n \"package_name\": \"Fiber Internet (First Installation) - 12 Month(s)\",\n \"amount\": 15500,\n \"current\": false\n }\n ],\n \"session_id\": 179,\n \"status\": true\n}\n
- Response for username: expired
\n{\n \"customer\": {\n \"username\": \"9779803074977\",\n \"name\": \"koshish bortaula\",\n \"mobile\": \"\",\n \"status\": \"Expired\"\n },\n \"current_subscription\": {\n \"package\": \"NET+TV - 30Mbps\",\n \"end_date\": \"2021-01-31\",\n \"status\": \"Expired\"\n },\n \"due\": {\n \"amount\": \"0\",\n \"message\": \"Due Amount is NIL\"\n },\n \"packages\": [\n {\n \"package_id\": \"1-4412-8-1\",\n \"package_name\": \"NET+TV - 30Mbps - 1 Month(s)\",\n \"amount\": 1850,\n \"current\": false\n },\n {\n \"package_id\": \"1-4412-8-3\",\n \"package_name\": \"NET+TV - 30Mbps - 3 Month(s)\",\n \"amount\": 5550,\n \"current\": false\n },\n {\n \"package_id\": \"1-4412-8-6\",\n \"package_name\": \"NET+TV - 30Mbps - 6 Month(s)\",\n \"amount\": 9250,\n \"current\": false\n },\n {\n \"package_id\": \"1-4412-8-12\",\n \"package_name\": \"NET+TV - 30Mbps - 12 Month(s)\",\n \"amount\": 18500,\n \"current\": true\n }\n ],\n \"session_id\": 180,\n \"status\": true\n}\n
"},{"location":"Internet/konnect/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/konnect/
Request Method: POST
Service Parameters:
\n{\n \"token\": \"token\",\n \"reference\": \"unique reference\",\n \"package_id\": \"package id of selected package\",\n \"amount\": \"amount of selected package\",\n \"session_id\": \"obtained from previous API\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Payment made successfully. Account will be activated in few minutes\",\n \"credits_consumed\": 5999.0,\n \"credits_available\": 9998.37,\n \"id\": 74020\n}\n
"},{"location":"Internet/kriti-darshan/","title":"Kriti Darshan","text":"This document provides details for the Kriti Darshan Single Step API, including the request URL, method, parameters, and example responses. The API allows users to initiate transactions and provides feedback on the status of those transactions. Single Step API
Request URL: {{base_url}}/api/use/kriti-darshan/
Request Method: POST
"},{"location":"Internet/kriti-darshan/#service-params","title":"Service Params:","text":"\n{ \n \"full_name\": \"udeep shrestha\", \n \"amount\": 2000, \n \"token\": \"{{LIVE_TOKEN}}\", \n \"reference\": \"{{$guid}}\", \n \"address\": \"Madhyapur Thimi\", \n \"mobile_number\": \"016632588\" \n}\n
Response:
\n{ \n \"status\": true, \n \"state\": \"Queued\", \n \"detail\": \"Transaction Queued\", \n \"message\": \"Your operation is in queue.\", \n \"credits_consumed\": 2000.0, \n \"credits_available\": 101194530.874999, \n \"extra_data\": { \n \"full_name\": \"udeep shrestha\", \n \"address\": \"Madhyapur Thimi\", \n \"mobile_number\": \"016632588\" \n }, \n \"id\": 20270 \n}\n
"},{"location":"Internet/merosoft/","title":"Merosoft","text":""},{"location":"Internet/merosoft/#overview","title":"Overview","text":"Merosoft provides various Internet Service Providers (ISPs) along with their respective service slugs. Below is the list of ISPs under Merosoft:
"},{"location":"Internet/merosoft/#isps-and-their-service-slugs","title":"ISPs and Their Service Slugs","text":" - Meta Link:
metalink - Prime Network:
prime-network - Alisha Communication:
alisha-communication - Smart Link:
smart-link - PDS Server Network:
pds-server-network
"},{"location":"Internet/merosoft/#api-details","title":"API Details","text":"Merosoft offers a multi-step API to fetch details and process payments for the services.
"},{"location":"Internet/merosoft/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/merosoft/
Request Method: POST
Service Parameters:
\n{\n \"token\": \"token\",\n \"reference\": \"unique reference\",\n \"Username\": \"kiran\",\n \"service_slug\": \"service_slug\" // service_slug of respective ISP, e.g., prime-network, metalink, alisha-communication\n}\n
Response:
\n{\n \"customer_name\": \"Kiran Shrestha\",\n \"remaining_days\": \"2781 days\",\n \"expiry_date\": \"2029-07-26\",\n \"active_package\": \"Basic for 1 month\",\n \"packages\": [\n {\n \"id\": 9,\n \"name\": \"Basic for 1 month\",\n \"price\": 1150\n },\n {\n \"id\": 13,\n \"name\": \"Advanced for 1 month\",\n \"price\": 1700\n },\n {\n \"id\": 21,\n \"name\": \"Extreme for 1 month\",\n \"price\": 2300\n }\n ],\n \"session_id\": 22,\n \"status\": true\n}\n
"},{"location":"Internet/merosoft/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/merosoft/
Request Method: POST
Service Parameters:
\n{\n \"token\": \"token\",\n \"reference\": \"unique reference\",\n \"username\": \"kiran\",\n \"service_slug\": \"service_slug\",\n \"package_id\": 9,\n \"package_name\": \"Basic for 1 month\",\n \"amount\": 1150,\n \"session_id\": 1\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Recharged Successfully\",\n \"credits_consumed\": 1150.0,\n \"credits_available\": 9999919624.3,\n \"id\": 29256\n}\n
"},{"location":"Internet/metrolink/","title":"Metrolink Internet","text":"Type: Single Step API
Test URL: {{base_url}}/api/use/metrolink/
Method: POST
Service Parameters:
\n{\n \"token\": \"token\",\n \"username\": \"Username, eg: khaltiUser\",\n \"number\": \"9818766122\",\n \"amount\": 100, // Minimum Amount 100, Max: 50,000\n \"address\": \"Banepa\",\n \"reference\": \"metrolink1\"\n}\n
Response:
\n{\n \"status\": true,\n \"id\": 1260,\n \"credits_available\": 9300.0,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"credits_consumed\": 100.0\n}\n
"},{"location":"Internet/netmax/","title":"Net Max Service","text":""},{"location":"Internet/netmax/#overview","title":"Overview","text":"An overview of the Net Max service APIs, including details on how to fetch customer subscription information and process payments. It covers the necessary request parameters, expected responses, and notes for handling dues.
"},{"location":"Internet/netmax/#fetch-api","title":"Fetch API","text":""},{"location":"Internet/netmax/#detail-fetch-api","title":"Detail Fetch API","text":" - Request URL:
{{base_url}}/api/servicegroup/details/net-max/ - Request Method: POST
"},{"location":"Internet/netmax/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"username\": \"new/active/expired\",\n \"reference\": \"Unique reference\"\n}\n
"},{"location":"Internet/netmax/#response-example","title":"Response Example","text":"\n{\n \"customer\": {\n \"username\": \"9779803074977\",\n \"name\": \"koshish bortaula\",\n \"mobile\": \"\",\n \"status\": \"Expired\"\n },\n \"current_subscription\": {\n \"package\": \"NET+TV - 30Mbps\",\n \"end_date\": \"2021-01-31\",\n \"status\": \"Expired\"\n },\n \"due\": {\n \"amount\": \"0\",\n \"message\": \"Due Amount is NIL\"\n },\n \"packages\": [\n {\n \"package_id\": \"1-4412-8-1\",\n \"package_name\": \"NET+TV - 30Mbps - 1 Month(s)\",\n \"amount\": 1850,\n \"current\": false\n },\n {\n \"package_id\": \"1-4412-8-3\",\n \"package_name\": \"NET+TV - 30Mbps - 3 Month(s)\",\n \"amount\": 5550,\n \"current\": false\n },\n {\n \"package_id\": \"1-4412-8-6\",\n \"package_name\": \"NET+TV - 30Mbps - 6 Month(s)\",\n \"amount\": 9250,\n \"current\": false\n },\n {\n \"package_id\": \"1-4412-8-12\",\n \"package_name\": \"NET+TV - 30Mbps - 12 Month(s)\",\n \"amount\": 18500,\n \"current\": true\n }\n ],\n \"session_id\": 8,\n \"status\": true\n}\n
Note: If there is a due amount, it will be displayed separately without summing it with the package amount. Package amounts may vary for different users if there are dues.
"},{"location":"Internet/netmax/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/net-max/ Request Method: POST
"},{"location":"Internet/netmax/#service-params_1","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"package_id\": \"1-4412-8-1\",\n \"amount\": \"1850\",\n \"session_id\": \"8\",\n \"reference\": \"Unique reference\"\n}\n
"},{"location":"Internet/netmax/#response-example_1","title":"Response Example","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Payment made successfully. Account will be activated in few minutes\",\n \"credits_consumed\": 1850.0,\n \"credits_available\": 986190.0,\n \"id\": 60959\n}\n
"},{"location":"Internet/nijgad_cable/","title":"Nijgad Cable API","text":""},{"location":"Internet/nijgad_cable/#1-for-cable-tv","title":"1. FOR CABLE TV","text":""},{"location":"Internet/nijgad_cable/#fetch-tv-package-api","title":"Fetch TV Package API","text":" - Request URL:
{{base_url}}/api/servicegroup/getpackages/nijgadh-cable/ - Request Method: POST
"},{"location":"Internet/nijgad_cable/#service-parameters","title":"Service Parameters","text":"To fetch available TV packages, send the following JSON object:
\n{\n \"token\": \"token\",\n \"type\": \"tv\"\n}\n
"},{"location":"Internet/nijgad_cable/#response-format","title":"Response Format","text":"The response will be in the following format:
\n{\n \"status\": true,\n \"detail\": {\n \"packages\": [\n {\n \"package_name\": \"Basic TV Package - 1Month\",\n \"amount\": 325\n },\n {\n \"package_name\": \"Basic TV Package - 3Month\",\n \"amount\": 975\n },\n {\n \"package_name\": \"Basic TV Package - 6Month\",\n \"amount\": 1550\n },\n {\n \"package_name\": \"Basic TV Package - 1Year\",\n \"amount\": 3000\n },\n {\n \"package_name\": \"HD TV Package - 1Month\",\n \"amount\": 525\n },\n {\n \"package_name\": \"HD TV Package - 3Month\",\n \"amount\": 1075\n },\n {\n \"package_name\": \"HD TV Package - 6Month\",\n \"amount\": 2575\n },\n {\n \"package_name\": \"HD TV Package - 1Year\",\n \"amount\": 5075\n }\n ]\n }\n}\n
"},{"location":"Internet/nijgad_cable/#tv-payment-api","title":"TV Payment API","text":" - Request URL:
{{base_url}}/api/use/nijgadh-cable/ - Request Method: POST
"},{"location":"Internet/nijgad_cable/#service-parameters_1","title":"Service Parameters","text":"To make a payment for the selected TV package, send the following JSON object:
\n{\n \"token\": \"token\",\n \"reference\": \"reference123\",\n \"username\": \"khaltiUser\",\n \"full_name\": \"Khalti User\",\n \"mobile_number\": \"9841xxxxxx\",\n \"package\": \"HD Plus Child TV Package - 1Year\", // from detail API\n \"amount\": 8000,\n \"tv_identifier\": \"132465\" // Should be cas_id(6 digit), box_number(10 digits), or smart_card_number(12)\n}\n
"},{"location":"Internet/nijgad_cable/#response-format_1","title":"Response Format","text":"Upon a successful transaction, the API will return the following response:
\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 8000.0,\n \"credits_available\": 96688310.0450002,\n \"extra_data\": {},\n \"id\": 7515\n}\n
"},{"location":"Internet/nijgad_cable/#2-for-internet","title":"2. FOR INTERNET","text":""},{"location":"Internet/nijgad_cable/#fetch-internet-package-api","title":"Fetch Internet Package API","text":" - Request URL:
{{base_url}}/api/servicegroup/getpackages/nijgadh-cable/ - Request Method: POST
"},{"location":"Internet/nijgad_cable/#service-parameters_2","title":"Service Parameters","text":"To fetch available internet packages, send the following JSON object:
\n{\n \"token\": \"token\",\n \"type\": \"internet\"\n}\n
"},{"location":"Internet/nijgad_cable/#response-format_2","title":"Response Format","text":"The response will be in the following format:
\n{\n \"status\": true,\n \"detail\": {\n \"packages\": [\n {\n \"package_name\": \"Internet Package - 1Month 20Mbps\",\n \"amount\": 1150\n },\n {\n \"package_name\": \"Internet Package - 3Month 20Mbps\",\n \"amount\": 3150\n },\n {\n \"package_name\": \"Internet Package - 6Month 20Mbps\",\n \"amount\": 7015\n },\n {\n \"package_name\": \"Internet Package - 12Month 20Mbps\",\n \"amount\": 12600\n },\n {\n \"package_name\": \"Internet Package - 1Month 30Mbps\",\n \"amount\": 1375\n },\n {\n \"package_name\": \"Internet Package - 3Month 30Mbps\",\n \"amount\": 3945\n },\n {\n \"package_name\": \"Internet Package - 6Month 30Mbps\",\n \"amount\": 7530\n },\n {\n \"package_name\": \"Internet Package - 12Month 30Mbps\",\n \"amount\": 13635\n },\n {\n \"package_name\": \"Internet Package - 1Month 40Mbps\",\n \"amount\": 1615\n },\n {\n \"package_name\": \"Internet Package - 3Month 40Mbps\",\n \"amount\": 4655\n },\n {\n \"package_name\": \"Internet Package - 6Month 40Mbps\",\n \"amount\": 8955\n },\n {\n \"package_name\": \"Internet Package - 12Month 40Mbps\",\n \"amount\": 16480\n },\n {\n \"package_name\": \"Internet Package - 1Month 75Mbps\",\n \"amount\": 2446\n },\n {\n \"package_name\": \"Internet Package - 3Month 75Mbps\",\n \"amount\": 7150\n },\n {\n \"package_name\": \"Internet Package - 6Month 75Mbps\",\n \"amount\": 13615\n },\n {\n \"package_name\": \"Internet Package - 12Month 75Mbps\",\n \"amount\": 26450\n }\n ]\n }\n}\n
"},{"location":"Internet/nijgad_cable/#internet-payment-api","title":"Internet Payment API","text":" - Request URL:
{{base_url}}/api/use/nijgadh-cable/ - Request Method: POST
"},{"location":"Internet/nijgad_cable/#service-parameters_3","title":"Service Parameters","text":"To make a payment for the selected internet package, send the following JSON object:
\n{\n \"token\": \"token\",\n \"reference\": \"reference123\",\n \"user_id\": \"khaltiUser\",\n \"name\": \"Khalti User\",\n \"mobile_number\": \"9841xxxxxx\",\n \"package\": \"Internet Package - 12Month 75Mbps\", // from detail API\n \"amount\": 26450\n}\n
"},{"location":"Internet/nijgad_cable/#response-format_3","title":"Response Format","text":"Upon a successful transaction, the API will return the following response:
\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 26450.0,\n \"credits_available\": 96688310.0450002,\n \"extra_data\": {},\n \"id\": 7515\n}\n
"},{"location":"Internet/ntftth/","title":"NT FTTH","text":"Type: Single Step API
"},{"location":"Internet/ntftth/#payment-api","title":"Payment API","text":" - Request URL:
{{base_url}}/api/use/nt-ftth/ - Request Method: POST
"},{"location":"Internet/ntftth/#service-params","title":"Service Params","text":"\n{\n \"token\": \"\\ token\\ \",\n \"number\": \"subscriber_number\", // e.g. 10000141001060\n \"amount\": 100,\n \"reference\": \"\\ Unique Identifier\\ \"\n}\n
"},{"location":"Internet/ntftth/#notes","title":"Notes","text":" - Amount should be between Rs. 10 and Rs. 25,000.
- The
number is the subscriber number of the user (14 characters). - The initial 5 characters are always constant:
10000.
"},{"location":"Internet/ntftth/#response-example","title":"Response Example","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Transaction successful\",\n \"credits_consumed\": 100.0,\n \"credits_available\": 9997874087.88002,\n \"id\": 51510\n}\n
"},{"location":"Internet/pokhara-internet/","title":"Pokhara Internet API","text":""},{"location":"Internet/pokhara-internet/#overview","title":"Overview","text":"The Pokhara Internet API allows users to submit a transaction request to purchase internet services. By sending a POST request with the required parameters, users can manage their internet subscriptions. The API provides feedback on the transaction status and available credits.
"},{"location":"Internet/pokhara-internet/#api-details","title":"API Details","text":" - Type: Single Step API
- URL:
{{base_url}}/api/use/pokhara-internet - Method: POST
"},{"location":"Internet/pokhara-internet/#service-parameters","title":"Service Parameters","text":"To make a request, send the following JSON object in the body of your POST request:
\n{\n \"token\": \"token\",\n \"username\": \"Username, eg: khaltiUser\",\n \"number\": \"9818766122\",\n \"amount\": 100, // Minimum Amount 100, Max: 50,000\n \"address\": \"Amarsingh\",\n \"reference\": \"pokharainternet1\"\n}\n
"},{"location":"Internet/pokhara-internet/#response-format","title":"Response Format","text":"Upon a successful request, the API will return a response in the following format:
\n{\n \"status\": true,\n \"id\": 1257,\n \"credits_available\": 9600.0,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"credits_consumed\": 100.0\n}\n
"},{"location":"Internet/pokhara-internet/#response-fields","title":"Response Fields","text":" - status: Indicates if the request was successful (true/false).
- id: A unique identifier for the transaction.
- credits_available: The remaining credits available after the transaction.
- message: A message indicating the state of the transaction.
- state: The current state of the transaction (e.g., \"Queued\").
- credits_consumed: The amount of credits used for the transaction.
"},{"location":"Internet/pokhara-internet/#conclusion","title":"Conclusion","text":"The Pokhara Internet API facilitates the purchase of internet services, ensuring users can manage their subscriptions efficiently while receiving real-time updates on transaction status.
"},{"location":"Internet/rapidapi/","title":"Rapid Unique Net","text":"Type: Multi Step API This document outlines the APIs for fetching user details and processing payments for Rapid Unique Net services.
"},{"location":"Internet/rapidapi/#1-details-fetch-api","title":"1. Details Fetch API","text":" - Request URL:
{{url}}/api/servicegroup/details/rapid-api/ - Method: POST
"},{"location":"Internet/rapidapi/#service-params","title":"Service Params","text":"\n{\n \"token\": \"provided token\",\n \"username\": \"username\",\n \"reference\": \"unique reference id\"\n}\n
"},{"location":"Internet/rapidapi/#response","title":"Response","text":"\n{\n \"status\": true,\n \"details\": {\n \"user_id\": 8897,\n \"name\": \"test \",\n \"address\": \"test\",\n \"username\": \"test\",\n \"remaining_days\": 30,\n \"phone_number\": \"9801558646\",\n \"amount\": \"1000.00\",\n \"added_grace_days\": \"0\",\n \"package_period\": \"1 Month\",\n \"package\": \"FIBER-HOME-10M\"\n },\n \"session_id\": 11686\n}\n
"},{"location":"Internet/rapidapi/#2-payment-api","title":"2. Payment API","text":" - Request URL:
{{url}}/api/servicegroup/commit/rapid-api/ - Method: POST
"},{"location":"Internet/rapidapi/#service-params_1","title":"Service Params","text":"\n{\n \"token\": \"\\ provided token\\ \",\n \"amount\": \"\\ amount from detail fetch\\ \",\n \"session_id\": \"\\ session id from get details\\ \"\n}\n
"},{"location":"Internet/rapidapi/#response_1","title":"Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Recharge Successful\",\n \"credits_consumed\": 1001.0,\n \"credits_available\": 9993943006.01662,\n \"id\": 95287\n}\n
"},{"location":"Internet/royal-network/","title":"Royal Network API","text":"The Royal Network API allows users to perform transactions related to the Royal Network service.
"},{"location":"Internet/royal-network/#type-single-step-api","title":"Type: Single Step API","text":""},{"location":"Internet/royal-network/#endpoint","title":"Endpoint","text":" - URL:
{{base_url}}/api/use/royal-network - Method:
POST
"},{"location":"Internet/royal-network/#service-parameters","title":"Service Parameters","text":"The request must include the following parameters:
\n{\n \"token\": \"token\",\n \"username\": \"Username, eg: khaltiUser\",\n \"mobile_number\": \"9818766122\",\n \"amount\": 100, // Minimum Amount 100\n \"reference\": \"royalnetwork1\"\n}\n
"},{"location":"Internet/royal-network/#validation","title":"Validation","text":" - Username Pattern:
([a-zA-Z0-9_]+) - Error Message: \"Invalid Username\"
"},{"location":"Internet/royal-network/#response","title":"Response","text":"Upon successful request, the API will return a response in the following format:
\n{\n \"status\": true,\n \"id\": 1268,\n \"credits_available\": 9000.0,\n \"message\": \"Your operation is in queue.\",\n \"state\": \"Queued\",\n \"credits_consumed\": 100.0\n}\n
"},{"location":"Internet/sky-broadband/","title":"Sky Broadband","text":"This document outlines the API for Sky Broadband, which includes functionalities for fetching available packages and processing payments. It details the request URLs, methods, parameters, and example responses for both the package fetch and payment APIs.
Type: Multi Step API
"},{"location":"Internet/sky-broadband/#1-package-fetch-api","title":"1. Package Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/sky-broadband/
Request Method: POST
"},{"location":"Internet/sky-broadband/#service-params","title":"Service Params:","text":"\n{ \n \"token\": \"token\", \n \"username\": \"ppoe_ashis_test\", \n \"reference\": \"unique reference\" \n}\n
"},{"location":"Internet/sky-broadband/#response","title":"Response:","text":"\n{ \n \"packages\": [ \n { \n \"package_id\": 3, \n \"package_name\": \"50Mbps Residential 1Month\", \n \"profile\": \"007_50Mbps_Residential_1Month\", \n \"package_slug\": \"50Mbps-Residential-1Month\", \n \"is_referrable\": 0, \n \"package_type\": null, \n \"expiration_amount\": null, \n \"expiration_period\": null, \n \"amount\": 10.0 \n }, \n { \n \"package_id\": 4, \n \"package_name\": \"default-2Mbit-1Month\", \n \"profile\": \"default-2Mbit-1Month\", \n \"package_slug\": \"default-2Mbit-1Month\", \n \"is_referrable\": 0, \n \"package_type\": \"Prepaid\", \n \"expiration_amount\": 1, \n \"expiration_period\": \"Month\", \n \"amount\": 1000.0 \n }, \n { \n \"package_id\": 5, \n \"package_name\": \"3-days-extension-package\", \n \"profile\": \"3-days-extension-package\", \n \"package_slug\": \"3-days-extension-package\", \n \"is_referrable\": 0, \n \"package_type\": \"Extension\", \n \"expiration_amount\": 3, \n \"expiration_period\": \"Day\", \n \"amount\": 10.0 \n } \n ], \n \"session_id\": 8319, \n \"status\": true \n}\n
"},{"location":"Internet/sky-broadband/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/sky-broadband/
Request Method: POST
"},{"location":"Internet/sky-broadband/#service-params_1","title":"Service Params:","text":"\n{ \n \"token\": \"token\", \n \"session_id\": \"session_id from previous detail fetch API\", \n \"amount\": \"amount from previous detail fetch API\", \n \"package_id\": \"package_id from previous detail fetch API\" \n}\n
"},{"location":"Internet/sky-broadband/#response_1","title":"Response:","text":"\n{ \n \"status\": true, \n \"state\": \"Success\", \n \"message\": \"Successfully Completed Transaction\", \n \"extra_data\": {}, \n \"detail\": \"Success\", \n \"credits_consumed\": 10.0, \n \"credits_available\": 9994745936.78663, \n \"id\": 82599 \n}\n
"},{"location":"Internet/subisu/","title":"Subisu New","text":"Multistep API
NOTE:
- If there is an outstanding amount greater than 0, users can choose to pay either the outstanding amount or their package payment. Users can also pay for their package if the outstanding amount is greater than 0.
- When fetching details, there are four different responses based on the user's plans: TV only, internet only, TV + internet, and Combo.
- Users with TV can have either a Single STB or multiple STBs. This applies to TV only and Internet + TV users.
- Payment parameters change based on the type of payment: Outstanding payment, TV payment, Internet payment, or Combo offer payment.
"},{"location":"Internet/subisu/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"URL: {{base_url}}/api/servicegroup/details/subisu/
Service Params:
\n{ \n \"token\": \"token-provided\", \n \"reference\": \"unique-reference\", \n \"username\": \"username\" \n}\n
"},{"location":"Internet/subisu/#response","title":"Response:","text":"Note:
- There are four different
plan_type values, and responses vary based on plan_type. - TV may have either a single STB or multiple STBs.
Types of Response:
- Response of
plan_type: \"internet\"
Test User: khaltiinternet
\n { \n \"customer_name\": \"Northbound Test Khalti\", \n \"address\": \"Baluwatar\", \n \"current_plan_name\": \"Internet Northbound\", \n \"user_id\": \"khaltiinternet\", \n \"outstanding_amount\": \"0.00\", \n \"expiry_date\": \"2023-08-25T23:59:59\", \n \"mobile_no\": \"9100000000\", \n \"onu_id\": null, \n \"partner_name\": \"Selfcare Test 1\", \n \"plan_detail_list\": { \n \"plan_detail_list\": { \n \"internet_plan_details\": [ \n { \n \"amount\": 10, \n \"plan_name\": \"Internet Northbound\", \n \"description\": \"10.00\", \n \"primary_speed\": \"0\", \n \"volume_quota\": \"0\", \n \"validity\": \"30 Days\" \n }, \n { \n \"amount\": 10, \n \"plan_name\": \"Internet Northbound\", \n \"description\": \"10.00\", \n \"primary_speed\": \"4096\", \n \"volume_quota\": null, \n \"validity\": \"30 Days\" \n }, \n { \n \"amount\": 4000, \n \"plan_name\": \"10Mbps 12Months BPKIHS\", \n \"description\": \"4000.00\", \n \"primary_speed\": \"10240\", \n \"volume_quota\": null, \n \"validity\": \"360 Days\" \n }, \n { \n \"amount\": 10, \n \"plan_name\": \"Selfcare Renew eSewa\", \n \"description\": \"10.00\", \n \"primary_speed\": \"20480\", \n \"volume_quota\": null, \n \"validity\": \"1 Days\" \n }, \n { \n \"amount\": 1, \n \"plan_name\": \"Selfcare Renew IPS & Card\", \n \"description\": \"1.00\", \n \"primary_speed\": \"20480\", \n \"volume_quota\": null, \n \"validity\": \"1 Days\" \n } \n ] \n }, \n \"plan_type\": \"internet\" \n }, \n \"session_id\": 9017, \n \"status\": true \n }\n
- Response of
plan_type: \"combo offer\"
Test User: khaltioffer
\n { \n \"customer_name\": \"Northbound Test Khalti\", \n \"address\": \"khaltioffer\", \n \"current_plan_name\": \"Offer Test Data\", \n \"user_id\": \"khaltioffer\", \n \"outstanding_amount\": \"0.00\", \n \"expiry_date\": \"2023-08-29T23:59:59\", \n \"mobile_no\": \"9100000000\", \n \"tv_plan_list\": { \n \"tv_plan_details\": [ \n { \n \"current_video_plan_name\": \"Offer Test Video\", \n \"stb\": \"ABCCD10BBBFC942B\", \n \"expiry_date\": \"2023-08-29T23:59:59\" \n } \n ] \n }, \n \"onu_id\": null, \n \"partner_name\": \"Selfcare Test 1\", \n \"plan_detail_list\": { \n \"plan_detail_list\": [ \n { \n \"validity\": \"1 Months\", \n \"offer_name\": \"Combo Offer Test 2\", \n \"offer_id\": \"4237\", \n \"amount\": 10, \n \"combo_plan_details\": [ \n { \n \"plan_type\": \"Data\", \n \"service_media\": \"FTTH\", \n \"activation_date\": \"2023-08-30T00:00:00\", \n \"expiry_date\": \"2023-09-29T00:00:00\", \n \"allow_to_renew\": \"false\", \n \"service_media_id\": \"11952\", \n \"stb_id\": null, \n \"is_primary\": \"false\", \n \"expiry_date_string\": \"29-Sep-2023\", \n \"activation_date_string\": \"30-Aug-2023\" \n }, \n { \n \"plan_type\": \"Video\", \n \"service_media\": \"Clear TV(DTV)\", \n \"activation_date\": \"2023-08-30T00:00:00\", \n \"expiry_date\": \"2023-09-29T00:00:00\", \n \"allow_to_renew\": \"false\", \n \"service_media_id\": \"11956\", \n \"stb_id\": \"780784\", \n \"is_primary\": \"true\", \n \"expiry_date_string\": \"29-Sep-2023\", \n \"activation_date_string\": \"30-Aug-2023\" \n } \n ] \n } \n ], \n \"plan_type\": \"combo offer\" \n }, \n \"session_id\": 9018, \n \"status\": true \n }\n
- Response of
plan_type: \"tv\"
Test User: paypoint_video
\n { \n \"customer_name\": \"Paypoint Video\", \n \"address\": \"Baluwatar\", \n \"user_id\": \"paypoint_video\", \n \"outstanding_amount\": \"0.00\", \n \"expiry_date\": null, \n \"mobile_no\": \"9100000000\", \n \"tv_plan_list\": { \n \"tv_plan_details\": [ \n { \n \"current_video_plan_name\": \"Video Tests Plan 1M\", \n \"stb\": \"sample5\", \n \"expiry_date\": \"2023-06-17T23:59:59\" \n }, \n { \n \"current_video_plan_name\": \"Mobile API DTV CHILD - TEST\", \n \"stb\": \"TEST0001\", \n \"expiry_date\": \"2023-06-17T23:59:59\" \n } \n ] \n }, \n \"onu_id\": null, \n \"partner_name\": \"Selfcare Test 1\", \n \"plan_detail_list\": { \n \"plan_detail_list\": [ \n { \n \"stb\": \"sample5\", \n \"tv_plan_details\": [ \n { \n \"amount\": 10, \n \"plan_name\": \"Video Tests Plan 1M\", \n \"validity\": \"30 Days\" \n } \n ] \n } \n ], \n \"plan_type\": \"tv\" \n }, \n \"session_id\": 9019, \n \"status\": true \n }\n
- Response of
plan_type: \"internet + tv\"
Test User: khaltivideo
\n { \n \"customer_name\": \"Khalti Video Plan\", \n \"address\": \"Baluwatar\", \n \"current_plan_name\": \"Selfcare Renew eSewa\", \n \"user_id\": \"khaltivideo\", \n \"outstanding_amount\": \"0.00\", \n \"expiry_date\": \"2023-07-01T23:59:59\", \n \"mobile_no\": \"9100000000\", \n \"tv_plan_list\": { \n \"tv_plan_details\": [ \n { \n \"current_video_plan_name\": \"Video offer child tests\", \n \"stb\": \"Sample 11\", \n \"expiry_date\": \"2023-07-21T23:59:59\" \n }, \n { \n \"current_video_plan_name\": \"Video Tests Plan 1M\", \n \"stb\": \"ABCC2C1D07B01A20\", \n \"expiry_date\": \"2023-08-21T23:59:59\" \n } \n ] \n }, \n \"onu_id\": null, \n \"partner_name\": \"Selfcare Test 1\", \n \"plan_detail_list\": { \n \"plan_detail_list\": { \n \"internet_details\": { \n \"internet_plan_details\": [ \n { \n \"amount\": 10, \n \"plan_name\": \"Selfcare Renew eSewa\", \n \"description\": \"10.00\", \n \"primary_speed\": \"0\", \n \"volume_quota\": \"0\", \n \"validity\": \"1 Days\" \n }, \n { \n \"amount\": 10, \n \"plan_name\": \"Internet Northbound\", \n \"description\": \"10.00\", \n \"primary_speed\": \"4096\", \n \"volume_quota\": null, \n \"validity\": \"30 Days\" \n }, \n { \n \"amount\": 4000, \n \"plan_name\": \"10Mbps 12Months BPKIHS\", \n \"description\": \"4000.00\", \n \"primary_speed\": \"10240\", \n \"volume_quota\": null, \n \"validity\": \"360 Days\" \n }, \n { \n \"amount\": 10, \n \"plan_name\": \"Selfcare Renew eSewa\", \n \"description\": \"10.00\", \n \"primary_speed\": \"20480\", \n \"volume_quota\": null, \n \"validity\": \"1 Days\" \n }, \n { \n \"amount\": 1, \n \"plan_name\": \"Selfcare Renew IPS & Card\", \n \"description\": \"1.00\", \n \"primary_speed\": \"20480\", \n \"volume_quota\": null, \n \"validity\": \"1 Days\" \n } \n ] \n }, \n \"tv_details\": [ \n { \n \"stb\": \"ABCC2C1D07B01A20\", \n \"tv_plan_details\": [ \n { \n \"amount\": 10, \n \"plan_name\": \"Video Tests Plan 1M\", \n \"validity\": \"30 Days\" \n } \n ] \n }, \n { \n \"stb\": \"ABCC2C1D07B01A20\", \n \"tv_plan_details\": [ \n { \n \"amount\": 10, \n \"plan_name\": \"Video Tests Plan 1M\", \n \"validity\": \"30 Days\" \n } \n ] \n }, \n { \n \"stb\": \"Sample 11\", \n \"tv_plan_details\": [ \n { \n \"amount\": 3, \n \"plan_name\": \"Video offer child tests\", \n \"validity\": \"30 Days\" \n } \n ] \n }, \n { \n \"stb\": \"Sample 11\", \n \"tv_plan_details\": [ \n { \n \"amount\": 3, \n \"plan_name\": \"Video offer child tests\", \n \"validity\": \"30 Days\" \n } \n ] \n } \n ] \n }, \n \"plan_type\": \"internet + tv\" \n }, \n \"session_id\": 9020, \n \"status\": true \n }\n
"},{"location":"Internet/subisu/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/subisu/
Request Method: POST
Outstanding amount is the due amount. Users can choose to pay the outstanding amount or the package amount. Parameters change based on the type of payment:
- Outstanding Payment If
outstanding_amount > 0, users can pay the outstanding amount. This works for all plan types: internet, combo offer, TV, and internet + TV.
Service Params for Outstanding Payment:
\n { \n \"token\": \"provided_token\", \n \"session_id\": Obtained from detail fetch API, \n \"amount\": \"amount\", // amount from detail step \n \"renew_type\": \"outstanding_payment\" \n }\n
- TV Payment When fetching details, users must select one STB if there are multiple STBs. This works for plan types: TV and internet + TV.
Service Params for TV Payment:
\n { \n \"token\": \"provided_token\", \n \"session_id\": Obtained from detail fetch API, \n \"amount\": \"amount\", // amount from detail fetch API \n \"offer_name\": \"offer_name\", // plan_name from detail step \n \"stb\": \"stb\" // STB from detail fetch API \n }\n
- Internet Payment This works for plan types: TV and internet + TV.
Service Params for Internet Payment:
\n { \n \"token\": \"provided_token\", \n \"session_id\": Obtained from detail fetch API, \n \"amount\": \"amount\", // amount from detail step \n \"offer_name\": \"offer_name\" // plan_name from detail step \n }\n
- Offer Payment This works for the combo offer plan type.
Service Params for Offer Payment:
\n { \n \"token\": \"provided_token\", \n \"session_id\": Obtained from detail fetch API, \n \"amount\": \"amount\", // amount from detail step \n \"offer_name\": \"offer_name\" // offer_name from detail step \n }\n
"},{"location":"Internet/subisu/#success-response","title":"Success Response:","text":"\n{ \n \"status\": true, \n \"state\": \"Success\", \n \"message\": \"Successfully Completed Transaction\", \n \"extra_data\": {}, \n \"detail\": \"2531\", \n \"credits_consumed\": 1232, \n \"credits_available\": 2460415608.4800014, \n \"id\": 64146 \n}\n
"},{"location":"Internet/subisu/#failed-response","title":"Failed Response:","text":" - If the user has no outstanding amount
\n { \n \"status\": false, \n \"error_code\": \"4000\", \n \"message\": \"Can't fulfill request\", \n \"error\": \"client_error\", \n \"details\": \"No outstanding dues.\", \n \"error_data\": {}, \n \"state\": \"Error\" \n }\n
- If the user has already purchased the package
\n { \n \"status\": false, \n \"error_code\": \"4000\", \n \"message\": \"Can't fulfill request\", \n \"error\": \"client_error\", \n \"details\": \"Future plan is already exist.\", \n \"error_data\": {}, \n \"state\": \"Error\" \n }\n
- Invalid offer name and amount
\n { \n \"status\": false, \n \"error_code\": \"1011\", \n \"message\": \"Validation error\", \n \"error\": \"validation_error\", \n \"details\": { \n \"offer_name\": \"Offer_name does not match with amount!\" \n }, \n \"error_data\": {}, \n \"state\": \"Error\" \n }\n
"},{"location":"Internet/techminds/","title":"Techminds API","text":"The Techminds API provides endpoints for fetching user details and processing payments.
"},{"location":"Internet/techminds/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Internet/techminds/#1-user-detail-api","title":"1. User Detail API","text":" - URL:
{{base_url}}/api/servicegroup/details/techminds/ - Method:
POST
"},{"location":"Internet/techminds/#service-parameters","title":"Service Parameters","text":"The request must include the following parameters:
\n{\n \"token\": \"token\",\n \"request_id\": \"lionschowk\",\n \"reference\": \"techminds123\"\n}\n
"},{"location":"Internet/techminds/#response-user-details","title":"Response: User Details","text":""},{"location":"Internet/techminds/#success-response","title":"Success Response","text":"\n{\n \"data\": {\n \"customer_name\": \"Kamal Raj Paudyal\",\n \"expiration\": \"Dec 28 2024\",\n \"mobile_number\": \"9855059124\",\n \"previous_balance\": 256,\n \"email\": \"kamal@technolinx.com.np\",\n \"monthly_charge\": \"1350\"\n },\n \"status\": true,\n \"session_id\": 8,\n \"available_plans\": {\n \"180 Days\": 8100,\n \"90 Days\": 4050,\n \"30 Days\": 1350,\n \"15 Days\": 675,\n \"60 Days\": 2700\n }\n}\n
"},{"location":"Internet/techminds/#2-payment-api","title":"2. Payment API","text":" - URL:
{{base_url}}/api/servicegroup/commit/techminds/ - Method:
POST
"},{"location":"Internet/techminds/#service-parameters_1","title":"Service Parameters","text":"The request must include the following parameters:
\n{\n \"request_id\": \"lionschowk\",\n \"session_id\": 7,\n \"reference\": \"reference123\",\n \"token\": \"TEST:O7QxjFcdueNzAh9aBOsD\",\n \"amount\": 1350\n}\n
"},{"location":"Internet/techminds/#response-payment","title":"Response: Payment","text":""},{"location":"Internet/techminds/#success-response_1","title":"Success Response","text":"\n{\n \"id\": 2209,\n \"status\": true,\n \"message\": \"Successfully Completed Transaction\",\n \"state\": \"Success\",\n \"detail\": \"Transaction successful\",\n \"extra_data\": {}\n}\n
"},{"location":"Internet/timesinternet/","title":"Times Internet","text":""},{"location":"Internet/timesinternet/#86-times-internet","title":"8.6 Times - Internet","text":"Note: Below is the list of ISPs under Times and their service_slug:
- 8.6.1 Websurfer Internet:
websurfer-internet - 8.6.2 Reliant Technology:
reliant-technology-v2 - 8.6.3 Palsnet:
palsnet - 8.6.4 Sky Internet:
sky-internet - 8.6.5 Pathibara Internet:
pathibara
"},{"location":"Internet/timesinternet/#multi-step-api","title":"Multi-Step API","text":"The Times Internet API consists of three main steps:
- Detail Fetch API
- Package Fetch API
- Payment API
"},{"location":"Internet/timesinternet/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"URL: {{base_url}}/api/servicegroup/userlist/times/
METHOD: POST
Service Params:
\n{\n \"token\": \"Account_Token\",\n \"reference\": \"Unique Id sent from your side\",\n \"customer_id\": \"Customer_ID\",\n \"service_slug\": \"service_slug\"\n}\n
Response:
\n{\n \"customer\": {\n \"cuid\": \"1000000\",\n \"first_name\": \"rajesh\",\n \"last_name\": \"lamichhane\",\n \"status\": \"active\"\n },\n \"connection\": [\n {\n \"username\": \"rajesh-lamichhane\",\n \"status\": \"active\"\n },\n {\n \"username\": \"rajesh-lamichhane2\",\n \"status\": \"active\"\n }\n ],\n \"session_id\": 2809,\n \"status\": true\n}\n
"},{"location":"Internet/timesinternet/#2-package-fetch-api","title":"2. Package Fetch API","text":"URL: {{base_url}}/api/servicegroup/details/times/
METHOD: POST
Service Params:
\n{\n \"token\": \"Account_Token\",\n \"username\": \"rajesh-lamichhane\",\n \"session_id\": \"session_id from user lookup\",\n \"service_slug\": \"service_slug\",\n \"reference\": \"unique reference id\"\n}\n
Response:
\n{\n \"packages\": [\n {\n \"package_id\": \"132\",\n \"package_name\": \"10Mbps Half Yearly - Nepalgunj (HALF YEARLY)\",\n \"amount\": 7451\n },\n {\n \"package_id\": \"130\",\n \"package_name\": \"10Mbps Monthly - Nepalgunj (MONTHLY)\",\n \"amount\": 1355\n },\n {\n \"package_id\": \"131\",\n \"package_name\": \"10Mbps Quarterly - Nepalgunj (QUARTERLY)\",\n \"amount\": 3895\n },\n {\n \"package_id\": \"134\",\n \"package_name\": \"10Mbps Yearly - renew- Nepalgu (YEARLY)\",\n \"amount\": 11000\n },\n {\n \"package_id\": \"137\",\n \"package_name\": \"15Mbps Half Yearly - Nepalgunj (HALF YEARLY)\",\n \"amount\": 7910\n },\n {\n \"package_id\": \"135\",\n \"package_name\": \"15Mbps Monthly - Nepalgunj (MONTHLY)\",\n \"amount\": 1412\n },\n {\n \"package_id\": \"136\",\n \"package_name\": \"15Mbps Quarterly - Nepalgunj (QUARTERLY)\",\n \"amount\": 4068\n },\n {\n \"package_id\": \"139\",\n \"package_name\": \"15Mbps Yearly - renew- Nepalgu (YEARLY)\",\n \"amount\": 12001\n },\n {\n \"package_id\": \"103\",\n \"package_name\": \"15Mbps-Half Yearly (HALF YEARLY)\",\n \"amount\": 5101\n },\n {\n \"package_id\": \"101\",\n \"package_name\": \"15Mbps-Monthly (MONTHLY)\",\n \"amount\": 950\n },\n {\n \"package_id\": \"102\",\n \"package_name\": \"15Mbps-Quarterly (QUARTERLY)\",\n \"amount\": 2550\n },\n {\n \"package_id\": \"104\",\n \"package_name\": \"15Mbps-Yearly (YEARLY)\",\n \"amount\": 10201\n },\n {\n \"package_id\": \"107\",\n \"package_name\": \"20Mbps-Half Yearly (HALF YEARLY)\",\n \"amount\": 5700\n },\n {\n \"package_id\": \"105\",\n \"package_name\": \"20Mbps-Monthly (MONTHLY)\",\n \"amount\": 950\n },\n {\n \"package_id\": \"106\",\n \"package_name\": \"20Mbps-Quarterly (QUARTERLY)\",\n \"amount\": 2851\n },\n {\n \"package_id\": \"108\",\n \"package_name\": \"20Mbps-Yearly (YEARLY)\",\n \"amount\": 11400\n },\n {\n \"package_id\": \"111\",\n \"package_name\": \"30Mbps-Half Yearly (HALF YEARLY)\",\n \"amount\": 7500\n },\n {\n \"package_id\": \"109\",\n \"package_name\": \"30Mbps-Monthly (MONTHLY)\",\n \"amount\": 1250\n },\n {\n \"package_id\": \"110\",\n \"package_name\": \"30Mbps-Quarterly (QUARTERLY)\",\n \"amount\": 3750\n },\n {\n \"package_id\": \"112\",\n \"package_name\": \"30Mbps-Yearly (YEARLY)\",\n \"amount\": 15000\n },\n {\n \"package_id\": \"115\",\n \"package_name\": \"40Mbps-Half Yearly (HALF YEARLY)\",\n \"amount\": 9000\n },\n {\n \"package_id\": \"119\",\n \"package_name\": \"40Mbps-Half Yearly-Nepalgunj (HALF YEARLY)\",\n \"amount\": 7800\n },\n {\n \"package_id\": \"113\",\n \"package_name\": \"40Mbps-Monthly (MONTHLY)\",\n \"amount\": 1501\n },\n {\n \"package_id\": \"141\",\n \"package_name\": \"40Mbps-Monthly @ 1000-R (MONTHLY)\",\n \"amount\": 1000\n },\n {\n \"package_id\": \"117\",\n \"package_name\": \"40Mbps-Monthly-Nepalgunj (MONTHLY)\",\n \"amount\": 1300\n },\n {\n \"package_id\": \"118\",\n \"package_name\": \"40Mbps-Quarterly-Nepalgunj (QUARTERLY)\",\n \"amount\": 3900\n },\n {\n \"package_id\": \"120\",\n \"package_name\": \"40Mbps-Yearly-Nepalgunj (YEARLY)\",\n \"amount\": 14501\n },\n {\n \"package_id\": \"127\",\n \"package_name\": \"5Mbps Half Yearly - Nepalgunj (HALF YEARLY)\",\n \"amount\": 4740\n },\n {\n \"package_id\": \"125\",\n \"package_name\": \"5Mbps Monthly Old - Nepalgunj (MONTHLY)\",\n \"amount\": 790\n },\n {\n \"package_id\": \"126\",\n \"package_name\": \"5Mbps Quarterly - Nepalgunj (QUARTERLY)\",\n \"amount\": 2201\n },\n {\n \"package_id\": \"129\",\n \"package_name\": \"5Mbps Yearly - renew- Nepalgun (YEARLY)\",\n \"amount\": 5901\n }\n ],\n \"session_id\": 2809,\n \"status\": true\n}\n
"},{"location":"Internet/timesinternet/#3-payment-api","title":"3. Payment API","text":"URL: {{base_url}}/api/servicegroup/commit/times/
METHOD: POST
Service Params:
\n{\n \"token\": \"Account_Token\",\n \"session_id\": \"session_id from user lookup\",\n \"amount\": \"Package Amount from package fetch API\",\n \"package_id\": \"package ID from package fetch API\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 790.0,\n \"credits_available\": 9999378747.53,\n \"id\": 42353\n}\n
"},{"location":"Internet/vianet-new/","title":"Vianet","text":""},{"location":"Internet/vianet-new/#1-service-group-details-api","title":"1. Service Group Details API","text":""},{"location":"Internet/vianet-new/#url","title":"URL","text":"{{base_url}}/api/servicegroup/details/vianet-updated/
"},{"location":"Internet/vianet-new/#method","title":"Method","text":"POST
"},{"location":"Internet/vianet-new/#request-payload","title":"Request Payload","text":"\n{\n \"token\": \"token\",\n \"reference\": \"Unique reference\",\n \"customer_id\": 110871\n}\n
"},{"location":"Internet/vianet-new/#success-response","title":"Success Response","text":"\n{\n \"customer_id\": 110871,\n \"customer_name\": \"Suman Shrestha\",\n \"bills\": [\n {\n \"payment_id\": \"1613142_PP\",\n \"service_name\": \"wetherspooncafe21424\",\n \"service_details\": \"FiberNet Home CRush (1 year)\",\n \"vat_amount\": \"30.55\",\n \"grand_total\": \"277.98\",\n \"service_rate\": \"246.00\"\n },\n {\n \"payment_id\": \"1613143_PP\",\n \"service_name\": \"wetherspooncafe21424\",\n \"service_details\": \"Test payment 2\",\n \"vat_amount\": \"3.77\",\n \"grand_total\": \"34.35\",\n \"service_rate\": \"30.40\"\n },\n {\n \"payment_id\": \"1613144_PP\",\n \"service_name\": \"wetherspooncafe21424\",\n \"service_details\": \"Test Payment 1\",\n \"vat_amount\": \"5.20\",\n \"grand_total\": \"47.46\",\n \"service_rate\": \"42.00\"\n },\n {\n \"payment_id\": \"1613145_PP\",\n \"service_name\": \"wetherspooncafe21424\",\n \"service_details\": \"FiberNet Home CRush (6 months)\",\n \"vat_amount\": \"13.00\",\n \"grand_total\": \"118.65\",\n \"service_rate\": \"105.00\"\n }\n ],\n \"session_id\": 27383,\n \"status\": true\n}\n
"},{"location":"Internet/vianet-new/#error-response","title":"Error Response","text":"\n{\n \"status\": false,\n \"error_code\": \"7000\",\n \"message\": \"Unknown Error occured. Check details\",\n \"error\": \"unknown_error\",\n \"details\": \"You have no pending bills right now !!\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"Internet/vianet-new/#2-payment-commit-api","title":"2. Payment Commit API","text":""},{"location":"Internet/vianet-new/#url_1","title":"URL","text":"{{base_url}}/api/servicegroup/commit/vianet-updated/
"},{"location":"Internet/vianet-new/#method_1","title":"Method","text":"POST
"},{"location":"Internet/vianet-new/#request-payload_1","title":"Request Payload","text":"\n{\n \"token\": \"{{token}}\",\n \"session_id\": \"{{session_id}}\",\n \"payment_id\": \"{{payment_id}}\",\n \"amount\": {{amount}},\n \"reference\": \"{{$guid}}\"\n}\n
"},{"location":"Internet/vianet-new/#success-response_1","title":"Success Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": {\n \"message\": \"Payment Successfull! Thank you for using Online Payment Option\"\n },\n \"credits_consumed\": 277.98,\n \"credits_available\": 999006795.14,\n \"id\": 130144\n}\n
"},{"location":"Internet/vianet-new/#error-response_1","title":"Error Response","text":"\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Payment seems to have already been Made!\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"Internet/vianet/","title":"Vianet Deprecated","text":"Note: Please ensure to follow the latest API in the Vianet documentation. Click here for more details.
"},{"location":"Internet/vianet/#overview","title":"Overview","text":"The Vianet API consists of two primary endpoints for interacting with the service:
- User Details Endpoint: Retrieves details about a specific customer, including their billing information.
- Payment Endpoint: Commits a payment based on the details retrieved from the first step.
"},{"location":"Internet/vianet/#user-details","title":"User Details","text":"URL: {{base_url}}/api/servicegroup/details/vianet/
Service Params:
\n{\n \"token\": \"token-provided\",\n \"customer_id\": \"CustomerId provided by vianet, e.g., 10619\"\n}\n
Regex:
\n[\n {\n \"name\": \"Customer ID\",\n \"slug\": \"\",\n \"pattern\": \"([a-zA-Z0-9_]+)\",\n \"error_message\": \"Invalid Customer Id\"\n }\n]\n
Example:
"},{"location":"Internet/vianet/#response","title":"Response:","text":""},{"location":"Internet/vianet/#success","title":"Success","text":"\n{\n \"status\": true,\n \"bills\": [\n {\n \"payment_id\": \"378197\",\n \"bill_date\": \"2017-09-08\",\n \"service_details\": \"FiberNet Home Rush (1 year)\",\n \"service_name\": \"serv9099\",\n \"amount\": 23187.6\n }\n ],\n \"session_id\": 130,\n \"customer_id\": \"9099\",\n \"customer_name\": \"Customer Name\"\n}\n
"},{"location":"Internet/vianet/#error","title":"Error","text":"\n{\n \"error_code\": \"1010\",\n \"message\": \"Validation error\",\n \"status\": false,\n \"error_data\": \"\",\n \"details\": \"**\"\n}"},{"location":"Internet/vianet/#vianet-payment","title":"Vianet Payment","text":"URL: {{base_url}}/api/servicegroup/commit/vianet/
\nService Params:
\n\n{\n \"token\": \"token-provided\",\n \"session_id\": \"Session id as obtained in details step\",\n \"customer_id\": \"Customer Id, same as in details step\",\n \"payment_id\": \"Payment Id as obtained in details step\",\n \"reference\": \"unique reference_id\"\n}\n
"},{"location":"Internet/vianet/#response_1","title":"Response:","text":""},{"location":"Internet/vianet/#success_1","title":"Success","text":"\n{\n \"id\": 496,\n \"message\": \"Thank you for using our online Service.\",\n \"status\": true,\n \"state\": \"Success\"\n}\n
"},{"location":"Internet/vianet/#error_1","title":"Error","text":"\n{\n \"error_code\": \"1010\",\n \"message\": \"Validation error\",\n \"status\": false,\n \"error_data\": \"\",\n \"details\": \"**\"\n}"},{"location":"Internet/web-network/","title":"Web Network API","text":"The Web Network API allows users to fetch details and make payments for web network services.
"},{"location":"Internet/web-network/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Internet/web-network/#1-get-details","title":"1. Get Details","text":" - URL: {{base_url}}/api/servicegroup/details/web-network
- Method:
POST
"},{"location":"Internet/web-network/#service-parameters","title":"Service Parameters","text":"The request must include the following parameters:
\n{\n \"token\": \"token\",\n \"request_id\": \"anjudvt_fiber\",\n \"reference\": \"unique reference identifier\"\n}\n
"},{"location":"Internet/web-network/#response","title":"Response","text":"Upon successful request, the API will return a response in the following format:
\n{\n \"request_id\": \"anjudvt_fiber\",\n \"amount\": 7150,\n \"response_message\": \"\",\n \"properties\": {\n \"name\": \"Anju Kc\",\n \"address\": \"Nayamil, Rupandehi\",\n \"package\": \"Fiber Plan\",\n \"duration\": \"8\"\n },\n \"session_id\": 8795,\n \"status\": true\n}\n
"},{"location":"Internet/web-network/#2-payment","title":"2. Payment","text":" - URL: {{base_url}}/api/servicegroup/commit/web-network/
- Method:
POST
"},{"location":"Internet/web-network/#service-parameters_1","title":"Service Parameters","text":"The request must include the following parameters:
\n{\n \"amount\": \"amount from get details API\",\n \"session_id\": \"session id from get details API\",\n \"reference\": \"unique reference\",\n \"token\": \"token\"\n}\n
"},{"location":"Internet/web-network/#response_1","title":"Response","text":"Upon successful transaction, the API will return a response in the following format:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 7150,\n \"credits_available\": 999999998110797.6,\n \"id\": 62819\n}\n
"},{"location":"Internet/wifi-nepal/","title":"Wifi Nepal API","text":"Wifi Nepal provides a multi-step API for managing internet service subscriptions and payments.
"},{"location":"Internet/wifi-nepal/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Internet/wifi-nepal/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"This endpoint retrieves detailed information about a user's Wifi Nepal account, including due payments and package details.
"},{"location":"Internet/wifi-nepal/#request","title":"Request","text":" - Request URL:
{{base_url}}/api/servicegroup/details/wifi-nepal/ - Request Method:
POST - Service Params:
\n{\n \"token\": \"token\",\n \"username\": \"username\",\n \"reference\": \"unique reference\",\n \"service_slug\": \"wifi-nepal-v2\"\n}\n
"},{"location":"Internet/wifi-nepal/#response","title":"Response","text":"The response contains the user's details, subscription package, due amount, and remaining days.
\n{\n \"name\": \"Kalpana Dahal\",\n \"user_id\": \"test10_wifinepal\",\n \"amount\": 6215,\n \"subscribed_package_name\": \"Master Plan-50mbps/12mths\",\n \"subscription_type\": \"RETAIL\",\n \"days_remaining\": \"353\",\n \"message\": \"You have due payment.\",\n \"amount_detail\": [\n {\n \"particular\": \"Internet\",\n \"amount\": 5085\n },\n {\n \"particular\": \"Equipment Rental Charges\",\n \"amount\": 1130\n }\n ],\n \"session_id\": 548,\n \"status\": true\n}\n
"},{"location":"Internet/wifi-nepal/#2-payment-api","title":"2. Payment API","text":"This endpoint processes the payment for the user's Wifi Nepal account.
"},{"location":"Internet/wifi-nepal/#request_1","title":"Request","text":" - Request URL:
{{base_url}}/api/servicegroup/commit/wifi-nepal/ - Request Method:
POST - Service Params:
\n{\n \"amount\": \"1808\",\n \"session_id\": \"21820\",\n \"reference\": \"{{$guid}}\",\n \"token\": \"{{token}}\",\n \"service_slug\": \"wifi-nepal-v2\"\n}\n
"},{"location":"Internet/wifi-nepal/#response_1","title":"Response","text":"The response confirms the transaction and provides invoice details.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": {\n \"invoiceNumber\": \"gs-366/2079.080\",\n \"taxableAmount\": \"5500\",\n \"vatAmount\": \"715\"\n },\n \"credits_consumed\": 6215,\n \"credits_available\": 9791703.64,\n \"id\": 58743\n}\n
"},{"location":"Internet/worldlink/","title":"WorldLink","text":""},{"location":"Internet/worldlink/#version-2","title":"Version 2","text":"Type: Multi-Step API
There are three types of users for whom this API is applicable:
-
Package Switchable Users You will receive the package options in package_options.
These users can switch their internet package. - Username: online_renew
-
Package Switchable Users with Due Payment
You will receive the package options in available_renew_options.
- Users can switch their internet package and need to pay any outstanding dues.
- If the subscribed_package_id is the same as the available_renew_options packageId, due payment will not be added to the total payable amount.
-
If the subscribed_package_id is different from the available_renew_options packageId, the due amount will be added to the total payable amount.
-
Username: online_due_and_package
-
Package Non-Switchable Users with Due Payment These users have a due payment but cannot switch their package.
- Username:
online_due_payment
"},{"location":"Internet/worldlink/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/worldlink-v2/
Request Method: POST
Service Params:
\n{ \n \"token\": \"token\", \n \"reference\": \"\", \n \"username\": \"online_renew/online_due_payment\" \n}\n\n\nResponse:
\nResponses vary depending on the type of user.
"},{"location":"Internet/worldlink/#response-for-package-switchable-users","title":"Response for Package Switchable Users","text":"Example Response:
\n\n{ \n \"username\": \"online_renew\", \n \"full_name\": \"Online Renew\", \n \"subscribed_package_name\": \"Value Standard 25mbps/3mths 1TV (Renew)\", \n \"subscribed_package_type\": \"Unlimited\", \n \"subscribedPackageId\": 1888314,\n \"days_remaining\": 0, \n \"message\": \"You have due payment.\", \n \"package_options\": [ \n { \n \"packageId\": 1888117, \n \"packageName\": \"Fiber Smart home 2019-25mbps/3 mths(Renew)\", \n \"packageRate\": 4915, \n \"packageLabel\": \"Fiber Smart home 2019-25mbps/3 mths(Renew) [Rs. 4915]\" \n }, \n { \n \"packageId\": 1888314, \n \"packageName\": \"Value Standard 25mbps/3mths 1TV (Renew)\", \n \"packageRate\": 4915, \n \"packageLabel\": \"Value Standard 25mbps/3mths 1TV (Renew) [Rs. 4915]\" \n }, \n { \n \"packageId\": 1888118, \n \"packageName\": \"Fiber Smart home 2019-40mbps/3 mths(Renew)\", \n \"packageRate\": 5932, \n \"packageLabel\": \"Fiber Smart home 2019-40mbps/3 mths(Renew) [Rs. 5932]\" \n }, \n { \n \"packageId\": 1888119, \n \"packageName\": \"Fiber Smart home 2019-60mbps/3 mths(Renew)\", \n \"packageRate\": 8475, \n \"packageLabel\": \"Fiber Smart home 2019-60mbps/3 mths(Renew) [Rs. 8475]\" \n }, \n { \n \"packageId\": 1888123, \n \"packageName\": \"Fiber Smart home 2019-25mbps/12mths(Renew)\", \n \"packageRate\": 16272, \n \"packageLabel\": \"Fiber Smart home 2019-25mbps/12mths(Renew) [Rs. 16272]\" \n }, \n { \n \"packageId\": 1888124, \n \"packageName\": \"Fiber Smart home 2019-40mbps/12mths(Renew)\", \n \"packageRate\": 19097, \n \"packageLabel\": \"Fiber Smart home 2019-40mbps/12mths(Renew) [Rs. 19097]\" \n }, \n { \n \"packageId\": 1888125, \n \"packageName\": \"Fiber Smart home 2019-60mbps/12mths(Renew)\", \n \"packageRate\": 28250, \n \"packageLabel\": \"Fiber Smart home 2019-60mbps/12mths(Renew) [Rs. 28250]\" \n } \n ], \n \"renew_option\": false, \n \"first_online_payment\": false, \n \"amount_detail\": [ \n { \n \"particular\": \"Internet\", \n \"amount\": 4915 \n } \n ], \n \"amount\": 4915, \n \"session_id\": 109, \n \"status\": true \n}\n
"},{"location":"Internet/worldlink/#response-for-package-switchable-users-with-due-payment","title":"Response for Package Switchable Users with Due Payment","text":"Example Response:
\n\n{\n \"username\": \"online_due_and_package\",\n \"account_type\": \"PERSONAL\",\n \"full_name\": \"online_due_and_package\",\n \"branch\": \"REGION2-NBU4\",\n \"subscribed_package_name\": \"BTL 120Mbps/12mths With 1TV New Year Dhamaka 079\",\n \"subscribed_package_type\": \"Unlimited\",\n \"subscribed_package_id\": 1888768,\n \"days_remaining\": 0,\n \"message\": \"You have due payment.\",\n \"package_options\": [],\n \"vatrefund_eligible\": true,\n \"available_renew_options\": [\n {\n \"packageId\": 18881068,\n \"packageName\": \"WorldLink TurboSpeed Plus 150Mbps/12M\\t\",\n \"packageRate\": 13108,\n \"packageLabel\": \"WorldLink TurboSpeed Plus 150Mbps/12M\\t [Rs. 13108]\",\n \"recommendOrder\": 1,\n \"packageDuration\": \"365\",\n \"tvEligiblePackage\": 0,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 1888857,\n \"packageName\": \"Smart Offer (1TV) 2079 200mbps/12mths\",\n \"packageRate\": 16272,\n \"packageLabel\": \"Smart Offer (1TV) 2079 200mbps/12mths [Rs. 16272]\",\n \"recommendOrder\": 2,\n \"packageDuration\": \"365\",\n \"tvEligiblePackage\": 1,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 1888767,\n \"packageName\": \"BTL 120Mbps/3mths With 1TV New Year Dhamaka 079\",\n \"packageRate\": 3220,\n \"packageLabel\": \"BTL 120Mbps/3mths With 1TV New Year Dhamaka 079 [Rs. 3220]\",\n \"recommendOrder\": 3,\n \"packageDuration\": \"90\",\n \"tvEligiblePackage\": 0,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 1888668,\n \"packageName\": \"Special BTL 120Mbps/mth (1TV)\",\n \"packageRate\": 1356,\n \"packageLabel\": \"Special BTL 120Mbps/mth (1TV) [Rs. 1356]\",\n \"recommendOrder\": 4,\n \"packageDuration\": \"30\",\n \"tvEligiblePackage\": 0,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 1888858,\n \"packageName\": \"Smart Offer (1TV) 2079 250mbps/12mths\",\n \"packageRate\": 16950,\n \"packageLabel\": \"Smart Offer (1TV) 2079 250mbps/12mths [Rs. 16950]\",\n \"recommendOrder\": 5,\n \"packageDuration\": \"365\",\n \"tvEligiblePackage\": 1,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 18881115,\n \"packageName\": \"New Smart Offer (1TV) 2081 200Mbps/6mths\",\n \"packageRate\": 8927,\n \"packageLabel\": \"New Smart Offer (1TV) 2081 200Mbps/6mths [Rs. 8927]\",\n \"recommendOrder\": 6,\n \"packageDuration\": \"180\",\n \"tvEligiblePackage\": 0,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 18881116,\n \"packageName\": \"New smart Offer (1TV) 2081 200Mbps/24mths\",\n \"packageRate\": 23041,\n \"packageLabel\": \"New smart Offer (1TV) 2081 200Mbps/24mths [Rs. 23041]\",\n \"recommendOrder\": 7,\n \"packageDuration\": \"730\",\n \"tvEligiblePackage\": 0,\n \"packageEligibility\": false\n },\n {\n \"packageId\": 1888768,\n \"packageName\": \"BTL 120Mbps/12mths With 1TV New Year Dhamaka 079\",\n \"packageRate\": 12204,\n \"packageLabel\": \"BTL 120Mbps/12mths With 1TV New Year Dhamaka 079 [Rs.12204]\",\n \"tvEligiblePackage\": 0,\n \"packageEligibility\": true,\n \"packageDuration\": 0,\n \"recommendOrder\": 0\n }\n ],\n \"renew_option\": true,\n \"due_amount_till_now\": 301,\n \"due_remarks\": \"used 9 days of BTL 120Mbps/12mths With 1TV New Year Dhamaka 079 (1888768)\",\n \"first_online_payment\": false,\n \"amount_detail\": [\n {\n \"amount\": 12204,\n \"creditor\": \"worldlink\",\n \"particular\": \"Internet\",\n \"creditorPan\": \"300073250\"\n }\n ],\n \"amount\": 12204,\n \"session_id\": 22906,\n \"status\": true\n}\n
"},{"location":"Internet/worldlink/#response-for-package-non-switchable-users-with-due-payment","title":"Response for Package Non-Switchable Users with Due Payment","text":"Example Response:
\n\n{ \n \"username\": \"online_due_payment\", \n \"full_name\": \"Online Due Payment\", \n \"branch\": \"MANIGRAM\", \n \"subscribed_package_name\": \"Value Standard 25mbps/3mths 1TV (Renew)\", \n \"subscribed_package_type\": \"Unlimited\", \n \"days_remaining\": 0, \n \"message\": \"You have due payment.\", \n \"package_options\": [], \n \"renew_option\": false, \n \"first_online_payment\": false, \n \"amount_detail\": [ \n { \n \"particular\": \"Internet\", \n \"amount\": 4950 \n } \n ], \n \"amount\": 4950, \n \"session_id\": 224, \n \"status\": true \n}\n
"},{"location":"Internet/worldlink/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/worldlink-v2/
\nRequest Method: POST
\nService Params:
\n\n{ \n \"token\": \"token\", \n \"session_id\": \"\", \n \"amount\": 4950, \n \"package_id\": \"\", // OPTIONAL - Required when a package is selected \n \"reference\": \"\" \n}\n\n\nResponse:
\nSuccess Response:
\n\n{ \n \"status\": true, \n \"state\": \"Success\", \n \"message\": \"Successfully Completed Transaction\", \n \"extra_data\": {}, \n \"detail\": \"Transaction successful\", \n \"id\": 5033 \n}\n
\n\nError Response:
\n\n{ \n \"status\": false, \n \"error_code\": \"4000\", \n \"message\": \"Can't fulfill request\", \n \"error\": \"client_error\", \n \"details\": \"Customer not found.\", \n \"error_data\": {}, \n \"state\": \"Error\" \n}\n
"},{"location":"Internet/hashcnet/v1/","title":"HashCNet V1","text":"This document provides the necessary information for interacting with the HashCNet APIs, detailing the required parameters and expected responses for both fetching user details and processing payments.
Note: Below is the list of ISPs under HashCNet and their service slugs:
"},{"location":"Internet/hashcnet/v1/#askina-askina","title":"Askina: askina","text":""},{"location":"Internet/hashcnet/v1/#kshireshwar-network-kshireshwar-network","title":"Kshireshwar Network: kshireshwar-network","text":""},{"location":"Internet/hashcnet/v1/#life-net-life-net","title":"Life Net: life-net","text":""},{"location":"Internet/hashcnet/v1/#limpid-ict-solution-limpid-ict-solution","title":"Limpid ICT Solution: limpid-ict-solution","text":""},{"location":"Internet/hashcnet/v1/#lnt-infotech-lnt-infotech","title":"LNT Infotech: lnt-infotech","text":""},{"location":"Internet/hashcnet/v1/#mega-cable-net-mega-cable-net","title":"Mega Cable Net: mega-cable-net","text":""},{"location":"Internet/hashcnet/v1/#nepalink-nepalink","title":"Nepalink: nepalink","text":""},{"location":"Internet/hashcnet/v1/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Internet/hashcnet/v1/#user-detail-fetch-api","title":"User Detail Fetch API","text":" - Request URL:
{{base_url}}/api/servicegroup/details/hashcnet/ - Request Method: POST
"},{"location":"Internet/hashcnet/v1/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"reference\": \"\\ unique reference\\ \",\n \"username\": \"pnt_test\",\n \"service_slug\": \"lnt-infotech\" // Service slug from above list\n}\n
"},{"location":"Internet/hashcnet/v1/#response-example","title":"Response Example","text":"\n{\n \"package_name\": \"FOC users / 6M\",\n \"total_amount\": 10,\n \"session_id\": 21,\n \"status\": true\n}\n
"},{"location":"Internet/hashcnet/v1/#payment-api","title":"Payment API","text":" - Request URL:
{{base_url}}/api/servicegroup/commit/hashcnet/ - Request Method: POST
"},{"location":"Internet/hashcnet/v1/#service-params_1","title":"Service Params","text":"\n{\n \"session_id\": 172,\n \"reference\": \"reference123\",\n \"token\": \"Test_token\",\n \"package_name\": \"FOC users / 6M\", // Package name from the service params in detail fetch API\n \"amount\": 1150.00\n}\n
"},{"location":"Internet/hashcnet/v1/#response-example_1","title":"Response Example","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Payment successfully created.\",\n \"credits_consumed\": 1150.0,\n \"credits_available\": 96790035.7550002,\n \"id\": 5884\n}\n
"},{"location":"Internet/hashcnet/v2/","title":"HashCNet V2","text":"This document provides the necessary information for interacting with the HashCNet V2 API, detailing the required parameters and expected responses for fetching user details.
Note: Below is the list of ISPs under HashCNet and their service slugs:
"},{"location":"Internet/hashcnet/v2/#airson-internet-airson-internet","title":"Airson Internet: airson-internet","text":""},{"location":"Internet/hashcnet/v2/#broadband-solutions-broadband-solutions","title":"Broadband Solutions: broadband-solutions","text":""},{"location":"Internet/hashcnet/v2/#everest-wireless-everest-wireless","title":"Everest Wireless: everest-wireless","text":""},{"location":"Internet/hashcnet/v2/#fast-speed-fast-speed","title":"Fast Speed: fast-speed","text":""},{"location":"Internet/hashcnet/v2/#fiberworld-communication-fiberworld-communication","title":"Fiberworld Communication: fiberworld-communication","text":""},{"location":"Internet/hashcnet/v2/#hons-hons","title":"Hons: hons","text":""},{"location":"Internet/hashcnet/v2/#janaki-cable-network-janaki-cable-network","title":"Janaki Cable Network: janaki-cable-network","text":""},{"location":"Internet/hashcnet/v2/#sahaj-network-sahaj-network","title":"Sahaj Network: sahaj-network","text":""},{"location":"Internet/hashcnet/v2/#super-eight-networks-super-eight-networks","title":"Super Eight Networks: super-eight-networks","text":""},{"location":"Internet/hashcnet/v2/#ultra-net-ultra-net","title":"Ultra Net: ultra-net","text":""},{"location":"Internet/hashcnet/v2/#unified-communication-isp-unified-communication-isp","title":"Unified Communication ISP: unified-communication-isp","text":""},{"location":"Internet/hashcnet/v2/#bbn-internet-bbn-internet","title":"BBN Internet: bbn-internet","text":""},{"location":"Internet/hashcnet/v2/#pokhara-internet-lekhnath-pokhara-internet-lekhnath","title":"Pokhara Internet Lekhnath: pokhara-internet-lekhnath","text":""},{"location":"Internet/hashcnet/v2/#vns-vns","title":"VNS: vns","text":""},{"location":"Internet/hashcnet/v2/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"Internet/hashcnet/v2/#user-detail-fetch-api","title":"User Detail Fetch API","text":" - Request URL: {{base_url}}/api/servicegroup/details/hashcnet-v2/
- Request Method: POST
"},{"location":"Internet/hashcnet/v2/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"reference\": \"unique reference\",\n \"username\": \"jeetenaug4\",\n \"service_slug\": \"\\ service_slug\\ \" // Service slug from above list\n}\n
"},{"location":"Internet/hashcnet/v2/#response-example","title":"Response Example","text":"\n{\n \"customer_name\": \"jeetenaug4(23123213)\",\n \"current_plan\": \"Fiber Gold\",\n \"accept_advance_payment\": true,\n \"days_remaining\": 314,\n \"has_due\": \"false\",\n \"plan_detail\": [\n {\n \"duration\": \"1 month(s)\",\n \"duration_title\": \"1 month\",\n \"total_cost\": 1232.0,\n \"duration_code\": \"1\"\n },\n {\n \"duration\": \"3 month(s)\",\n \"duration_title\": \"3 months\",\n \"total_cost\": 7876.0,\n \"duration_code\": \"3\"\n },\n {\n \"duration\": \"6 month(s)\",\n \"duration_title\": \"6 months\",\n \"total_cost\": 15750.0,\n \"duration_code\": \"6\"\n },\n {\n \"duration\": \"12 month(s)\",\n \"duration_title\": \"12 months\",\n \"total_cost\": 15750.0,\n \"duration_code\": \"12\"\n },\n {\n \"duration\": \"custom_2 month(s)\",\n \"duration_title\": \"15 Days\",\n \"total_cost\": 1634.0,\n \"duration_code\": \"custom_2\"\n },\n {\n \"duration\": \"custom_3 month(s)\",\n \"duration_title\": \"60 Days\",\n \"total_cost\": 859.0,\n \"duration_code\": \"custom_3\"\n }\n ],\n \"available_packages\": [\n {\n \"title\": \"Fiber Gold\",\n \"package_code\": 9,\n \"duration\": [\n {\n \"total_cost\": 1232,\n \"duration_code\": \"1\",\n \"duration_title\": \"1 Month\"\n },\n {\n \"total_cost\": 7876,\n \"duration_code\": \"3\",\n \"duration_title\": \"3 Months\"\n },\n {\n \"total_cost\": 15750,\n \"duration_code\": \"6\",\n \"duration_title\": \"6 Months\"\n },\n {\n \"total_cost\": 15750,\n \"duration_code\": \"12\",\n \"duration_title\": \"12 Months\"\n },\n {\n \"total_cost\": 1634,\n \"duration_code\": \"custom_2\",\n \"duration_title\": \"15 Days\"\n },\n {\n \"total_cost\": 859,\n \"duration_code\": \"custom_3\",\n \"duration_title\": \"60 Days\"\n }\n ]\n },\n {\n \"title\": \"FTTH-50Mbps\",\n \"package_code\": 9,\n \"duration\": [\n {\n \"total_cost\": 999,\n \"duration_code\": \"1\",\n \"duration_title\": \"1 Month\"\n },\n {\n \"total_cost\": 2800,\n \"duration_code\": \"3\",\n \"duration_title\": \"3 Months\"\n },\n {\n \"total_cost\": 5300,\n \"duration_code\": \"6\",\n \"duration_title\": \"6 Months\"\n },\n {\n \"total_cost\": 9999,\n \"duration_code\": \"12\",\n \"duration_title\": \"12 Months\"\n },\n {\n \"total_cost\": 13500,\n \"duration_code\": \"custom_1\",\n \"duration_title\": \"12M + 1 IPTV\"\n }\n ]\n },\n {\n \"title\": \"TESTING\",\n \"package_code\": 71,\n \"duration\": [\n {\n \"total_cost\": 2,\n \"duration_code\": \"1\",\n \"duration_title\": \"1 Month\"\n }\n ]\n }\n ],\n \"session_id\": 6466,\n \"status\": true\n}\n
"},{"location":"Internet/hashcnet/v2/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/hashcnet-v2/
Request Method: POST
Service Params:
\n{ \n \"session id\": 6466, \\\\ session id from detail fetch API \n \u201creference\u201d: \u201cunique identifier\u201d, \n \"token\": \"Test token\", \n \"package code\": \u201c9\u201d, \n \u201cduration code\u201d:\u201d1\u201d, \n \u201camount\": 999.00 \n}\n
Response:
\n{ \n \"status\": true, \n \"state\": \"Success\", \n \"message\": \"Successfully Completed Transaction\", \n \"extra data\": {}, \n \"detail\": \"2532\", \n \"credits consumed\": 999.0, \n \"credits available\": 9995285594.37663, \n \"id\": 70704 \n}\n
"},{"location":"Khaltitopup/khaltitopup/","title":"Khalti Topup","text":""},{"location":"Khaltitopup/khaltitopup/#api-endpoint","title":"API Endpoint","text":" - URL:
{{base_url}}/api/use/khalti-topup/ - TYPE: Single Step API
- METHOD: POST
"},{"location":"Khaltitopup/khaltitopup/#service-parameters","title":"Service Parameters","text":"Parameter Description token The token provided for authentication. reference A unique reference for the transaction. amount The amount to be recharged. number Khalti ID to which the top-up is to be done (e.g., 9841234567). remarks Optional field for any additional remarks. \n{\n \"token\": \"token-provided\",\n \"reference\": \"unique-reference\",\n \"amount\": \"amount to be recharged\",\n \"number\": \"Unique Khalti ID to which TOPUP is to be done, eg: 9841234567\",\n \"remarks\": \"Remarks (Optional Field)\"\n}\n
"},{"location":"Khaltitopup/khaltitopup/#regex-patterns","title":"Regex Patterns:","text":"\n\n[\n {\n \"name\": \"NTC\",\n \"slug\": \"ntc\",\n \"pattern\": \"(9[8][46][0-9]{7})\",\n \"error_message\": \"Invalid mobile number\"\n },\n {\n \"name\": \"Ncell\",\n \"slug\": \"ncell\",\n \"pattern\": \"(9[8][0-2][0-9]{7})\",\n \"error_message\": \"Invalid mobile number\"\n },\n {\n \"name\": \"Smartcell\",\n \"slug\": \"smartcell\",\n \"pattern\": \"(9[6][0-9]{8}|9[8][8][0-9]{7})\",\n \"error_message\": \"Invalid mobile number\"\n },\n {\n \"name\": \"NT CDMA\",\n \"slug\": \"nt-cdma\",\n \"pattern\": \"(9[7][4-5][0-9]{7})\",\n \"error_message\": \"Invalid mobile number\"\n },\n {\n \"name\": \"NT Postpaid\",\n \"slug\": \"nt-postpaid\",\n \"pattern\": \"(9[8][5][0-9]{7})\",\n \"error_message\": \"Invalid mobile number\"\n }\n]\n
"},{"location":"Khaltitopup/khaltitopup/#success-response","title":"Success Response","text":"\n{\n \"id\": 3116,\n \"extra_data\": {},\n \"state\": \"Success\",\n \"detail\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"status\": true\n}\n
"},{"location":"Khaltitopup/khaltitopup/#error-response","title":"Error Response","text":"\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": {\n \"user\": [\n \"User does not exist.\"\n ],\n \"http_status_code\": 400\n },\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"Khanepani/khanepani/","title":"Khanepani","text":""},{"location":"Khanepani/khanepani/#khanepani-counters","title":"Khanepani Counters","text":"URL: {{base_url}}/api/servicegroup/counters/khanepani/ Method: POST
Request Body:
\n{\n \"token\": \"token\"\n}\n
Response:
\n{\n \"counters\": [\n {\n \"name\": \"Sandhikharka\",\n \"value\": \"268:sandhikharka-khanepani\"\n },\n {\n \"name\": \"Itahari\",\n \"value\": \"3:itahari-khanepani\"\n }\n ],\n \"status\": true\n}\n
Description: Retrieve a list of available Khanepani counters.
"},{"location":"Khanepani/khanepani/#khanepani-details","title":"Khanepani Details","text":"URL: {{base_url}}/api/servicegroup/details/khanepani/ Method: POST
Request Body:
\n{\n \"month_id\": \"number (1 to 12 inclusive)\",\n \"customer_code\": \"numeric value, e.g., 12\",\n \"counter\": \"one of the 'value' fields from the response above (e.g., 268:sandhikharka-khanepani)\",\n \"token\": \"Provided token\"\n}\n
Response:
\n{\n \"status\": true,\n \"customer_code\": \"1235\",\n \"customer_name\": \"\u092a\u0941\u0930\u094d\u0923 \u0915\u0941\u092e\u093e\u0930\",\n \"address\": \"\u0907\u091f\u0939\u0930\u0940-6, \u0938\u0902\u0917\u0940\u0924 \u091a\u094c\u0915\",\n \"mobile_number\": \"9841123456\",\n \"current_month_dues\": \"3000\",\n \"current_month_discount\": \"50\",\n \"current_month_fine\": \"0\",\n \"total_credit_sales_amount\": \"100\",\n \"total_advance_amount\": \"1000\",\n \"previous_dues\": \"0\",\n \"total_dues\": \"2950\"\n}\n
Description: Fetch details for a specific Khanepani customer, including dues, discounts, and other relevant information.
"},{"location":"Khanepani/khanepani/#khanepani-service-charge","title":"Khanepani Service Charge","text":"URL: {{base_url}}/api/servicegroup/servicecharge/khanepani/
Note: Khanepani service charge is Rs. 5 per transaction.
Request Body:
\n{\n \"counter\": \"Counter Name\",\n \"token\": \"token\",\n \"amount\": \"Amount from detail fetch API\"\n}\n
Response:
\n{\n \"amount\": 600,\n \"service_charge\": 5,\n \"status\": true\n}\n
Description: Calculate the service charge for the specified amount. The service charge applies to every transaction.
"},{"location":"Khanepani/khanepani/#khanepani-payment","title":"Khanepani Payment","text":"URL: {{base_url}}/api/servicegroup/commit/khanepani/ Method: POST
Request Body:
\n{\n \"token\":\"token\",\n \"reference\": \"unique value sent for each request\",\n \"customer_code\": \"numeric value, e.g., 12\",\n \"counter\": \"one of the 'value' fields from the response above (e.g.268:sandhikharka-khanepani)\",\n \"amount\": 5000\n}\n
Note: The amount in the payment API is without the service charge; the charge amount will be deducted from the service account.
Response (Successful Payment):
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 309,\n \"credits_available\": 35456464.966469494,\n \"id\": 78897534\n}\n
Response (Due Amount):
\n{\n \"status\": true,\n \"detail\": {\n \"message\": \"Successful Payment\",\n \"due_amount\": \"1361\"\n },\n \"message\": \"Successfully Completed Transaction\",\n \"id\": 181868,\n \"extra_data\": {},\n \"state\": \"Success\",\n \"due_amount\": \"1361\"\n}\n
Description: Process the payment for the specified amount and handle due amounts accordingly.
"},{"location":"Khanepani/Kukl/Kukl-Details/","title":"KUKL Khanepani Customer Details Fetch","text":""},{"location":"Khanepani/Kukl/Kukl-Details/#api-endpoint","title":"API Endpoint","text":"URL: {{base_url}}/api/servicegroup/details/kukl/
Method: POST
"},{"location":"Khanepani/Kukl/Kukl-Details/#request","title":"Request","text":"The request must include the following body parameters:
"},{"location":"Khanepani/Kukl/Kukl-Details/#important-note","title":"Important Note:","text":" - If
customer_code is provided, the connection_no should not be sent. - If
connection_no is provided, the customer_code should not be sent. - One of these fields, customer_code or connection_no, is required but not both.
"},{"location":"Khanepani/Kukl/Kukl-Details/#example-request-body","title":"Example Request Body:","text":"\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"counter\": \"1114:test-kukl\",\n \"customer_code\": \"1114003014\"\n}\n
or
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"counter\": \"1114:test-kukl\",\n \"connection_no\": \"9352\"\n}\n
"},{"location":"Khanepani/Kukl/Kukl-Details/#response","title":"Response","text":"A successful response will return the following JSON format:
\n{\n \"status\": true,\n \"customer_code\": \"1114013895\",\n \"connection_no\": \"123321323\",\n \"customer_name\": \"RABI MAN MANNANDHAR\",\n \"address\": \"DHOKA BAHAL\",\n \"area_no\": \"27-03-25GHA\",\n \"bill_month\": \"207809\",\n \"current_month_fine\": 0,\n \"total_advance_amount\": 0,\n \"amount\": 141.85,\n \"unapproved_adjustment\": 123.12,\n \"unapproved_penalty\": 23.45,\n \"minimum_payable_amount\": 141.85,\n \"session_id\": 2630\n}\n
"},{"location":"Khanepani/Kukl/Kukl-payment/","title":"KUKL Commit Payment Details","text":""},{"location":"Khanepani/Kukl/Kukl-payment/#api-endpoint","title":"API Endpoint","text":"URL: {{base_url}}/api/servicegroup/commit/kukl/
Method: POST
"},{"location":"Khanepani/Kukl/Kukl-payment/#request","title":"Request","text":"The request must include the following body parameters:
"},{"location":"Khanepani/Kukl/Kukl-payment/#parameters","title":"Parameters:","text":" token: {{token}} (required)session_id: 953 (required)payment_type: \"Bill Payment\" (required)amount: 10 (required)
"},{"location":"Khanepani/Kukl/Kukl-payment/#example-request-body","title":"Example Request Body:","text":"\n{\n \"token\": \"{{token}}\",\n \"session_id\": 953,\n \"payment_type\": \"Bill Payment\",\n \"amount\": 10\n}\n
"},{"location":"Khanepani/Kukl/Kukl-payment/#response","title":"Response","text":"A successful response will return the following JSON format:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"receipt_no\": \"111410781000000063\"\n },\n \"detail\": \"Success\",\n \"credits_consumed\": 1000.0,\n \"credits_available\": -999.0300000000038,\n \"id\": 147494\n}\n
"},{"location":"Khanepani/Kukl/counter/","title":"KUKL Khanepani Counter Details","text":""},{"location":"Khanepani/Kukl/counter/#api-endpoint","title":"API Endpoint","text":"URL: {{base_url}}/api/servicegroup/counters/kukl/
Method: POST
"},{"location":"Khanepani/Kukl/counter/#request","title":"Request","text":"The request should include the following body:
\n{\n \"token\": \"{{token}}\"\n}\n
"},{"location":"Khanepani/Kukl/counter/#response","title":"Response","text":"A successful response will return the following JSON format:
\n{\n \"status\": true,\n \"counters\": [\n {\n \"name\": \"Chettrapati\",\n \"value\": \"1114:test-kukl\"\n }\n ]\n}\n
"},{"location":"MobileTopup/ncell/","title":"Ncell API","text":""},{"location":"MobileTopup/ncell/#overview","title":"Overview","text":"The Ncell API endpoint allows you to perform a single-step transaction. This API requires a POST request and provides information about the success or failure of the transaction.
URL: {{base_url}}/api/use/ncell/ Type: Single Step API Method: POST
"},{"location":"MobileTopup/ncell/#request-parameters","title":"Request Parameters","text":"The following parameters are required in the POST request:
- number: 10-digit mobile number
- token: Authentication token
- reference: Unique reference for the transaction
- amount: Amount between 50 to 25000
"},{"location":"MobileTopup/ncell/#valid-amounts","title":"Valid Amounts","text":" - From 50 to 5000
"},{"location":"MobileTopup/ncell/#request-example","title":"Request Example","text":"\n{\n \"token\": \"Token Provided\",\n \"reference\": \"unique-reference\",\n \"amount\": \"amount\",\n \"number\": \"number(eg:9801234567)\"\n}\n
"},{"location":"MobileTopup/nepal_telecom/","title":"Nepal Telecom (NTC) API","text":"The Nepal Telecom API endpoint allows you to perform a single-step transaction. This API requires a POST request and provides information about the success or failure of the transaction.
"},{"location":"MobileTopup/nepal_telecom/#api-details","title":"API Details","text":" - URL:
{{base_url}}/api/use/ntc/ - Type: Single Step API
- Request Type: POST
"},{"location":"MobileTopup/nepal_telecom/#parameters","title":"Parameters","text":" - number: 10-digit mobile number (NT Prepaid, NT Postpaid, NT CDMA Prepaid & Postpaid)
- token: Authentication token
- reference: Unique reference identifier
- amount: Between 10 to 25,000
"},{"location":"MobileTopup/nepal_telecom/#request-format","title":"Request Format","text":"The request body should be in JSON format:
\n{\n \"token\": \"Token Provided\",\n \"reference\": \"unique-reference\",\n \"amount\": \"amount\",\n \"number\": \"number\"\n}\n
"},{"location":"MobileTopup/nepal_telecom/#response-format","title":"Response Format","text":"\n{\n \"token\": \"Token Provided\",\n \"reference\": \"unique-reference\",\n \"amount\": \"amount\",\n \"number\": \"number\"\n}\n
"},{"location":"PSTN/landline/","title":"PSTN (Landline) API Documentation","text":""},{"location":"PSTN/landline/#overview","title":"Overview","text":"The PSTN (Landline) API allows you to process landline recharge operations. This API supports a single request method and requires specific parameters for successful processing.
"},{"location":"PSTN/landline/#endpoint","title":"Endpoint","text":"URL: {{base_url}}/api/use/landline/ Type: Single Step API Request Method: POST
"},{"location":"PSTN/landline/#request-parameters","title":"Request Parameters","text":" -
number: 8-digit number (area code without 0 and landline number) Example: 15522942 Regex Pattern: (\\[0-9\\]{8}) Error Message: \"Invalid LandLine number\"
-
token: <token-provided>
- reference:
<unique-reference> - amount:
<amount> Amount should be between Rs.10 and Rs.10,000
"},{"location":"PSTN/landline/#request-example","title":"Request Example","text":"\n{\n \"token\": \"token-provided\",\n \"reference\": \"unique-reference\",\n \"amount\": \"amount\",\n \"number\": \"number\"\n}\n
"},{"location":"PSTN/landline/#responses","title":"Responses","text":""},{"location":"PSTN/landline/#success-response","title":"Success Response","text":"\n{\n \"id\": 165,\n \"credits_consumed\": 10.0,\n \"status\": true,\n \"state\": \"Queued\",\n \"message\": \"Your operation has been submitted for processing.\",\n \"credits_available\": 1170\n\n}\n
"},{"location":"PSTN/landline/#unsuccessful-response","title":"Unsuccessful Response","text":"\n{\n \"error_code\": \"1010\",\n \"message\": \"Validation error\",\n \"status\": false,\n \"error_data\": {\n // Present for validation errors (codes 1010, 1011) specifying errors corresponding to fields\n },\n \"details\": \"\"\n}"},{"location":"Rc%20card/rccard/","title":"RC Card API Documentation","text":""},{"location":"Rc%20card/rccard/#overview","title":"Overview","text":"The RC Card API allows you to process recharge operations for various service providers. The API supports different methods for each service, with specific parameters and valid amounts for each.
"},{"location":"Rc%20card/rccard/#endpoint","title":"Endpoint","text":"URL: {{base_url}}/api/use/<method>/ Type: Single Step API Request Method: POST
"},{"location":"Rc%20card/rccard/#methods","title":"Methods","text":" - dishhome-erc
- ntc-erc
- utl-erc (Deprecated)
- smart-erc
- broadlink-erc
- nettv-erc (Deprecated)
"},{"location":"Rc%20card/rccard/#valid-amounts","title":"Valid Amounts","text":" - dishhome-erc: 500, 1000, 2000, 3000, 4000, 5000, 6000, 7000, 9000, 10000
- ntc-erc: 100, 200, 500, 1000
- utl-erc: 100, 250, 500 (This service is discontinued)
- smart-erc: 50, 100, 200
- broadlink-erc: 570, 1300, 2600, 2260
- nettv-erc: 50, 100, 200, 500, 1000 (This service is discontinued)
"},{"location":"Rc%20card/rccard/#request-parameters","title":"Request Parameters","text":"\n{\n \"token\": \"\",\n \"reference\": \"\",\n \"amount\": \"\"\n}"},{"location":"Rc%20card/rccard/#responses","title":"Responses","text":""},{"location":"Rc%20card/rccard/#success-response","title":"Success Response","text":"\n{\n \"id\": 165,\n \"status\": true,\n \"state\": \"Success\",\n \"serial\": \"\",\n \"pin\": \"\",\n \"message\": \"Your operation has been submitted for processing.\",\n \"credits_available\": 1170\n}"},{"location":"Rc%20card/rccard/#unsuccessful-response","title":"Unsuccessful Response","text":"\n{\n \"error_code\": \"1010\",\n \"message\": \"Validation error\",\n \"status\": false,\n \"error_data\": {\n // Present for validation errors (codes 1010, 1011) specifying errors corresponding to fields\n },\n \"details\": \"\"\n}"},{"location":"Ride/cabtm/","title":"12.2 CABTM","text":"Type: Multi-Step API
"},{"location":"Ride/cabtm/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"Request URL: http://uatservices.khalti.com/api/servicegroup/details/cabtm/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"reference\": \"Unique Identifier\",\n \"mobile_number\": \"9779821587036\"\n}\n
Response:
\n{\n \"customer_name\": \"Test Shrestha\",\n \"balance\": 578.56,\n \"mobile_number\": \"+9779821587036\",\n \"status\": true,\n \"dob\": \"1994-09-30\",\n \"role\": \"driver\",\n \"session_id\": 2319\n}\n
Fields:
- customer_name: The name of the customer.
- balance: The current balance of the customer.
- mobile_number: The mobile number of the customer.
- status: Indicates whether the API call was successful (
true). - dob: The date of birth of the customer.
- role: The role of the customer (e.g., \"driver\").
- session_id: The unique session ID for the transaction.
"},{"location":"Ride/cabtm/#2-payment-api","title":"2. Payment API","text":"Request URL: http://uatservices.khalti.com/api/servicegroup/commit/cabtm/
Request Method: POST
Service Params:
\n{\n \"token\": \"\",\n \"mobile_number\": \"9779821587036\",\n \"amount\": \"1708.00\",\n \"reference\": \"Unique Reference\",\n \"session_id\": \"2319\" \n}\n\n\nResponse:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 1205.0,\n \"credits_available\": 9999553668.38,\n \"id\": 36223\n}\n
\n\nFields:
\n\n- status: Indicates whether the API call was successful (
true). \n- state: The state of the transaction (
Success). \n- message: A message indicating the result of the transaction (
Successfully Completed Transaction). \n- extra_data: Any additional data related to the transaction.
\n- detail: Additional details about the payment, including a confirmation message (
Success). \n- credits_consumed: The total credits consumed for this transaction.
\n- credits_available: The total credits available after this transaction.
\n- id: The unique ID associated with the transaction.
\n
"},{"location":"Ride/tootle/","title":"Tottle","text":""},{"location":"Ride/tootle/#12-ride","title":"12. Ride","text":""},{"location":"Ride/tootle/#121-tootle-topup","title":"12.1. Tootle Topup","text":""},{"location":"Ride/tootle/#tootle-fetch-detail-api","title":"Tootle Fetch Detail API","text":"Request URL: {{base_url}}/api/servicegroup/details/tootle/
Request Method: POST
Service Params:
\n{\n \"token\": \"token provided\",\n \"app\": \"client/partner\", \n \"number\": \"registered mobile number\"\n}\n
Note: Choose client for topping up the client application and partner for topping up the partner application.
Regex:
\n[\n {\n \"name\": \"Smart Card Id\",\n \"slug\": \"\",\n \"pattern\": \"^([9][678][0-9]{8})$\",\n \"error_message\": \"Invalid ID\"\n }\n]\n
Response:
\n{\n \"product_identity\": \"D-31\",\n \"status\": true,\n \"gender\": \"Female\",\n \"number\": \"9841579738\",\n \"name\": \"Bina Laxmi Shrestha\"\n}\n
Fields: - product_identity: The unique identity of the product. - status: Indicates whether the API call was successful (true). - gender: The gender of the customer. - number: The registered mobile number of the customer. - name: The name of the customer.
"},{"location":"Ride/tootle/#tootle-commit-api","title":"Tootle Commit API","text":"Request URL: {{base_url}}/api/servicegroup/commit/tootle/
Request Method: POST
Service Params:
\n{\n \"token\": \"token provided\",\n \"product_identity\": \"obtained from detail API\",\n \"number\": \"registered mobile number\",\n \"amount\": \"amount to topup\",\n \"reference\": \"Unique reference id\"\n}\n
Response:
\n{\n \"id\": 3856,\n \"state\": \"Success\",\n \"extra_data\": {},\n \"detail\": {\n \"message\": \"Tootle topped up successfully for user Bina\"\n },\n \"status\": true,\n \"message\": \"Successfully Completed Transaction\"\n}\n
Fields: - id: The unique ID associated with the transaction. - state: The state of the transaction (Success). - extra_data: Any additional data related to the transaction. - detail: Additional details about the top-up, including a confirmation message. - status: Indicates whether the API call was successful (true). - message: A message indicating the result of the transaction (Successfully Completed Transaction).
This documentation provides the details for fetching user information and processing top-ups for the Tootle service.
"},{"location":"Servicescodes/balance_check/","title":"Balance Check API Documentation","text":""},{"location":"Servicescodes/balance_check/#balance-check-api","title":"Balance Check API","text":" - URL: {{base_url}}/api/balance
- Method: GET
"},{"location":"Servicescodes/balance_check/#request-parameters","title":"Request Parameters","text":"\n\n{\n \"token\": \"Provided Token\"\n}\n\n
"},{"location":"Servicescodes/balance_check/#success-response","title":"Success Response","text":"\n\n{\n \"credits_consumed\": 777099.369900001,\n \"credits_available\": 161155.5\n}\n
"},{"location":"Servicescodes/balance_check/#credits-by-date-api","title":"Credits by Date API","text":"URL: {{base_url}}/api/credits/bydate/
Method: POST
Request Parameters
\n\n{\n \"token\": \"\",\n \"date\": \"yy-mm-dd\"\n}"},{"location":"Servicescodes/balance_check/#success-response_1","title":"Success Response","text":"\n\n{\n \"credits_available\": 454135.30317999,\n \"status\": true\n}\n
"},{"location":"Servicescodes/balance_check/#failure-response","title":"Failure Response","text":"\n{\n \"detail\": \"Something Went Wrong\",\n \"status\": false\n}\n
"},{"location":"Servicescodes/balance_check/#credit-request-api","title":"Credit Request API","text":"URL: {{base_url}}/api/public/creditrequest/
\nMethod: POST
\nRequest Parameters
\n\n{\n \"token\": \"provided_token\",\n \"credit\": \"Credit to be requested in float\"\n}\n
"},{"location":"Servicescodes/balance_check/#success-response_2","title":"Success Response","text":"HTTP Status: 200 OK
\n\n{\n \"status\": true,\n \"detail\": \"Credit Requested\"\n}\n
"},{"location":"Servicescodes/balance_check/#error-response","title":"Error Response","text":"HTTP Status: 400
\n\n{\n \"status\": false,\n \"detail\": \"Invalid Credit\"\n}\n
"},{"location":"Servicescodes/balance_check/#mobile-operator-regular-expressions","title":"Mobile Operator Regular Expressions","text":"\n{\n \"^([98][50-9][0-9]{7})$\": \"nt-postpaid\",\n \"^([98][46][0-9]{7})$\": \"ntc\",\n \"^([97][4-5][0-9]{7})$\": \"nt-cdma\",\n \"^([98][0-2][0-9]{7})$\": \"ncell\",\n \"^([96][0-9]{8}|[98][8][0-9]{7})$\": \"smartcell\"\n}\n
"},{"location":"Servicescodes/bulkservice/","title":"BULK SERVICE STATUS LOOKUP API","text":"URL: {{base_url}}/api/service/bulk/status/
METHOD: GET
Service Params:
\n{\n \"token\": \"\",\n \"references\": \"JNK123,JNK124\", # Comma separated references\n \"reference_length\": 2 # Number of references sent\n}\n\n\nResponse:
\n\n{\n \"status\": true,\n \"message\": \"Success\",\n \"detail\": [\n {\n \"status\": true,\n \"state\": \"Success\",\n \"details\": \"Payment made successfully. Account will be activated in few minutes\",\n \"reference\": \"cPCWiH2UPDjy8mjPyPXtPF\",\n \"response_id\": 15845,\n \"amount\": 1400.0\n },\n {\n \"status\": true,\n \"state\": \"Error\",\n \"details\": \"Invalid reference obtained for account\",\n \"reference\": \"JNK2\",\n \"response_id\": 0,\n \"amount\": 0\n },\n {\n \"status\": true,\n \"state\": \"Processing\",\n \"details\": \"\",\n \"reference\": \"8535\",\n \"response_id\": 15686,\n \"amount\": 2000.0\n },\n {\n \"status\": true,\n \"state\": \"Queued\",\n \"details\": \"\",\n \"reference\": \"f309e75f-3101-4139-bfa1-e7dff44e4276\",\n \"response_id\": 15524,\n \"amount\": 3046.0\n }\n ]\n}\n
\n\nNOTE: Always check the state to make success/failure decisions. The list of possible states is listed Previous Page.
"},{"location":"Servicescodes/changelog/","title":"Changelog","text":""},{"location":"Servicescodes/changelog/#change-log","title":"Change Log","text":"Version 7.2, Janaury 9th 2025
- Updated Worldlink docs
Version 7.1, Janaury 9th 2025
- Updated Vianet docs
Version 7.0, December 26 2024
- Added Kukl Docs
Version 6.9, Novemeber 12 2024
- Updated Service layer status
Version 6.8 October 24 2024
- Updated Typo mistake
Version 6.7 October 24 2024
-
Added Bus v2 API
-
Added Max tv
-
Update the bluebook api details
Version 6.6 October 3 2024
- Updated Typo mistake in Khanepani
Version 6.5 September 24 2024
- Shifted Internet Chitrawan Unique Net from Konnect (KCMS) : vns to Chitrawan Unique Net
Version 6.5 September 24 2024
- Added Nettv in Tv Section
Version 6.4 September 12 2024
- Updated Docs
Version 6.3 August 12 2024
- Updated Ncell Topup API. Please refer to 2.2 Ncell
Version 6.2 July 10 2024
- Updated Ncell data API. Please refer to 18/. Ncell Data Pack
- Updated Ntc data API. Please refer to 19/. NTC Data Pack
Version 6.1 June 24 2024
- Updated Shikhar Insurance API. Please refer to 11.26 Arhant Non Life Insurance
Version 6.0 June 18 2024
- Updated NT FTTH API Document.8.21. NT FTTH There is no change in API, updated the Note from \u201cInitial 6 characters are always constant /- ie. 100000\u201d to \u201cInitial 5 characters are always constant /- ie. 10000\u201d.
Version 5.9 June 11 2024
- Added New Service Wifi nepal in 8.44 Wifi Nepal
- Updated the Kaspersky API in 10.1. Kaspersky API
Version 5.8 May 31 2024
- Shifted Internet VNS from 8.42 Vns : vns to 8.25. HashCNet V2
Version 5.7 April 25 2024
- Updated ticket download API for Service Cable car in 21/. Cable Car
Version 5.6 March 26 2024
- Added New Service Cable car in 21/. Cable Car
Version 5.5 March 18 2024
- Updated the package response in 8.43 Dish Home
Version 5.4 Feb 18 2024
- Added the FAQ Section
- Updated the typo mistakes in 8.43 Dish Home
Version 5.3 Feb 15 2024
- Updated the typo mistakes in 8.43 Dish Home
Version 5.2 Feb 8 2024
- Updated the Dish home API 8.43 Dish Home Removed 8.40 Dishhome combo , 8.38. Dishhome ftth, 7.1 Dishhome
Version 5.1 Jan 28 2024
- Updated the typo mistakes in 20.4 Softlab Electricity
Version 5.0 Jan 18 2024
- Added Watermark electricity in the Community Electricity Section. 20.2 Watermark Electricity
- Added Dreamer electricity in the Community Electricity Section. 20.3 Dreamer Electricity
- Added Softlab electricity in the Community Electricity Section. 20.4 SoftLab Electricity
Version 4.9 Jan 10 2024
- Updated the typo mistakes. in 11.18. Arhant Life Insurance
- Added Nepal Insurance in insurance section (11.23) Nepal Insurance
- Added Rastriya Beema Sasthan in insurance section (11.24) Rastriya Beema Sansthan
- Added Surya Jyoti Loan Repayment in insurance section (11.25) Surya Jyoti Loan Repayment
- Added Sun Life Insurance in insurance section (11.26) Sun Life Insurance
Version 4.8 Nov 02 2023
- Clear TV API is obsolete now. Subisu API will be used for clear tv payment. 8.2 Subisu New
Version 4.7 Oct 11 2023
- Ime Life Insurance API has been updated, Please refer to Ime Life Insurance : ime-life-insurance (11.18) for new API.
Version 4.7 Oct 9 2023
- United insurance and Ajod insurance API merge. Please use the United insurance API. United Insurance : united-insurance
Version 4.6 Sept 21 2023
- Added ultranet to 8.25 Ultra Net
Version 4.5 Sept 17 2023
- Added Smart link ISP in internet section (8.28)
- Added Pathibara Internet in internet section (8.6)
Version 4.4 August 29 2023
- Added Rapid Unique Network in internet section (8.41)
- Added Iconwave /- VNS in internet section (8.42)
Version 4.3 August 20 2023
- Added sky internet under times in internet. (8.6.4)
- Updated Chitrawan Unique Net API. Added to Konnect. (8.33)
Version 4.2 August 15 2023
- Lumbini General insurance and Sagarmatha insurance API merge. Please use Sagarmatha insurance API. Sagarmatha Insurance API has been renamed to Sagarmatha Lumbini Insurance.
- Siddhartha insurance and Premier insurance API merge. Please use Siddhartha insurance API. Siddhartha Insurance API has been renamed to Siddhartha Premier Insurance.
Version 4.1 August 14 2023
- Reliance Insurance payment API response updated, added key extra/_data in payment API response.
Version 4.0 July 31 2023
- Prabhu life insurance and Mahalaxmi life insurance API merge. Please use Prabhu LIfe insurance API.
- Prime life insurance and Union life insurance API merge to Himalayan life insurance 11.9. Prime life insurance has been renamed to Himalayan life insurance. Please use Himalayan LIfe insurance API. 11.9
- Himalayan General Insurance and Everest insurance API merge. Please use Himalayan General (HG insurance) insurance API. 11.8
- Sanima General Insurance and GIC insurance API merge. Please use Sanima General insurance API. 11.3
Version 3.9 June 30 2023
- Surya Jyoti API updated (11.5).Surya life insurance and Jyoti life insurance API merge. Please use Surya Jyoti LIfe insurance API.
Version 3.8 June 30 2023
- Subisu API updated (8.2)
Version 3.7 June 20 2023
- Pokhara Internet Lekhnath API added (8.25)
- Asian life insurance API updated (11.18)
Version 3.6 June 16 2023
- Web Network API added (8.10)
- Acme Internet API added (8.33)
Version 3.5 June 1 2023
- Sky broadband API updated. (8.35)
Version 3.4 May 22 2023
- Status code was added
Version 3.3 May 15 2023
- Subisu Internet and Tv is updated to Api based from offline to online
Version 3.2 April 28 2023
- BBN Internet shifted from HashCnet v1 to HashCnet v2
Version 3.1 April 11 2023
- Surya life insurance and Jyoti life insurance API merge. Please use Jyoti LIfe insurance API.
- Sanima life insurance and Reliance life insurance API merge. Please use Reliance LIfe insurance API.
Version 3.1 April 11 2023
- Mero TV and Sky TV is shifter under Times /- TV API
- SKY Cable /- shifted to Times /- TV(7.9) and Times /- Internet (8.6)
- SKY Topup and websurfer top-up service is removed.
Version 3.0 March 29 2023
- Updated Konnect API. Added different usernames.
- Khanepani Charge API is added
- NEA Service charge API added
Version 2.9 March 2 2023
- Updated Chitrawan Unique Net API
- Added hashcnet v2 Under Internet
- These ISP are shifted from hashcnet v1 to hashcnet v2
Airson Internet
Broadband Solutions
Everest Wireless
Fast Speed
Fiberworld Communication
Hons
Janaki Cable Network
Sahaj Network
Super Eight Networks
Ultra Net
Unified Communication Isp
- Bbn Internet is removed
Version 2.8 Feb 19 2023
- Added citizen life insurance (11.21)
- Update on sim tv denomination
Version 2.7 Jan 20 2023
- Shifted Alsiha communication from hash cnet to merosoft.
- Shifted Loop Network to Konnect
- Shifted Fast speed to hash cnet
Version 2.6 Sept 6
- Added GRS Internet
Version 2.5 Aug 5
- Unified Communication, everest wireless changed to HashCNet
- Palsnet, Reliant Technology added under times
Version 2.4 Jul 18
- Added Nt FTTH (8.23)
Version 2.3 Jun 23
- Added IME Life Insurance (11.20)
Version 2.2 Jun 17
- Added Himchuli Electricity (20.1)
- Updated websurfer API (8.6)
Version 2.1, Nov 30
- Askina changed to HashCNet
Version 2.0, May 21
- Alisha Communication API update.
Version 1.9, Jan 7
- Removed 695 denos of SIM TV
Version 1.8, Dec 31
- Added reference parameter in all the multistep/session based API.
Version 1.6, Dec 17
- Added Prime Life Insurance, Sanima Life Insurance, Nepal Life Insurance, Shikhar Insurance, Sanima General Insurance, Mahalaxmi Life Insurance
Version 1.6, Oct 1
- Added P/&G, Jagriti cable in TV payment
Version 1.5, Aug 21
- Update on sim tv denomination
Version 1.4, Aug 21
- Removed denomination below 1000 from dishome
Version 1.3, July 29
- Added Ncell Data Pack API
Version 1.2, July 3
- Service Status Changes
Version 1.1, July 1
- Added Himilayan general Insurance API
- Added Ultranet ISP API
"},{"location":"Servicescodes/dlr/","title":"DLR Sample","text":"\nContent-Type: multipart/form-data\n{\n \"reference\": \"Unique id sent by you\",\n \"amount\": \"amount\",\n \"status\": \"status\",\n \"detail\": \"detail regarding the service\",\n \"response_id\": \"response id from ntc/ncell or other provider\"\n}\n
NOTE ON FIELD VALIDATION : Enforce a length of 50 alphanumeric characters as a default validation unless explicitly mentioned.
"},{"location":"Servicescodes/dlr/#service-layer-state","title":"Service Layer State","text":"HTTP Response Code Status act Remarks 200 Success Check state in response data and proceed based on state Check state in response data and proceed based on state 400 Error Hold Need to check the transaction state to proceed. 404 Error Refund Service not found >= 500 Server error Hold Server is failed to provide the response Third Party should hold the transaction and call lookup api after at least 5 mins to get transaction status to proceed further Other any status code or No status code received Timeout Hold Server is failed to provide the response Third Party should hold the transaction and call lookup api after at least 5 mins to get transaction status to proceed further State Act Description Success Process Transaction Successful. Deduct Client amount Queued Hold Transaction in pending state. Third Party should hold the transaction and call lookup api after at least after 5 mins to get transaction status to proceed further Processing Hold Transaction in pending state. Third Party should hold the transaction and call lookup api after atleast 5 mins to get transaction status to proceed further Expired Refund Transaction not possible. Refund client amount Error Refund Transaction error. Refund Client amount Failed Refund Transaction Error. Refund Client amount. Any other state or no state received Hold Server is failed the provide the response Third Party should hold the transaction and call lookup api after atleast 5 mins to get transaction status to proceed further Timeout Hold Third Party should hold the transaction and call lookup api after atleast 5 mins to get transaction status to proceed further"},{"location":"Servicescodes/faq/","title":"FAQ's","text":""},{"location":"Servicescodes/faq/#frequently-asked-questions","title":"Frequently Asked Questions","text":"1)What is this token and which token should we use? It is a unique secret key that you have to pass along with your request that helps us identify the source of the request.It can be generated from the portal that is provided to you. You can generate two types of token. For testing purpose,you need to generate test token; which is prefixed with TEST and looks something like: TEST:O7QxjFcdueNzAh9aBOsD and for live purpose, generate LIVE token which looks something like : tqZbd7v9ei3iDczA3osT.
2) Why am I getting the response \u2018Problem using the service\u2019 ? It is required that you first request our support team for addition of service. Unless a service is added to your account, you won\u2019t be able to use that service despite fulfilling all the requirements of a legitimate request.
3) Why am I getting \u2018token_not_found\u2019 ? It is because the token sent from your end is not consistent with the token you have generated in your portal. Make sure you send the same token that you have generated.
4) Why am I getting \u2018TEST API not available for this service\u2019 ? There are few services like Movie, flight for which, currently we don\u2019t have a test environment set up. You can use live credential for testing these services. However, be careful while calling the payment API since it issues the tickets for real. Also, make sure you book flights/hotels with dates far ahead of the current date to prevent booking congestion in real time.
5) Why is it that the status of my transaction is in \u2018Processing\u2019 state for so long ? It could be because of the long processing time taken from the service provider. If the status doesn\u2019t change for a long time, you can try refreshing the transaction manually from the portal given to you. If however the issue still persists, you can call our support for details.
6) How do I add balance to my Khalti Service account ? You can add Khalti Service balance by transferring it from your Khalti account. For this, go to the Credit section in your dashboard and select a subsection under it namely \u2018Add Request\u2019. Input the amount of credit to be added under the field Credit and you should see a button \u2018Load Directly from khalti\u2019 pop up at the bottom. Click it, put the OTP and transaction PIN and you should be done.
7) How to generate the UAT token ?
Link - Steps for staging(TEST) service account Login and Token Setup
8) What are the test credentials ?
LINK : TEST CREDENTIALS
"},{"location":"Servicescodes/faq/#error-codes","title":"Error Codes","text":""},{"location":"Servicescodes/faq/#error-codes-and-messages","title":"Error Codes and Messages","text":"Error Code Message 1001 Token not provided 1002 Invalid token 1003 Deleted token is provided 1004 Inactive token is provided 1005 Account associated with token is deleted 1006 Account associated with the token is inactive 1007 Account has expired 1008 Problem using the service 1009 Account doesn't have the permission 1010 Validation error 1011 Validation error 1012 Reference id not provided 1013 Request with duplicate reference id obtained 1014 Parse error 1015 Parse error 1016 Insufficient user credits 1017 Server error 1018 Error while using service 1019 Service in maintenance mode 1020 ERC for the amount could not be obtained 1021 Error from Provider 4000 Can\u2019t fulfill request Response from api
"},{"location":"Servicescodes/faq/#how-the-error-code-and-message-will-be-shown","title":"How the Error Code and Message Will be Shown","text":"If your API responds with an error code, it will be accompanied by a message that provides more context about the issue. Here\u2019s how it could be presented:
\n{\n \"error_code\": \"1002\",\n \"message\": \"Invalid token\"\n}\n
"},{"location":"Servicescodes/lookup/","title":"SERVICE STATUS LOOKUP API","text":"The Service Status Lookup API allows you to check the status of a transaction by providing a reference ID and token. This API is useful for tracking the state of a transaction to determine if it was successful, failed, or if there was an error.
"},{"location":"Servicescodes/lookup/#endpoint","title":"Endpoint","text":"URL: {{base_url}}/api/service/status/
METHOD: GET
"},{"location":"Servicescodes/lookup/#request-parameters","title":"Request Parameters","text":"The request requires the following parameters:
- token: The token provided for authorization.
- reference: The unique reference ID of the transaction for which the status needs to be checked.
Example Request:
\n{\n \"token\": \"ProvidedToken\",\n \"reference\": \"reference id against which status is to be checked\"\n}\n
"},{"location":"Servicescodes/lookup/#responses","title":"Responses","text":""},{"location":"Servicescodes/lookup/#success-response","title":"Success Response","text":"When the transaction is successful, you will receive a response with the following structure:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"original_status\": \"Success\",\n \"details\": \"Successful recharge\",\n \"reference\": \"7068074f-d04f-4262-8d9b-6a171da647b5\",\n \"response_id\": 123647,\n \"amount\": 10.0,\n \"refunded\": false,\n \"refunded_amount\": 0.0,\n \"refunds\": []\n}\n
Fields:
- state: The state of the transaction (
Success). - original_status: The original status of the transaction (
Success). - details: A description of the transaction status, e.g.,
\"Successful recharge\". - reference: The reference ID of the transaction.
- response_id: The unique ID associated with the response.
- amount: The amount involved in the transaction.
- refunded: Indicates if the amount was refunded (
false). - refunded_amount: The amount that was refunded.
- refunds: An array of refund objects, which is empty if no refunds occurred.
"},{"location":"Servicescodes/lookup/#failed-response","title":"Failed Response","text":"When the transaction fails, the response will look like this:
\n{\n \"status\": true,\n \"state\": \"Failed\",\n \"original_status\": \"Error\",\n \"details\": \"rtii\",\n \"reference\": \"813e70aa-889b-4b4b-b4f5-ede459d15a53\",\n \"response_id\": 123611,\n \"amount\": 100.0,\n \"refunded\": false,\n \"refunded_amount\": 0.0,\n \"refunds\": [\n {\n \"created_at\": \"2024-07-15\",\n \"remarks\": \"rtii\",\n \"amount\": 100.0\n }\n ]\n}\n
Fields:
- state: The state of the transaction (
Failed). - original_status: The original status of the transaction (
Error). - details: A description of the failure, e.g.,
\"rtii\". - reference: The reference ID of the transaction.
- response_id: The unique ID associated with the response.
- amount: The amount involved in the transaction.
- refunded: Indicates if the amount was refunded (
false). - refunded_amount: The amount that was refunded.
- refunds: An array of refund objects, each containing:
- created_at: The date when the refund was created.
- remarks: Comments about the refund.
- amount: The amount of the refund.
"},{"location":"Servicescodes/lookup/#failure-response-structure-no-such-transaction-at-our-end","title":"Failure Response Structure (No such Transaction at our end)","text":"If the reference ID is not valid, you will receive:
\n{\n \"status\": false,\n \"error_code\": \"002\",\n \"message\": \"The reference sent is not a valid reference.\",\n \"error\": \"invalid_reference\",\n \"details\": \"\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
Fields:
- status: Indicates whether the API call was successful (
false). - error_code: A code representing the error (
002). - message: A message explaining the error.
- error: The type of error (
invalid_reference). - details: Additional details about the error.
- error_data: An object containing additional error data.
- state: The state of the response (
Error).
"},{"location":"Servicescodes/lookup/#failure-response-structure-transaction-exists-but-failure","title":"Failure Response Structure (Transaction Exists but Failure)","text":"If the transaction exists but has failed, the response will be:
\n{\n \"status\": true,\n \"state\": \"Failed\",\n \"details\": \"Manually Failed\",\n \"reference\": \"Reference_092233\",\n \"response_id\": 10631926,\n \"amount\": 1.0\n}\n
Fields:
- state: The state of the transaction (
Failed). - details: A description of the failure, e.g.,
\"Manually Failed\". - reference: The reference ID of the transaction.
- response_id: The unique ID associated with the response.
- amount: The amount involved in the transaction.
"},{"location":"Servicescodes/lookup/#note","title":"NOTE","text":"Please refer to the state field in the response to determine the success or failure of the transaction, not the status field.
"},{"location":"Servicescodes/statecode/","title":"State List","text":"State Description Action Required Queued Transaction in unconfirmed state. Need to hold client amount. Expired Transaction not possible. Refund client amount. Processing Transaction in unconfirmed state. Need to hold client amount. Error Transaction errored. Refund client amount. Status Error Transaction errored. Refund client amount. Success Transaction Successful. Deduct client amount. Failed Transaction errored. Refund client amount."},{"location":"Servicescodes/statecode/#response-status-handling","title":"Response Status Handling","text":" - status: Check the
status key in the response: - True: The request is submitted successfully.
-
False: There is an issue with the request. Please fix your request.
-
State Handling:
- If the state is Queued or Processing, you will receive the final status of the transaction in the DLR callback later.
- If the state is Success, Failed, or Error, take action based on the state immediately. No need to wait for DLR.
"},{"location":"TV/Prabhutv/","title":"Max TV API Documentation","text":""},{"location":"TV/Prabhutv/#overview","title":"Overview","text":"The Max TV API provides functionality for retrieving details about Max TV services and processing payments. The API consists of two main endpoints: one for fetching service details and another for making payments. These endpoints are designed to facilitate the integration of Max TV services into your application or system.
"},{"location":"TV/Prabhutv/#detail-fetch-api","title":"Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/max-tv/
Request Method: POST
Service Parameters:
\n{\n \"token\": \"\",\n \"customer_id\": \"0000405146\", // Numeric value\n \"reference\": \"\"\n}\n\n\nResponse:
\n\n{\n \"customer_name\": \"vod test All\",\n \"cid_stb_smartcard\": \"0000405146\",\n \"amount\": 600,\n \"tvs\": [\n {\n \"stb_no\": \"6030637000423863\",\n \"smartcard_no\": \"6030637000423863\"\n }\n ],\n \"session_id\": 51,\n \"status\": true\n}\n
\n\nError Response:
\n\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Invalid customer id / stb no. / smartcard no.\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"TV/Prabhutv/#payment-api","title":"Payment API","text":"Request URL:\n{{base_url}}/api/use/max-tv/
\nRequest Method:\nPOST
\nService Parameters:
\n\n{\n \"token\": \"\",\n \"customer_id\": \"0000405146\",\n \"amount\": 100,\n \"session_id\": 51,\n \"reference\": \"\"\n}\n\n\nResponse:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Successful\",\n \"id\": 5035\n}\n
"},{"location":"TV/jagrititv/","title":"Jagriti Cable Network API","text":""},{"location":"TV/jagrititv/#overview","title":"Overview","text":"This document details the APIs for the Jagriti Cable Network service, including endpoints for fetching package information and processing payments.
"},{"location":"TV/jagrititv/#package-fetch-api","title":"Package Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/getpackages/jagriti-national-cable-network/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"type\": \"tv\" // \"tv\" for TV services, \"internet\" for ISP services\n}\n
Response:
\n{\n \"status\": true,\n \"detail\": {\n \"packages\": [\n {\n \"package_name\": \"TV HD Package - 1Month - 1TV\",\n \"amount\": 350\n },\n {\n \"package_name\": \"TV HD Package - 3Month - 1TV\",\n \"amount\": 1050\n },\n {\n \"package_name\": \"TV HD Package - 6Month - 1TV\",\n \"amount\": 1900\n },\n {\n \"package_name\": \"TV HD Package - 12Month - 1TV\",\n \"amount\": 3600\n },\n {\n \"package_name\": \"TV HD Package - 1Month - 2TV\",\n \"amount\": 525\n },\n {\n \"package_name\": \"TV HD Package - 3Month - 2TV\",\n \"amount\": 1575\n },\n {\n \"package_name\": \"TV HD Package - 6Month - 2TV\",\n \"amount\": 2800\n },\n {\n \"package_name\": \"TV HD Package - 12Month - 2TV\",\n \"amount\": 5250\n },\n {\n \"package_name\": \"TV HD Package - 1Month - 3TV\",\n \"amount\": 700\n },\n {\n \"package_name\": \"TV HD Package - 3Month - 3TV\",\n \"amount\": 2100\n },\n {\n \"package_name\": \"TV HD Package - 6Month - 3TV\",\n \"amount\": 3700\n },\n {\n \"package_name\": \"TV HD Package - 12Month - 3TV\",\n \"amount\": 6900\n }\n ]\n }\n}\n
"},{"location":"TV/jagrititv/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/use/jagriti-national-cable-network/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{TOKEN}}\",\n \"reference\": \"{{$guid}}\",\n \"package\": \"TV HD Package - 1Month - 1TV\",\n \"amount\": 350,\n \"stb_or_cas_id\": \"0123456789012345\", // Should be either 11 numbers or 16 numbers\n \"customer_name\": \"abc\",\n \"old_ward_number\": 10,\n \"customer_id\": \"1245\", // Optional\n \"mobile_number_1\": \"9841111111\",\n \"mobile_number_2\": \"9841111111\" // Optional\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 350.0,\n \"credits_available\": 106470545.045,\n \"extra_data\": {\n \"package\": \"TV HD Package - 1Month - 1TV\",\n \"customer_name\": \"12345\",\n \"old_ward_number\": \"10\",\n \"stb_or_cas_id\": \"0123456789012345\",\n \"customer_id\": \"Optional\",\n \"mobile_number_1\": \"9849324652\",\n \"mobile_number_2\": \"9818822421\"\n },\n \"id\": 8234\n}\n
"},{"location":"TV/maxtv/","title":"7.5 Max TV API Documentation","text":""},{"location":"TV/maxtv/#overview","title":"Overview","text":"This document describes the multi-step API for fetching details and processing payments related to Max TV services. It includes request and response formats for both the Detail Fetch API and the Payment API.
"},{"location":"TV/maxtv/#detail-fetch-api","title":"Detail Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/max-tv/ Request Method: POST
"},{"location":"TV/maxtv/#service-params","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"customer_id\": \"0000405146\", // (Numeric value)\n \"reference\": \"unique reference id\"\n}\n
"},{"location":"TV/maxtv/#response","title":"Response","text":"\n{\n \"customer_name\": \"vod test All\",\n \"cid_stb_smartcard\": \"0000405146\",\n \"amount\": 600,\n \"tvs\": [\n {\n \"stb_no\": \"6030637000423863\",\n \"smartcard_no\": \"6030637000423863\"\n }\n ],\n \"session_id\": 51,\n \"status\": true\n}\n
"},{"location":"TV/maxtv/#error-response","title":"Error Response","text":"\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Invalid customer id / stb no. / smartcard no.\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"TV/maxtv/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/use/max-tv/ Request Method: POST
"},{"location":"TV/maxtv/#service-params_1","title":"Service Params","text":"\n{\n \"token\": \"token\",\n \"customer_id\": \"0000405146\",\n \"amount\": 100,\n \"session_id\": 51,\n \"reference\": \"unique reference id\"\n}\n
"},{"location":"TV/maxtv/#response_1","title":"Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Successful\",\n \"id\": 5035\n}\n
"},{"location":"TV/nettv/","title":"Nettv API","text":""},{"location":"TV/nettv/#overview","title":"Overview","text":"The Nettv API allows you to interact with the Nettv service, providing functionality for fetching details, getting package rates, and processing payments. This documentation outlines the available endpoints, methods, and expected responses.
"},{"location":"TV/nettv/#details-fetch","title":"Details Fetch","text":"URL: {{base_url}}/api/servicegroup/details/nettv-v3/ Method: POST
Service Body Params:
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"username\": \"krustykrab\"\n}\n
"},{"location":"TV/nettv/#success-response","title":"Success Response","text":"\n{\n \"status\": true,\n \"stb_list\": [\n {\n \"serial\": \"00226D85984E\"\n },\n {\n \"serial\": \"00226DAB66F1\"\n },\n {\n \"serial\": \"D4226DBB50F4\"\n }\n ],\n \"username\": \"krustykrab\",\n \"session_id\": 27817\n}\n
"},{"location":"TV/nettv/#get-packages","title":"Get Packages","text":"URL: {{base_url}}/api/servicegroup/getpackagerates/nettv-v3/ Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"session_id\": \"25527\",\n \"serial_no\": \"00226D85984E\"\n}\n
"},{"location":"TV/nettv/#success-response_1","title":"Success Response","text":"\n{\n \"status\": true,\n \"username\": \"west\",\n \"stb\": \"00226D86F6DD\",\n \"package_status\": \"inactive\",\n \"expiry_date\": \"\",\n \"package_name\": \"\",\n \"stb_type\": \"primary\",\n \"user_id\": 424981,\n \"package_list\": [\n {\n \"name\": \"Platinum - Introductory 1 month\",\n \"duration\": \"1\",\n \"package_price\": 221.0,\n \"discount\": 0.0,\n \"amount\": 250.0,\n \"package_sales_id\": 123,\n \"package_id\": 1\n },\n {\n \"name\": \"Platinum - Introductory 3 month\",\n \"duration\": \"3\",\n \"package_price\": 663.0,\n \"discount\": 0.0,\n \"amount\": 750.0,\n \"package_sales_id\": 0,\n \"package_id\": 1\n },\n {\n \"name\": \"Platinum - Introductory 12 month\",\n \"duration\": \"12\",\n \"package_price\": 2654.0,\n \"discount\": 0.0,\n \"amount\": 3000.0,\n \"package_sales_id\": 0,\n \"package_id\": 1\n }\n ],\n \"session_id\": 25527\n}\n
"},{"location":"TV/nettv/#payment","title":"Payment","text":"URL: {{base_url}}/api/servicegroup/commit/nettv-v3/ Method: POST
Service Params:
\n{\n \"token\": \"{{token}}\",\n \"package_sales_id\": \"{{package_sales_id}}\",\n \"session_id\": \"{{session_id}}\",\n \"reference\": \"{{$guid}}\"\n}\n
"},{"location":"TV/nettv/#success-response_2","title":"Success Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Transaction Successful\",\n \"credits_consumed\": 250.0,\n \"credits_available\": -220.93,\n \"id\": 130121\n}\n
"},{"location":"TV/p%26g/","title":"P & G Network API","text":""},{"location":"TV/p%26g/#overview","title":"Overview","text":"This document provides details on the APIs for the P & G Network service. It includes endpoints for fetching package information and processing payments.
"},{"location":"TV/p%26g/#package-fetch-api","title":"Package Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/getpackages/png-network/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"package_type\": \"tv\"\n}\n
Response:
\n{\n \"status\": true,\n \"detail\": {\n \"packages\": [\n {\n \"package_name\": \"Silver 1TV - 1 Month\",\n \"amount\": 300.0\n },\n {\n \"package_name\": \"Silver 1TV - 3 Month\",\n \"amount\": 900.0\n },\n {\n \"package_name\": \"Silver 1TV - 6 Month\",\n \"amount\": 1800.0\n },\n {\n \"package_name\": \"Silver 1TV - 12 Month\",\n \"amount\": 3600.0\n },\n {\n \"package_name\": \"Gold HD 1TV - 1 Month\",\n \"amount\": 400.0\n },\n {\n \"package_name\": \"Gold HD 1TV - 3 Month\",\n \"amount\": 1200.0\n },\n {\n \"package_name\": \"Gold HD 1TV - 6 Month\",\n \"amount\": 2400.0\n },\n {\n \"package_name\": \"Gold HD 1TV - 12 Month\",\n \"amount\": 4800.0\n },\n {\n \"package_name\": \"Platinum Full HD 1TV - 1 Month\",\n \"amount\": 500.0\n },\n {\n \"package_name\": \"Platinum Full HD 1TV - 3 Month\",\n \"amount\": 1500.0\n },\n {\n \"package_name\": \"Platinum Full HD 1TV - 6 Month\",\n \"amount\": 3000.0\n },\n {\n \"package_name\": \"Platinum Full HD 1TV - 12 Month\",\n \"amount\": 6000.0\n }\n ]\n }\n}\n
"},{"location":"TV/p%26g/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/use/png-network/
Request Method: POST
Service Params:
\n{\n \"token\": \"{{TOKEN}}\",\n \"reference\": \"{{$guid}}\",\n \"package\": \"Silver 1TV - 1 Month\",\n \"amount\": 300,\n \"user_name\": \"abcdef\", // Either 6 characters or 000{6 characters}\n \"contact_number\": \"9849324652\",\n \"customer_name\": \"abc\"\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Queued\",\n \"detail\": \"Transaction Queued\",\n \"message\": \"Your operation is in queue.\",\n \"credits_consumed\": 300.0,\n \"credits_available\": 106470895.045,\n \"extra_data\": {\n \"package\": \"Silver 1TV - 1 Month\",\n \"user_name\": \"0000abcdef\",\n \"contact_number\": \"9849324652\",\n \"customer_name\": \"abc\"\n },\n \"id\": 8230\n}\n
"},{"location":"TV/simtv/","title":"Sim TV API","text":""},{"location":"TV/simtv/#overview","title":"Overview","text":"The Sim TV API provides functionalities for retrieving user details and processing payments for Sim TV services. It is designed to help you integrate Sim TV functionalities into your application or service. There are two primary endpoints available: one for looking up user details and another for processing payments.
- User Detail API: Retrieve the user's name and due amount.
- Payment API: Process payments for a specified amount.
"},{"location":"TV/simtv/#user-detail-api","title":"User Detail API","text":"URL: {{base_url}}/api/lookup/simtv/
Method: GET
Parameters:
\n{\n \"token\": \"token provided\",\n \"customer_id\": \"customer_id of user, eg: 1000088047\"\n}\n
Success Response:
\n{\n \"status\": true,\n \"data\": {\n \"customer_name\": \"YADAV PRD KHAREL\",\n \"due_amount\": \"0\"\n }\n}\n
Unsuccessful Response:
\n{\n \"status\": false,\n \"error_code\": \"4000\",\n \"message\": \"Can't fulfill request\",\n \"error\": \"client_error\",\n \"details\": \"Invalid information\",\n \"error_data\": {},\n \"state\": \"Error\"\n}\n
"},{"location":"TV/simtv/#payment-api","title":"Payment API","text":"URL: {{base_url}}/api/use/simtv/
Service Parameters:
\n{\n \"customer_id\": \"Customer Id (e.g., 1000159157)\",\n \"token\": \"\",\n \"reference\": \"\",\n \"amount\": \"\"\n}\n\n\nValid Amounts:
\n\n[\n 300, 325, 375, 400, 425, 475, 500, 550, 575, 600, 750, 800, 875, 975, 1000, \n 1050, 1065, 1125, 1190, 1275, 1425, 1440, 1625, 1875, 1900, 1950, 2000, 2125, \n 2250, 2375, 2550, 2875, 3250, 3800, 3900, 4250, 4275, 4500, 4750, 5000, 5100, \n 5175, 5750, 7000, 10000\n]\n
\n\nRegex for Customer ID:
\n\n{\n \"name\": \"Customer ID\",\n \"slug\": \"\",\n \"pattern\": \"([0-9]{10,11})\",\n \"error_message\": \"Invalid customer id\"\n}\n
\n\nRequest:
\n\n{\n \"token\": \"\",\n \"reference\": \"\",\n \"amount\": \"\",\n \"customer_id\": \"\"\n}\n\n\nSuccess Response:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Transaction successful\"\n}\n
\n\nUnsuccessful Response:
\n\n{\n \"error_code\": \"1010\",\n \"message\": \"Validation error\",\n \"status\": false,\n \"error_data\": {},\n \"details\": \"\"\n}\n
"},{"location":"TV/times/","title":"Times API","text":"Below is the list of TV services under Times and their respective service_slug:
"},{"location":"TV/times/#merotv-v2-merotv-v2","title":"Merotv v2 : merotv-v2","text":""},{"location":"TV/times/#sky-tv-sky-tv","title":"Sky TV : sky-tv","text":""},{"location":"TV/times/#multi-step-api","title":"Multi-Step API","text":""},{"location":"TV/times/#1-detail-fetch-api","title":"1. Detail Fetch API","text":"URL: {{base_url}}/api/servicegroup/userlist/times/
METHOD: POST
Service Params:
\n{\n \"token\": \"Account_Token\",\n \"reference\": \"Unique Id sent from your side\",\n \"customer_id\": \"Customer_ID\", // [test customer id : 1000001]\n \"service_slug\": \"service_slug\"\n}\n
RESPONSE:
\n{\n \"customer\": {\n \"cuid\": \"1000001\",\n \"first_name\": \"KC HARI\",\n \"last_name\": \"BIKRAM\",\n \"status\": \"active\"\n },\n \"connection\": [\n {\n \"stb\": \"5001067801\",\n \"status\": \"active\"\n },\n {\n \"stb\": \"5001067803\",\n \"status\": \"active\"\n }\n ],\n \"session_id\": 7106,\n \"status\": true\n}\n
"},{"location":"TV/times/#2-package-fetch-api","title":"2. Package Fetch API","text":"URL: {{base_url}}/api/servicegroup/details/times/
METHOD: POST
Service Params:
\n{\n \"token\": \"\",\n \"stb\": \"\",\n \"session_id\": \"\",\n \"service_slug\": \"\",\n \"reference\": \"\"\n}\n\n\nRESPONSE:
\n\n{\n \"packages\": [\n {\n \"package_id\": \"391\",\n \"package_name\": \"SKY HD+ Monthly (MONTHLY)\",\n \"amount\": 550\n },\n {\n \"package_id\": \"392\",\n \"package_name\": \"FIFA WORLD CUP 2022 (MONTHLY) [AddOn]\",\n \"amount\": 565\n }\n ],\n \"session_id\": 7105,\n \"status\": true\n}\n
"},{"location":"TV/times/#3-payment-api","title":"3. Payment API","text":"URL: {{base_url}}/api/servicegroup/commit/times/
\nMETHOD: POST
\nService Params:
\n\n{\n \"token\": \"Account_Token\",\n \"session_id\": \"session_id from detail fetch API\",\n \"amount\": \"Package Amount from package fetch API\",\n \"package_id\": \"package ID from package fetch API\"\n}\n
\n\nRESPONSE:
\n\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Success\",\n \"credits_consumed\": 790.0,\n \"credits_available\": 9999378747.53,\n \"id\": 42353\n}\n
"},{"location":"antivirus/eset/","title":"Eset Antivirus API","text":""},{"location":"antivirus/eset/#overview","title":"Overview","text":"The Eset Antivirus API is a multi-step API that allows users to retrieve product details and make purchases of antivirus solutions. It consists of two primary endpoints: the Get Detail API for fetching product information and the Purchase API for completing transactions.
"},{"location":"antivirus/eset/#1-get-detail-api","title":"1. Get Detail API","text":"This endpoint retrieves the available Eset antivirus products along with their details.
"},{"location":"antivirus/eset/#request","title":"Request","text":" - Request URL:
{{base_url}}/api/products/eset-antivirus/ - Request Method:
GET - Service Params:
\n{\n \"token\": \"\\ token\\ \"\n}\n
"},{"location":"antivirus/eset/#response","title":"Response","text":"The response will return a JSON object containing the status and an array of product details.
\n{\n \"status\": true,\n \"data\": [\n {\n \"idx\": \"znR2fUJHM8YZ4GFh43fZKC\",\n \"name\": \"eset Mobile Security\",\n \"value\": \"EMS\",\n \"amount\": 900.0\n },\n {\n \"idx\": \"BnF4bGdc7BAzFoA2tSqQGK\",\n \"name\": \"eset Antivirus 1user 1year\",\n \"value\": \"EA11\",\n \"amount\": 900.0\n },\n {\n \"idx\": \"CWcNh6qYEorY4H4kpcqUPk\",\n \"name\": \"eset Antivirus 3user 1year\",\n \"value\": \"EA31\",\n \"amount\": 1800.0\n },\n {\n \"idx\": \"T6USwHFwNcyGLpr5kMqRbU\",\n \"name\": \"eset Antivirus 1user 3 year\",\n \"value\": \"EA13\",\n \"amount\": 2000.0\n },\n {\n \"idx\": \"WgoBqQAxF7TwEzzMYqJNsP\",\n \"name\": \"eset Antivirus 5user 1 year\",\n \"value\": \"EA51\",\n \"amount\": 2800.0\n },\n {\n \"idx\": \"cXSgMtPzCwU2uShVeE2FbJ\",\n \"name\": \"eset Internet Security 1user 1year\",\n \"value\": \"EIS11\",\n \"amount\": 1800.0\n },\n {\n \"idx\": \"Qw7dXmfNxVTBZWXgaCAABj\",\n \"name\": \"eset Internet Security 1user 3year\",\n \"value\": \"EIS13\",\n \"amount\": 3800.0\n },\n {\n \"idx\": \"gSJoYy3PZMqHob8iHGe5Z6\",\n \"name\": \"eset Internet Security 3user 1year\",\n \"value\": \"EIS31\",\n \"amount\": 3600.0\n },\n {\n \"idx\": \"ZBCh49vMaXCzuVzTJjzpV6\",\n \"name\": \"eset Internet Security 5user 1year\",\n \"value\": \"EIS51\",\n \"amount\": 5000.0\n },\n {\n \"idx\": \"hJS2GYFu2B5ELdsKfTXcwk\",\n \"name\": \"eset Smart Security Premium 1user 1year\",\n \"value\": \"ESSP11\",\n \"amount\": 4000.0\n },\n {\n \"idx\": \"YDhbheLfWBmqSFdmxHPeqj\",\n \"name\": \"eset Smart Security Premium 3user 1year\",\n \"value\": \"ESSP31\",\n \"amount\": 5500.0\n },\n {\n \"idx\": \"B7NiUMEoec4s9Pk9cUYCxA\",\n \"name\": \"eset Smart Security Premium 5user 1 year\",\n \"value\": \"ESSP51\",\n \"amount\": 6500.0\n }\n ]\n}\n
"},{"location":"antivirus/eset/#2-purchase-api","title":"2. Purchase API","text":"This endpoint allows users to purchase selected Eset antivirus products.
"},{"location":"antivirus/eset/#request_1","title":"Request","text":" - Request URL:
{{base_url}}/api/use/eset-antivirus/ - Request Method:
POST - Service Params:
\n{\n \"token\": \"\\ token\\ \",\n \"reference\": \"\\ unique identifier for each request\\ \",\n \"amount\": 6500,\n \"value\": \"ESSP51\"\n}\n
"},{"location":"antivirus/eset/#response_1","title":"Response","text":"The response will confirm the transaction and provide a PIN number along with other transaction details.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Your Pin number is '2098'\",\n \"serial\": \"1098\",\n \"pin\": \"2098\",\n \"credits_consumed\": 6500.0,\n \"credits_available\": 106407713.395,\n \"id\": 9733\n}\n
"},{"location":"antivirus/k7/","title":"K7 Antivirus API","text":""},{"location":"antivirus/k7/#overview","title":"Overview","text":"The K7 Antivirus API is a multi-step API that enables users to access product details and process payments for K7 antivirus products. The API includes two primary endpoints: the K7 Product Detail API for retrieving product information and the K7 Product Payment API for handling transactions.
"},{"location":"antivirus/k7/#1-k7-product-detail-api","title":"1. K7 Product Detail API","text":"This endpoint retrieves a list of available K7 antivirus products along with their details.
"},{"location":"antivirus/k7/#request","title":"Request","text":" - Request URL:
{{base_url}}/api/products/k7-antivirus/ - Request Method:
GET - Service Params:
\n{\n \"token\": \"\\ Token\\ \"\n}\n
"},{"location":"antivirus/k7/#response","title":"Response","text":"The response returns a JSON object indicating the status and an array of product details.
\n{\n \"status\": true,\n \"data\": [\n {\n \"idx\": \"NJfrJbEmsewrrEUE4rskhE\",\n \"name\": \"K7 Antivirus Premium 1PC-1Year\",\n \"value\": \"KAP 1PC-1Year\",\n \"amount\": 1000.0\n },\n {\n \"idx\": \"j8rQoSCnqN3jLvVBWqG6s7\",\n \"name\": \"K7 Antivirus Premium 3PC-1Year\",\n \"value\": \"KAP 3PC-1Year\",\n \"amount\": 2000.0\n },\n {\n \"idx\": \"uN89sY9KuGgv4ZCc2btxTM\",\n \"name\": \"K7 Total Security 1PC-1Year\",\n \"value\": \"KTS 1PC-1Year\",\n \"amount\": 1500.0\n },\n {\n \"idx\": \"hHd8YQNfhvtBKAmU64fBNF\",\n \"name\": \"K7 Total Security 1PC-2Year\",\n \"value\": \"KTS 1PC-2Year\",\n \"amount\": 2500.0\n },\n {\n \"idx\": \"DUjRTWf2o7MDYect9z9JfT\",\n \"name\": \"K7 Total Security 3PC-1Year\",\n \"value\": \"K7 Total Security 3PC-1Year\",\n \"amount\": 3000.0\n },\n {\n \"idx\": \"XJCSYM2hwgJsLiwpj3JtzX\",\n \"name\": \"K7 Total Security 1PC-3Year\",\n \"value\": \"KTS 1PC-3Year\",\n \"amount\": 3000.0\n },\n {\n \"idx\": \"kjyzc2ioAYyzn8Df4FVtGc\",\n \"name\": \"K7 Total Security 5PC-1Year\",\n \"value\": \"KTS 5PC-1Year\",\n \"amount\": 5000.0\n },\n {\n \"idx\": \"U5RLMAEt49jz68ZaeFJ3hU\",\n \"name\": \"K7 Ultimate Security 1PC-1Year\",\n \"value\": \"KUS 1PC-1Year\",\n \"amount\": 2500.0\n },\n {\n \"idx\": \"EMY25yWrtdC7cTDtuih5aY\",\n \"name\": \"K7 Ultimate Security 3PC-1Year\",\n \"value\": \"K7 Ultimate Security 3PC-1Year\",\n \"amount\": 5000.0\n },\n {\n \"idx\": \"S9rgyuRD3upbknVePoJcPP\",\n \"name\": \"K7 Ultimate Security 1PC-3Year\",\n \"value\": \"KUS 1PC-3Year\",\n \"amount\": 5000.0\n },\n {\n \"idx\": \"DQm3YvbKesFzmutm5ymm8M\",\n \"name\": \"K7 Ultimate Security 5Devices-1Year\",\n \"value\": \"KUS 5Devices-1Year\",\n \"amount\": 8500.0\n },\n {\n \"idx\": \"iZJ36Zk4yfMv7x2nVtXNsm\",\n \"name\": \"K7 Mobile Security 1Android Device-1Year\",\n \"value\": \"KMSA Device-1Year\",\n \"amount\": 1000.0\n }\n ]\n}\n
"},{"location":"antivirus/k7/#2-k7-product-payment-api","title":"2. K7 Product Payment API","text":"This endpoint processes the payment for the selected K7 antivirus product.
"},{"location":"antivirus/k7/#request_1","title":"Request","text":" - Request URL:
{{base_url}}/api/use/k7-antivirus/ - Request Method:
POST - Service Params:
\n{\n \"value\": \"KAP 1PC-1Year\", // from detail API\n \"amount\": 1000,\n \"reference\": \"\\ unique identifier for each request\\ \",\n \"token\": \"\\ token\\ \"\n}\n
"},{"location":"antivirus/k7/#response_1","title":"Response","text":"The response will indicate the transaction status and provide the PIN number along with other transaction details.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Your Pin number is 'PinKAP 1PC-1Year92'\",\n \"serial\": \"SerialKAP 1PC-1Year92\",\n \"pin\": \"AP 1PC-1Year01\",\n \"credits_consumed\": 1000.0,\n \"credits_available\": 96496048.0450002,\n \"id\": 7908\n}\n
"},{"location":"antivirus/kaspersky/","title":"Kaspersky Antivirus","text":"This document outlines the API for Kaspersky Antivirus, which includes functionalities for fetching package details and processing payments. It provides request URLs, methods, parameters, and example responses for both the package details fetch and payment APIs.
"},{"location":"antivirus/kaspersky/#kaspersky-antivirus_1","title":"Kaspersky Antivirus","text":"Type: Multi Step API
"},{"location":"antivirus/kaspersky/#1-package-details-fetch-api","title":"1. Package Details Fetch API","text":"Request URL: {{base_url}}/api/servicegroup/details/antivirus-service/a
Request Method: POST
"},{"location":"antivirus/kaspersky/#service-params","title":"Service Params:","text":"\n{ \n \"token\": \"token\" \n}\n
"},{"location":"antivirus/kaspersky/#response","title":"Response:","text":"\n{ \n \"status\": true, \n \"detail\": [ \n { \n \"name\": \"Kaspersky Standard 1 Device 1 Year\", \n \"product_code\": \"KS-1D-1Y\", \n \"price\": 700 \n }, \n { \n \"name\": \"Kaspersky Plus 1 Device 1 Year\", \n \"product_code\": \"KP-1D-1Y\", \n \"price\": 1400 \n }, \n { \n \"name\": \"Kaspersky Standard 3 Devices 1 Year\", \n \"product_code\": \"KS-3D-1Y\", \n \"price\": 1400 \n }, \n { \n \"name\": \"Kaspersky Premium 1 Device 1 Year\", \n \"product_code\": \"KPR-1D-1Y\", \n \"price\": 2100 \n }, \n { \n \"name\": \"Kaspersky Plus 3 Devices 1 Year\", \n \"product_code\": \"KP-3D-1Y\", \n \"price\": 2100 \n }, \n { \n \"name\": \"Kaspersky Premium 3 Devices 1 Year\", \n \"product_code\": \"KPR-3D-1Y\", \n \"price\": 2800 \n } \n ] \n}\n
"},{"location":"antivirus/kaspersky/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/antivirus-service/
Request Method: POST
"},{"location":"antivirus/kaspersky/#service-params_1","title":"Service Params:","text":"\n{ \n \"token\": \"{{token}}\", \n \"product_code\": \"KS-1D-1Y\", \n \"amount\": 700, \n \"name\": \"Dev Dev\", \n \"email\": \"Dev Dev\", \n \"mobile\": \"1234567899\", \n \"reference\": \"{{$guid}}\" \n}\n
"},{"location":"antivirus/kaspersky/#response_1","title":"Response:","text":"\n{ \n \"status\": true, \n \"state\": \"Success\", \n \"message\": \"Successfully Completed Transaction\", \n \"extra_data\": {}, \n \"detail\": \"Transaction Successful\", \n \"credits_consumed\": 700, \n \"credits_available\": 1e+32, \n \"id\": 117671 \n}\n
"},{"location":"antivirus/mcafee/","title":"McAfee Antivirus API","text":""},{"location":"antivirus/mcafee/#overview","title":"Overview","text":"The McAfee Antivirus API is a multi-step API designed for users to access product details and process payments for McAfee antivirus products. This API consists of two main endpoints: the Product Detail API for retrieving product information and the Product Payment API for handling purchases.
"},{"location":"antivirus/mcafee/#1-product-detail-api","title":"1. Product Detail API","text":"This endpoint retrieves a list of available McAfee antivirus products along with their details.
"},{"location":"antivirus/mcafee/#request","title":"Request","text":" - Request URL:
{{base_url}}/api/products/mcafee-antivirus/?token={{token}} - Request Method:
GET - Service Params:
\n{\n \"token\": \"Token\"\n}\n
"},{"location":"antivirus/mcafee/#response","title":"Response","text":"The response returns a JSON object indicating the status and an array of product details.
\n{\n \"status\": true,\n \"data\": [\n {\n \"idx\": \"T8EBDkFt8VenB9ZJMKt7YS\",\n \"name\": \"Mcafee Antivirus 1PC / 1 Year\",\n \"value\": \"MA-1P-1Y\",\n \"amount\": 700.0\n },\n {\n \"idx\": \"FbZxh4eBziQFxLHT73oR7A\",\n \"name\": \"Mcafee Mobile Security 1 Phone / 1 Year\",\n \"value\": \"MMS-1P-1Y\",\n \"amount\": 700.0\n },\n {\n \"idx\": \"9jniFusARPdsYkMGarpRDc\",\n \"name\": \"Mcafee Internet Security 1 Device / 1 Year\",\n \"value\": \"MIS-1D-1Y\",\n \"amount\": 1350.0\n },\n {\n \"idx\": \"nouBj2b7CZuXcipSzf6zsi\",\n \"name\": \"Mcafee Antivirus 3PC / 1 Year\",\n \"value\": \"MA-3P-1Y\",\n \"amount\": 1500.0\n },\n {\n \"idx\": \"gWd9NT4YR6HXLNrCTqPHdV\",\n \"name\": \"Mcafee Total Protection 1 Device / 1 Year\",\n \"value\": \"MTP-1D-1Y\",\n \"amount\": 1550.0\n },\n {\n \"idx\": \"yGz5AJzv3nCjDCt33gw4sW\",\n \"name\": \"Mcafee Internet Security 3 Device / 1 Year\",\n \"value\": \"MIS-3D-1Y\",\n \"amount\": 2500.0\n },\n {\n \"idx\": \"Ussq53tPpygK3795XKnU3D\",\n \"name\": \"Mcafee Total Protection 3 Device / 1 Year\",\n \"value\": \"MTP-3D-1Y\",\n \"amount\": 3150.0\n }\n ]\n}\n
"},{"location":"antivirus/mcafee/#2-product-payment-api","title":"2. Product Payment API","text":"This endpoint processes the payment for the selected McAfee antivirus product.
"},{"location":"antivirus/mcafee/#request_1","title":"Request","text":" - Request URL:
{{base_url}}/api/use/mcafee-antivirus/ - Request Method:
POST - Service Params:
\n{\n \"value\": \"MA-1P-1Y\", // from detail API\n \"amount\": 700,\n \"reference\": \"unique identifier for each request\",\n \"token\": \"token\",\n \"name\": \"Mcafee Antivirus 1PC / 1 Year\"\n}\n
"},{"location":"antivirus/mcafee/#response_1","title":"Response","text":"The response will indicate the transaction status and provide the PIN number along with other transaction details.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Your Pin number is '123545'\",\n \"serial\": \"123545\",\n \"pin\": \"123545\",\n \"credits_consumed\": 700.0,\n \"credits_available\": 9999740618.32,\n \"id\": 33415\n}\n
"},{"location":"antivirus/wardwiz/","title":"Wardwiz Antivirus API","text":""},{"location":"antivirus/wardwiz/#overview","title":"Overview","text":"The Wardwiz Antivirus API is a multi-step API designed to allow users to retrieve product details and process payments for Wardwiz antivirus products. This API includes two main endpoints: the Wardwiz Product Detail API for fetching product information and the Wardwiz Product Payment API for handling transactions.
"},{"location":"antivirus/wardwiz/#1-wardwiz-product-detail-api","title":"1. Wardwiz Product Detail API","text":"This endpoint retrieves a list of available Wardwiz antivirus products along with their details.
"},{"location":"antivirus/wardwiz/#request","title":"Request","text":" - Request URL:
{{base_url}}/api/products/wardwiz-antivirus/?token={{token}} - Request Method:
GET - Service Params:
\n{\n \"token\": \"\\ Token\\ \"\n}\n
"},{"location":"antivirus/wardwiz/#response","title":"Response","text":"The response returns a JSON object indicating the status and an array of product details.
\n{\n \"status\": true,\n \"data\": [\n {\n \"idx\": \"vUHWcYKWR952FuxyncsmiB\",\n \"name\": \"Wardwiz Basic 1 user / 1 year\",\n \"value\": \"WWB11\",\n \"amount\": 700.0\n },\n {\n \"idx\": \"ho4kmG3hbtFAEgTRpaHA54\",\n \"name\": \"Wardwiz Essential 1 user / 1 year\",\n \"value\": \"WWE11\",\n \"amount\": 1300.0\n },\n {\n \"idx\": \"Viwiy6wgTWiPxSbTMu79D9\",\n \"name\": \"Wardwiz Basic 3 user / 1 year\",\n \"value\": \"WWB31\",\n \"amount\": 1300.0\n },\n {\n \"idx\": \"jqF6Ttc9UZ4srB9K5QqMUG\",\n \"name\": \"Wardwiz Essential Plus 1 user / 1 year\",\n \"value\": \"WWEP11\",\n \"amount\": 1500.0\n },\n {\n \"idx\": \"6iTVKEQMyddNDT6apN7y8S\",\n \"name\": \"Wardwiz Essential 3 user / 1 year\",\n \"value\": \"WWE31\",\n \"amount\": 2600.0\n },\n {\n \"idx\": \"iAK3UrBTxHVu5tW2FcKcNS\",\n \"name\": \"Wardwiz Essential Plus 3 user / 1 year\",\n \"value\": \"WWEP31\",\n \"amount\": 3000.0\n }\n ]\n}\n
"},{"location":"antivirus/wardwiz/#2-wardwiz-product-payment-api","title":"2. Wardwiz Product Payment API","text":"This endpoint processes the payment for the selected Wardwiz antivirus product.
"},{"location":"antivirus/wardwiz/#request_1","title":"Request","text":" - Request URL:
{{base_url}}/api/use/wardwiz-antivirus/ - Request Method:
POST - Service Params:
\n{\n \"value\": \"WWEP31\", // from detail API\n \"amount\": 3000,\n \"reference\": \"\\ unique identifier for each request\\ \",\n \"token\": \"\\ token\\ \",\n \"name\": \"Wardwiz Essential Plus 3 user / 1 year\"\n}\n
"},{"location":"antivirus/wardwiz/#response_1","title":"Response","text":"The response will indicate the transaction status and provide the PIN number along with other transaction details.
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Your Pin number is 'PinWEP1234'\",\n \"serial\": \"SerialWWEP1234\",\n \"pin\": \"PinWWEP1234\",\n \"credits_consumed\": 3000.0,\n \"credits_available\": 9999771927.42,\n \"id\": 32303\n}\n
"},{"location":"bluebook/bluebook/","title":"Bluebook API","text":""},{"location":"bluebook/bluebook/#overview","title":"Overview","text":"The Bluebook API allows users to calculate and process bluebook renewals for vehicles. It consists of two main steps: the Calculate API and the Payment API. The Calculate API computes the required renewal charges, while the Payment API handles the transaction based on the results from the Calculate API.
"},{"location":"bluebook/bluebook/#type-multi-step-api","title":"Type: Multi Step API","text":""},{"location":"bluebook/bluebook/#1-calculate-api","title":"1. Calculate API","text":"Request URL: {{base_url}}/api/servicegroup/calculate/bluebook-renewal/
Request Method: POST
Service Params:
\n{\n \"token\": \"token\",\n \"reference\": \"unique reference\",\n \"vehicle_type\": \"vehicle_type\", // 4W, 2W\n \"cc\": \"cc\",\n \"valid_start_date\": \"valid_start_date in Nepali date \",\n \"valid_end_date\": \"valid_end_date in Nepali date \",\n \"manufacture_date\": \"manufacture_date Year only in English Year\",\n \"thirdparty_insurance\": \"True/False\"\n}\n
Response:
\n{\n \"status\": true,\n \"detail\": {\n \"unpaid_tax\": 10000,\n \"unpaid_tax_fine_amt\": 4720.0,\n \"tax_cy\": 0,\n \"tax_fine_cy\": 0.0,\n \"renewal_charge\": 600,\n \"renewal_fine\": 600,\n \"modal_tax\": 4750,\n \"total\": 20670,\n \"service_charge\": 0,\n \"insurance\": 1935,\n \"total_amount\": 22605\n },\n \"session_id\": 25871\n}\n
"},{"location":"bluebook/bluebook/#2-payment-api","title":"2. Payment API","text":"Request URL: {{base_url}}/api/servicegroup/commit/bluebook-renewal/
Request Method: POST
Note: - If thirdparty_insurance is true in the Calculate API, you need to pass document_back_image and document_front_image in the Payment API params. - If thirdparty_insurance is false, you need to pass insurance_paper in the Payment API params.
Service Params:
\n{\n \"token\": \"token\",\n \"session_id\": \"session_id\",\n \"full_name\": \"full name\",\n \"contact_no\": \"contact_no>\",\n \"email\": \"test@test.com\",\n \"pick_location\": \"pick_location\",\n \"city\": \"City\",\n \"vehicle_no\": \"vehicle_no\",\n \"document_back_image\": \"document_back_image\", // base 64 image\n \"document_front_image\": \"document_front_image\", // base 64 image\n \"insurance_paper\": \"insurance_paper\" // base 64 image\n}\n
Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"detail\": \"Transaction Completed.\",\n \"message\": \"Transaction Completed\",\n \"credits_consumed\": 22605.0,\n \"credits_available\": 999999998507583.0,\n \"extra_data\": {\n \"session_id\": \"25871\",\n \"full_name\": \"Test test\",\n \"contact_no\": \"9863636999\",\n \"email\": \"test@khalti.com\",\n \"pick_location\": \"location\",\n \"city\": \"City\",\n \"vehicle_no\": \"11221\",\n \"document_front_image\": \"https://cdn.example.com/media/bluebook/document_front_image_12345.png\",\n \"document_back_image\": \"https://cdn.example.com/media/bluebook/document_back_image_12345.png\"\n },\n \"id\": 126284\n}\n
"},{"location":"datapacks/NcellProduct/","title":"Ncell Data Pack API Documentation","text":""},{"location":"datapacks/NcellProduct/#overview","title":"Overview","text":"The Ncell Data Pack API provides two main functionalities:
-
Get Packages API: Retrieve available Ncell data pack options.
-
Ncell Data Pack Payment API: Process payment for a selected Ncell data pack.
"},{"location":"datapacks/NcellProduct/#1-get-packages-api","title":"1. Get Packages API","text":"Request URL: {{base_url}}/api/servicegroup/getpackages/ncell-product/
Request Method: POST
Service Parameters:
\n{\n \"token\": \"\"\n}"},{"location":"datapacks/NcellProduct/#success-response","title":"Success Response","text":"\n{\n \"status\": true,\n \"detail\": {\n \"packages\": [\n {\n \"priority_no\": 1,\n \"product_name\": \"100 Minute Call Time 1\",\n \"amount\": 50.55,\n \"short_detail\": \"100 Minute Call Time 1\",\n \"product_code\": \"PROD_001_inv\",\n \"description\": \"100 Minute Call Time 1\",\n \"prodcut_type\": \"All Packs\",\n \"validity\": \"1 Day\",\n \"package_priority\": 100\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"Seasonal Call offer 1\",\n \"amount\": 199.99,\n \"short_detail\": \"seasonal call offer\",\n \"product_code\": \"Test_Pr_001\",\n \"description\": \"Seasonal Call offer 1\",\n \"prodcut_type\": \"All Packs\",\n \"validity\": \"7 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 90,\n \"product_name\": \"Ncell Product\",\n \"amount\": 55.0,\n \"short_detail\": \"109\",\n \"product_code\": \"1_day_10min_India\",\n \"description\": \"At just Rs.55, get 15 minutes India talktime valid for 1 day.\",\n \"prodcut_type\": \"Voice Pack\",\n \"validity\": \"10 Days\",\n \"package_priority\": 1\n },\n {\n \"priority_no\": 90,\n \"product_name\": \"1 Day Voice Pack\",\n \"amount\": 10.0,\n \"short_detail\": \"1 Day Voice Pack\",\n \"product_code\": \"S173284\",\n \"description\": \"1 Day Voice Pack\",\n \"prodcut_type\": \"Voice Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n }\n ]\n }\n}\n
"},{"location":"datapacks/NcellProduct/#2-payment","title":"2. Payment","text":""},{"location":"datapacks/NcellProduct/#request-url","title":"Request URL:","text":"{{base_url}}/api/use/ncell-product/
\nRequest Method: POST
"},{"location":"datapacks/NcellProduct/#service-parameters","title":"Service Parameters:","text":"\n{\n \"token\": \"\",\n \"amount\": 98.99,\n \"number\": \"9809399558\",\n \"reference\": \"reference123\",\n \"product_code\": \"Per_Day_300MB\"\n}"},{"location":"datapacks/NcellProduct/#success-response_1","title":"Success Response:","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": \"Transaction successful\",\n \"id\": 7276\n}\n
"},{"location":"datapacks/NcellProduct/#error-response","title":"Error Response","text":"\n{\n \"status\": false,\n \"error_code\": \"001\",\n \"message\": \"The parameters sent are not correct.\",\n \"error\": \"invalid_parameters\",\n \"details\": {\n \"product_code\": \"Invalid Product Code\"\n },\n \"error_data\": {\n \"product_code\": \"Invalid Product Code\"\n },\n \"state\": \"Error\"\n}\n\n
"},{"location":"datapacks/ntcProduct/","title":"NTC Data Pack API Documentation","text":""},{"location":"datapacks/ntcProduct/#overview","title":"Overview","text":"The NTC Data Pack API allows you to:
1. Get Packages: Retrieve a list of available NTC data and voice packs.
2. Process Payment: Make a payment for a selected NTC data or voice pack.
"},{"location":"datapacks/ntcProduct/#get-packages-api","title":"Get Packages API","text":"Request URL: {{base_url}}/api/servicegroup/getpackages/ntc-package/
Request Method: POST
Service Parameters:
\n{\n \"token\": \"token\"\n}\n
"},{"location":"datapacks/ntcProduct/#success-response","title":"Success Response","text":"\n{\n \"status\": true,\n \"detail\": {\n \"packages\": [\n {\n \"priority_no\": 0,\n \"product_name\": \"NT-NT Unlimited Voice/SMS/Data\",\n \"amount\": 20.0,\n \"short_detail\": \"Subscription is valid for one hour from the time of purchase.\",\n \"package_id\": \"20\",\n \"description\": \"\",\n \"product_type\": \"All Pack\",\n \"validity\": \"1 Hour\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 0,\n \"product_name\": \"NT-NT 300 SMS Offer\",\n \"amount\": 60.0,\n \"short_detail\": \"Get NT-NT 300 SMS Offer valid for 28 days just at Rs 60\",\n \"package_id\": \"27\",\n \"description\": \"\",\n \"product_type\": \"Sms Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"120 MB Day Data Pack (6AM - 6PM)\",\n \"amount\": 10.0,\n \"short_detail\": \"Get 120 MB Day Data Pack (6AM - 6PM) Valid for 6AM-6PM just at Rs 10\",\n \"package_id\": \"28\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"1 Day\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"100 MB All Time Data Pack\",\n \"amount\": 15.0,\n \"short_detail\": \"Get 100 MB All Time Data Pack valid for 1 day just at Rs 15\",\n \"package_id\": \"29\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"1 Day\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"250 MB Day Data Pack (6AM - 6PM)\",\n \"amount\": 15.0,\n \"short_detail\": \"Get 250 MB Day Data Pack (6AM - 6PM) valid for 6AM-6PM just at Rs 15\",\n \"package_id\": \"30\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"1 Day\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"250 MB All Time Data Pack\",\n \"amount\": 24.98,\n \"short_detail\": \"Get 250 MB All Time Data Pack valid for 1 day just at Rs 24.98\",\n \"package_id\": \"31\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"1 Day\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"1GB/day Data Pack\",\n \"amount\": 45.0,\n \"short_detail\": \"Get 1GB/day Data Pack valid for 1 day just at Rs 45\",\n \"package_id\": \"32\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"1 Day\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"Unlimited Youtube Pack\",\n \"amount\": 55.0,\n \"short_detail\": \"Get Unlimited Youtube Pack valid for 3 days just for Rs 55\",\n \"package_id\": \"22\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"3 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"Unlimited Facebook Pack\",\n \"amount\": 55.0,\n \"short_detail\": \"Get Unlimited Facebook Pack valid for 3 days just for Rs 55\",\n \"package_id\": \"21\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"3 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"500 MB All Time Data Pack\",\n \"amount\": 60.0,\n \"short_detail\": \"Get 500 MB All Time Data Pack valid for 3 days just at Rs 60\",\n \"package_id\": \"33\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"3 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"800 MB All Time Data Pack\",\n \"amount\": 99.99,\n \"short_detail\": \"Get 800 MB All Time Data Pack valid for 7 days just at Rs 99.99\",\n \"package_id\": \"34\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"7 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"1GB All network+3GB (4G Network only)\",\n \"amount\": 99.99,\n \"short_detail\": \"Get 1GB All network+3GB (4G Network only) valid for 7 days just at Rs 99.99\",\n \"package_id\": \"35\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"5 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"4GB(Main Data) + 1GB/day (Facebook+Youtube) Pack\",\n \"amount\": 179.99,\n \"short_detail\": \"Main data is for all applications and add on data per day is for Facebook and YouTube.\\nValid for 7 days\",\n \"package_id\": \"23\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"7 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"2GB All network+8GB (4G Network only)\",\n \"amount\": 200.0,\n \"short_detail\": \"Get 2GB All network+8GB (4G Network only) valid for 7 days just at Rs 200\",\n \"package_id\": \"36\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"7 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"2.5 GB All Time Data Pack\",\n \"amount\": 280.0,\n \"short_detail\": \"Get 2.5 GB Data valid for 28 days just at Rs 280\",\n \"package_id\": \"38\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"7 GB All Time Data Pack\",\n \"amount\": 499.99,\n \"short_detail\": \"Get 7 GB Data valid for 28 days just at Rs 499.99\",\n \"package_id\": \"39\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"10GB(Main Data) + 1GB/day (Facebook+Youtube) Pack\",\n \"amount\": 598.99,\n \"short_detail\": \"Main data is for all applications and add on data per day is for Facebook and YouTube.\\nValid for 28 days\",\n \"package_id\": \"24\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"16 GB All Time Data Pack\",\n \"amount\": 799.99,\n \"short_detail\": \"Get 16 GB Data valid for 28 days just at Rs 799.99\",\n \"package_id\": \"40\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n },\n {\n \"priority_no\": 1,\n \"product_name\": \"30 GB All Time Data Pack\",\n \"amount\": 1599.99,\n \"short_detail\": \"Get 30 GB Data valid for 28 days just at Rs 1599.99\",\n \"package_id\": \"41\",\n \"description\": \"\",\n \"product_type\": \"Data Pack\",\n \"validity\": \"28 Days\",\n \"package_priority\": 0\n }\n ]\n }\n}\n
"},{"location":"datapacks/ntcProduct/#payment-api","title":"Payment API","text":"Request URL: {{base_url}}/api/servicegroup/use/ntc-package/
Request Method: POST
Service Parameters:
\n\n{\n \"token\": \"token\",\n \"package_id\": \"package_id\",\n \"amount\": \"amount\"\n}\n
"},{"location":"datapacks/ntcProduct/#success-response_1","title":"Success Response:","text":"\n\n{\n \"status\": true,\n \"detail\": {\n \"transaction_id\": \"transaction_id\",\n \"amount\": \"amount\",\n \"package_id\": \"package_id\",\n \"status\": \"success\"\n }\n}\n
"},{"location":"datapacks/ntcProduct/#error-response","title":"Error Response:","text":"\n\n{\n \"status\": false,\n \"detail\": \"Error message describing what went wrong.\"\n}\n
"},{"location":"servicecharge/service-charge/","title":"Service Charges API","text":"This API allows you to create service charges for a specific service by providing relevant details such as the token, service identifier, and amount.
"},{"location":"servicecharge/service-charge/#endpoint","title":"Endpoint","text":"URL: {{base_url}}/api/account/service-charges/ Method: GET
"},{"location":"servicecharge/service-charge/#request-body","title":"Request Body","text":"To create a service charge, you must send a JSON object in the body of the request. The required fields are:
token: The authentication token (string).service_slug: A unique identifier for the service (string).amount: The amount on which the service charge is calculated (numeric).
Example request body:
\n{\n \"token\": \"your_auth_token\",\n \"service_slug\": \"example_service_slug\",\n \"amount\": 500\n}\n
"},{"location":"servicecharge/service-charge/#response","title":"Response","text":"If the request is successful, the response will include a status and the calculated service charge details.
Example response:
\n{\n \"status\": true,\n \"details\": {\n \"amount\": 500,\n \"service_charge\": 5.0\n }\n}\n
"}]}
\ No newline at end of file
diff --git a/docs/servicecharge/service-charge/index.html b/docs/servicecharge/service-charge/index.html
index 9b8614b..f072957 100644
--- a/docs/servicecharge/service-charge/index.html
+++ b/docs/servicecharge/service-charge/index.html
@@ -3140,7 +3140,7 @@ Service Charges APIEndpoint¶
URL: {{base_url}}/api/account/service-charges/
-Method: POST
+Method: GET
Request Body¶
To create a service charge, you must send a JSON object in the body of the request. The required fields are:
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
index 410632f..ca460f4 100644
Binary files a/docs/sitemap.xml.gz and b/docs/sitemap.xml.gz differ