diff --git a/docs/search/search_index.json b/docs/search/search_index.json
index 58640662..a176c548 100644
--- a/docs/search/search_index.json
+++ b/docs/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Khalti Services Documentation","text":""},{"location":"#version-83","title":"Version 8.3","text":""},{"location":"#last-update-14th-jan-2026","title":"Last Update 14th Jan , 2026","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
"},{"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}}\\\",\\\"fullName1\\\":\\\"test trest A\\\",\\\"nationality\\\":\\\"nepali\\\",\\\"age1\\\":\\\"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":"CDSC/details/","title":"CDSC Details API","text":""},{"location":"CDSC/details/#overview","title":"Overview","text":"This API provides renewal details for Meroshare and Demat services for a given client code and selected DP. It returns expiry dates, pricing, allowed duration, and consumer identification information.
URL: {{base_url}}/api/servicegroup/details/cdsc/ Type: Details API Method: POST
"},{"location":"CDSC/details/#request-parameters","title":"Request Parameters","text":"The following parameters are required in the POST request:
- token: Authentication token (required)
- reference: Unique transaction reference (required)
- client_code: BOID or Client ID (required)
- payment_type: Type of service to renew (
\"Meroshare\", \"Demat\" or \"Both\") - service_slug: DP slug from the
/info/cdsc/ API (required)
"},{"location":"CDSC/details/#request-example","title":"Request Example","text":"\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"client_code\": \"00063951\",\n \"payment_type\": \"Both\",\n \"service_slug\": \"nic-asia-bank-limited-13700\"\n}\n
"},{"location":"CDSC/details/#success-response-format","title":"Success Response Format","text":"\n{\n \"consumer_name\": \"BAL SHANKER THAPA RESHMI\",\n \"dp_name\": \"NIBL ACE CAPITAL LIMITED\",\n \"meroshare_renew\": {\n \"amount\": 5,\n \"max_year\": 5,\n \"min_year\": 1,\n \"expiry_date\": \"Jan 6, 2054 3:35:24 PM\"\n },\n \"demat_renew\": {\n \"amount\": 10,\n \"max_year\": 20,\n \"min_year\": 1,\n \"expiry_date\": \"2093-03-31\"\n },\n \"session_id\": 9075,\n \"status\": true\n}\n
"},{"location":"CDSC/dp-counter/","title":"CDSC Info API","text":""},{"location":"CDSC/dp-counter/#overview","title":"Overview","text":"This API provides a list of available DPs (Depository Participants) and supported payment types. It is typically used to populate selection options before initiating a transaction.
URL: {{base_url}}/api/servicegroup/info/cdsc/ Type: Info API Method: POST
"},{"location":"CDSC/dp-counter/#request-parameters","title":"Request Parameters","text":"The following parameters are required in the POST request:
- token: Authentication token (required)
- reference: Unique reference ID (GUID format recommended)
"},{"location":"CDSC/dp-counter/#request-example","title":"Request Example","text":"\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\"\n}\n
"},{"location":"CDSC/dp-counter/#success-response-format","title":"Success Response Format","text":"\n{\n \"dp_list\": [\n {\n \"name\": \"Global Ime Capital Limited (11200)\",\n \"slug\": \"global-ime-capital-limited-11200\"\n },\n {\n \"name\": \"Magnet Securities and Investment Company (22200)\",\n \"slug\": \"magnet-securities-and-investment-company-22200\"\n },\n {\n \"name\": \"Nic Asia Bank Limited (13700)\",\n \"slug\": \"nic-asia-bank-limited-13700\"\n },\n {\n \"name\": \"Sanima Bank Ltd (15800)\",\n \"slug\": \"sanima-bank-ltd-15800\"\n },\n {\n \"name\": \"Sumeru Securities Private Limited (14200)\",\n \"slug\": \"sumeru-securities-private-limited-14200\"\n }\n ],\n \"payment_types\": [\n \"Meroshare\",\n \"Demat\",\n \"Both\"\n ]\n}\n
"},{"location":"CDSC/payment/","title":"CDSC Commit API","text":""},{"location":"CDSC/payment/#overview","title":"Overview","text":"This API confirms and completes the renewal transaction for Meroshare and/or Demat services, based on details received from the /details/cdsc/ API. It requires a valid session ID and renewal year inputs and deducts credits upon successful renewal.
URL: {{base_url}}/api/servicegroup/commit/cdsc/ Type: Commit API Method: POST
"},{"location":"CDSC/payment/#request-parameters","title":"Request Parameters","text":"The following parameters are required in the POST request:
- token: Authentication token (required)
- session_id: Session ID from the
/details/cdsc/ API - meroshare_renew_year: Number of years to renew Meroshare (optional if
payment_type is not Meroshare) - demat_renew_year: Number of years to renew Demat (optional if
payment_type is not Demat) - amount: Total amount for the renewal (calculated from details API)
- reference: Unique reference ID
"},{"location":"CDSC/payment/#request-example","title":"Request Example","text":"\n{\n \"token\": \"{{token}}\",\n \"session_id\": {{session_id}},\n \"meroshare_renew_year\": 1,\n \"demat_renew_year\": 3,\n \"amount\": 35,\n \"reference\": \"{{$guid}}\"\n}\n
"},{"location":"CDSC/payment/#success-response-format","title":"Success Response Format","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"consumer_name\": \"xxx x xx xx\",\n \"renewed_date\": \"Aug 9, 2025 3:23:11 PM\",\n \"meroshare_expiry_date\": \"Jan 3, 2062 3:35:24 PM\",\n \"demat_expiry_date\": \"\"\n },\n \"detail\": \"Account Renewal Successful\",\n \"credits_consumed\": 25,\n \"credits_available\": xxxxxxx,\n \"id\": 85077\n}\n
"},{"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{ \n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"session_id\":{{session_id}}, // obtained from Detail Fetch API\n \"trip_type\":\"{{trip_type}}\",, // obtained from Detail Fetch API\n \"contact_name\":\"Udeep Shrestha\",\n \"mobile_number\":\"9849324652\",\n \"tickets\":\"[{\\\"passenger_type\\\":\\\"{{passenger_type}}\\\",\\\"passenger_count\\\":passenger_count}]\",// passenger_type obtained from Detail Fetch API\n \"amount\":\"{{price}}\"// obtained from Detail Fetch API * number of passenger count \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/bpc/","title":"BPC API","text":""},{"location":"Electricity/bpc/#overview","title":"Overview","text":"The BPC API allows you to retrieve counter information, get detailed bill data for a consumer, and make payments for due bills. All endpoints require POST requests with authentication tokens.
"},{"location":"Electricity/bpc/#get-counters","title":"Get Counters","text":"URL: {{base_url}}/api/servicegroup/counters/bpc/ Method: POST
"},{"location":"Electricity/bpc/#request-parameters","title":"Request Parameters","text":" - token: Authentication token
"},{"location":"Electricity/bpc/#request-example","title":"Request Example","text":"\n{\n \"token\": \"{{token}}\"\n}\n
"},{"location":"Electricity/bpc/#success-response-format","title":"Success Response Format","text":"\n{\n \"status\": true,\n \"counters\": [\n {\n \"name\": \"BPC Waling\",\n \"value\": \"1:bpc-waling\"\n },\n {\n \"name\": \"BPC Galyang\",\n \"value\": \"3:bpc-galyang\"\n }\n ]\n}\n
"},{"location":"Electricity/bpc/#get-bill-details","title":"Get Bill Details","text":"URL: {{base_url}}/api/servicegroup/details/bpc/ Method: POST
"},{"location":"Electricity/bpc/#request-parameters_1","title":"Request Parameters","text":" - token: Authentication token
- reference: Unique transaction reference
- consumer_no: Consumer number
- counter_code: Counter code from the counters API (e.g., \"1:bpc-waling\")
- consumer_id: Internal consumer ID
"},{"location":"Electricity/bpc/#request-example_1","title":"Request Example","text":"\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"consumer_no\": \"0005.0007.000268\",\n \"counter_code\": \"1:bpc-waling\",\n \"consumer_id\": 1246\n}\n
"},{"location":"Electricity/bpc/#success-response-format_1","title":"Success Response Format","text":"\n{\n \"consumer_name\": \"Til Bahadur Rana\",\n \"consumer_id\": 1549,\n \"address\": \"Syangja-Jagatradevi,8\",\n \"meter_name\": \"Domestic 5 Amp[1001]\",\n \"total_due_amount\": 1251.8,\n \"due_bills\": [\n {\n \"bill_no\": \"131434\",\n \"bill_date\": \"2077/08/21\",\n \"bill_amount\": 471,\n \"description\": \"Bill of 2077/8\",\n \"sur_charge_amount\": 47.1,\n \"total_amount\": 518.1\n },\n {\n \"bill_no\": \"140985\",\n \"bill_date\": \"2077/09/22\",\n \"bill_amount\": 350,\n \"description\": \"Bill of 2077/9\",\n \"sur_charge_amount\": 35,\n \"total_amount\": 385\n },\n {\n \"bill_no\": \"150219\",\n \"bill_date\": \"2077/10/25\",\n \"bill_amount\": 317,\n \"description\": \"Bill of 2077/10\",\n \"sur_charge_amount\": 31.7,\n \"total_amount\": 348.7\n }\n ],\n \"session_id\": 690,\n \"status\": true\n}\n
"},{"location":"Electricity/bpc/#payment","title":"Payment","text":"URL: {{base_url}}/api/servicegroup/commit/bpc/ Method: POST
"},{"location":"Electricity/bpc/#request-parameters_2","title":"Request Parameters","text":" - token: Authentication token
- session_id: Session ID from bill details API
- amount: Amount to pay
- reference: Unique transaction reference
"},{"location":"Electricity/bpc/#request-example_2","title":"Request Example","text":"\n{\n \"token\": \"{{token}}\",\n \"session_id\": 690,\n \"amount\": 1251.8,\n \"reference\": \"{{$guid}}\"\n}\n
"},{"location":"Electricity/bpc/#success-response-format_2","title":"Success Response Format","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"receipt_no\": 425419,\n \"receipt_date\": \"2082/04/19\"\n },\n \"detail\": \"Due bill amount paid successfully. Please download the receipt from Transaction History.\",\n \"credits_consumed\": 1251.8,\n \"credits_available\": 9999.99,\n \"id\": 166079\n}\n
"},{"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/himalaya-insurance/","title":"Himalayan Life Insurance","text":""},{"location":"Insurance/himalaya-insurance/#fetch-policy-details","title":"Fetch Policy Details","text":"POST {{base_url}}/api/servicegroup/details/primelife-insurance/
"},{"location":"Insurance/himalaya-insurance/#request-body","title":"Request Body","text":"\n{\n \"token\": \"{{token}}\",\n \"policy_no\": \"1000002888\",\n \"dob\": \"2049-05-14\",\n \"reference\": \"{{$guid}}\"\n}\n
"},{"location":"Insurance/himalaya-insurance/#response","title":"Response","text":"\n{\n \"premium_amount\": 50723.0,\n \"customer_name\": \"Krishal Koirala\",\n \"address\": \"Ramdhuni-04,\",\n \"total_amount\": 50723.0,\n \"policy_no\": \"ULI2210001020\",\n \"product_name\": \"CHILD ENDOWMENT PLAN\",\n \"fine_amount\": 0.0,\n \"next_due_date\": \"2025-07-08\",\n \"current_due_date\": \"2025-07-08\",\n \"pay_mode\": \"Yearly\",\n \"session_id\": 3464,\n \"status\": true\n}\n
"},{"location":"Insurance/himalaya-insurance/#make-payment","title":"Make Payment","text":"POST {{base_url}}/api/servicegroup/commit/primelife-insurance/
"},{"location":"Insurance/himalaya-insurance/#request-body_1","title":"Request Body","text":"\n{\n \"token\": \"{{token}}\",\n \"session_id\": \"3464\",\n \"reference\": \"{{$guid}}\",\n \"amount\": 50723\n}\n
"},{"location":"Insurance/himalaya-insurance/#response_1","title":"Response","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"assured_name\": \"Krishal Koirala\",\n \"fine_amount\": 0.0,\n \"premium_amount\": 50723.0,\n \"next_due_date\": \"2026-07-08\",\n \"policy_no\": \"ULI2210001020\",\n \"total_amount\": 50723.0,\n \"invoice_number\": \"HLIRP900382830000347\"\n },\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 50723.0,\n \"credits_available\": 99992949999.6798,\n \"id\": 166092\n}\n
"},{"location":"Insurance/metlife/","title":"MetLife API","text":""},{"location":"Insurance/metlife/#overview","title":"Overview","text":"The MetLife API provides insurance policy details and enables payment for premiums. It requires POST requests with authentication tokens.
"},{"location":"Insurance/metlife/#get-policy-details","title":"Get Policy Details","text":"URL: {{base_url}}/api/servicegroup/details/metlife/ Method: POST
"},{"location":"Insurance/metlife/#request-parameters","title":"Request Parameters","text":" - token: Authentication token
- reference: Unique transaction reference
- policy_no: Insurance policy number
- birth_year: Birth year of the insured person
"},{"location":"Insurance/metlife/#request-example","title":"Request Example","text":"\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"policy_no\": \"n9251935\",\n \"birth_year\": 1987\n}\n
"},{"location":"Insurance/metlife/#success-response-format","title":"Success Response Format","text":"\n{\n \"ref_code\": \"37991818D648B4811\",\n \"policy_num\": \"379918\",\n \"mode\": \"MONTHLY\",\n \"insured_name\": \"RAYAMAJHI, JHABINDRA\",\n \"owner_name\": \"RAYAMAJHI, JHABINDRA\",\n \"amount\": 3838,\n \"agent_code\": \"060099000\",\n \"due_date\": \"24-Jan-2024\",\n \"next_due_date\": \"\",\n \"maturity_date\": \"24-Dec-2046\",\n \"contact_number\": \"9867803515\",\n \"address\": \"TOKHA MILAN CHOK-6,\",\n \"session_id\": 41411,\n \"status\": true\n}\n
"},{"location":"Insurance/metlife/#make-payment","title":"Make Payment","text":"URL: {{base_url}}/api/servicegroup/commit/metlife/ Method: POST
"},{"location":"Insurance/metlife/#request-parameters_1","title":"Request Parameters","text":" - token: Authentication token
- session_id: Session ID from the policy details response
"},{"location":"Insurance/metlife/#request-example_1","title":"Request Example","text":"\n{\n \"token\": \"{{token}}\",\n \"session_id\": 41411\n}\n
"},{"location":"Insurance/metlife/#success-response-format_1","title":"Success Response Format","text":"\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {\n \"email\": \"JHABBI1991@GMAIL.COM\",\n \"due_date\": \"24-Jan-2024\",\n \"payment\": \"3838\",\n \"ref_code\": \"37991818D648AC80B\",\n \"pol_number\": \"379918\",\n \"status_msg\": \"SUCCESS\",\n \"status_code\": \"00\",\n \"created_date\": \"01-Feb-2024\",\n \"created_time\": \"17:45:33\",\n \"next_due_date\": \"24-Feb-2024\",\n \"payment_type\": \"PREMIUM\",\n \"updated_date\": \"01-Feb-2024\",\n \"updated_time\": \"17:46:20\",\n \"payment_gateway\": \"KHALTI\"\n },\n \"detail\": \"SUCCESS\",\n \"credits_consumed\": 3838.0,\n \"credits_available\": xxxxx.xxx,\n \"id\": 166088\n}\n
"},{"location":"Insurance/national-life-insurance/","title":"National Life Insurance","text":""},{"location":"Insurance/national-life-insurance/#endpoint-national-life-insurance","title":"Endpoint: National Life Insurance","text":""},{"location":"Insurance/national-life-insurance/#fetch-policy-details","title":"Fetch Policy Details","text":"POST {{base_url}}/api/servicegroup/details/national-life-insurance/
"},{"location":"Insurance/national-life-insurance/#request-body","title":"Request Body","text":"\n{\n \"token\": \"{{token}}\",\n \"policy_no\": \"043003318\",\n \"dob\": \"1985-05-15\",\n \"reference\": \"{{$guid}}\"\n}\n
"},{"location":"Insurance/national-life-insurance/#response","title":"Response","text":"\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\": 3465,\n \"status\": true\n}\n
"},{"location":"Insurance/national-life-insurance/#make-payment","title":"Make Payment","text":"POST {{base_url}}/api/servicegroup/commit/national-life-insurance/
"},{"location":"Insurance/national-life-insurance/#request-body_1","title":"Request Body","text":"\n{\n \"token\": \"{{token}}\",\n \"session_id\": 3465,\n \"amount\": 180,\n \"reference\": \"{{$guid}}\"\n}\n
"},{"location":"Insurance/national-life-insurance/#response_1","title":"Response","text":"\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\": \"2026-07-15\",\n \"policy_no\": \"701000000052\",\n \"total_amount\": 180.0,\n \"invoice_number\": \"RP557828300246\"\n },\n \"detail\": \"Successful Payment\",\n \"credits_consumed\": 180.0,\n \"credits_available\": xxxxxxxxx.6798,\n \"id\": 166094\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:
Life Insurance service_slug Asian Life Insurance asian-life-insurance Ime Life Insurance ime-life-insurance Prabhu Mahalaxmi Life Insurance prabhu-mahalaxmi-life-insurance"},{"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/Arhant%20Insurance/Life%20Loan%20Repayment/arhant-loan-repayment/","title":"Arhant Life Insurance - Loan Repayment","text":""},{"location":"Insurance/Arhant%20Insurance/Life%20Loan%20Repayment/arhant-loan-repayment/#overview","title":"Overview","text":"The Arhant Life Insurance Loan Repayment API allows users to fetch loan repayment details for life insurance policy-linked loans and process the repayment. This is a multi-step API
Supported service_slug for Loan Repayment:
Life Insurance service_slug IME Life Insurance ime-life-insurance-loan-repayment Prabhu Mahalaxmi Loan Repayment prabhu-mahalaxmi-loan-repayment"},{"location":"Insurance/Arhant%20Insurance/Life%20Loan%20Repayment/arhant-loan-repayment/#1-detail-fetch-api-loan-repayment-details","title":"1. Detail Fetch API (Loan Repayment Details)","text":"Request URL: {{base_url}}/api/servicegroup/details/arhant-life-insurance-loan-repayment/
Request Method: POST
Request Payload:
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"policy_no\": \"101000000009\",\n \"insurance_slug\": \"ime-life-insurance-loan-repayment\"\n}\n
Successful Response:
\n{\n \"request_id\": \"101000000009-1988\",\n \"amount\": 81448.86,\n \"properties\": {\n \"interest\": \"5448.86\",\n \"loan_Date\": \"2024-03-14\",\n \"policy_no\": \"101000000009\",\n \"loan_amount\": \"76000.00\",\n \"product_name\": \"Endowment Cum Whole Life Plan - Amulya\",\n \"customer_name\": \"Samjhana Basnet\",\n \"interest_rate\": \"10.50\",\n \"principal_amount\": \"76000.00\"\n },\n \"session_id\": 46973,\n \"status\": true\n}\n
"},{"location":"Insurance/Arhant%20Insurance/Life%20Loan%20Repayment/arhant-loan-repayment/#2-payment-commit-api","title":"2. Payment / Commit API","text":"Request URL: {{base_url}}/api/servicegroup/commit/arhant-life-insurance/
Request Method: POST
Request Payload:
\n{\n \"token\": \"{{token}}\",\n \"reference\": \"{{$guid}}\",\n \"session_id\": 46973,\n \"amount\": \"81448.86\"\n}\n
Successful Response:
\n{\n \"status\": true,\n \"state\": \"Success\",\n \"message\": \"Successfully Completed Transaction\",\n \"extra_data\": {},\n \"detail\": {\n \"reference_code\": \"51080002489|30|RP050798000165\",\n \"amount\": 2442,\n \"message\": \"RP Paid Successfully\",\n \"request_id\": \"51080002489-2007\"\n },\n \"credits_consumed\": 81448.86,\n \"credits_available\": 99988883605.7998,\n \"id\": 178648\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/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":""},{"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:
\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
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:
\n{\n \"status\": true,\n \"message\": \"Successfully Completed Transaction\",\n \"detail\": \"Transaction successful\",\n \"extra_data\": {},\n \"state\": \"Success\",\n \"id\": 1440\n}\n
\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":"