Skip to content

Commit

Permalink
Merge pull request #26 from om-ghimire/main
Browse files Browse the repository at this point in the history
update Bluebook api docs, added Max Tv and made minior changes in docs
  • Loading branch information
omG-himire authored Oct 24, 2024
2 parents e52c1dd + db36a9a commit c5dd1c1
Show file tree
Hide file tree
Showing 16 changed files with 556 additions and 58 deletions.
12 changes: 6 additions & 6 deletions content/Electricity/nea.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This document provides details on how to interact with the Electricity Payment A
}
</code></pre>

### Success Response
#### Success Response
<pre><code class="json">
{
"status": true,
Expand All @@ -36,7 +36,7 @@ This document provides details on how to interact with the Electricity Payment A
}
</code></pre>

**2. Get details API**
## 2. Get details API

**URL**:``{{url}}/api/servicegroup/details/nea/``

Expand All @@ -56,7 +56,7 @@ This document provides details on how to interact with the Electricity Payment A

**Note : Sc\_no : 3 alphanumeric string separated by dot.**

## Success Response
### Success Response
<pre><code class="json">
{
"session_id": 5,
Expand Down Expand Up @@ -90,7 +90,7 @@ This document provides details on how to interact with the Electricity Payment A
+ Partial payments are allowed.


**3**.**Get service charge**
## 3. Get service charge

**URL**:`` {{url}}/api/servicegroup/servicecharge/nea/``

Expand All @@ -105,7 +105,7 @@ This document provides details on how to interact with the Electricity Payment A
}
</code></pre>

## Success Response
### Success Response
<pre><code class="json">
{
"service_charge": 5.0,
Expand All @@ -121,7 +121,7 @@ Calculate the service charge for the payment amount. The service charge applies
- 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.

**4**. **Make Payment**
## 4. Make Payment

**URL**: ``{{url}}/api/servicegroup/commit/nea/``

Expand Down
1 change: 1 addition & 0 deletions content/Khanepani/khanepani.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ Calculate the service charge for the specified amount. The service charge applie
**Request Body:**
<pre><code class="json">
{
"token":"token",
"reference": "unique value sent for each request",
"customer_code": "numeric value, e.g., 12",
"counter": "one of the 'value' fields from the response above (e.g.268:sandhikharka-khanepani)",
Expand Down
12 changes: 6 additions & 6 deletions content/PSTN/landline.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ The PSTN (Landline) API allows you to process landline recharge operations. This

### Request Example


<pre><code class="json">
{
"token": "<token-provided>",
"reference": "<unique-reference>",
"amount": "<amount>",
"number": "<number>"
"token": "token-provided",
"reference": "unique-reference",
"amount": "amount",
"number": "number"
}

</code></pre>
## Responses
### Success Response

Expand Down
12 changes: 11 additions & 1 deletion content/Servicescodes/changelog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
## **Change Log**
**Version 6.6 September 24 2024**

**Version 6.7 October 24 2024**

* Added Max tv

* Update the bluebook api details

**Version 6.6 October 3 2024**

* Updated Tyo mistake in Khanepani


**Version 6.5 September 24 2024**

* Shifted Internet Chitrawan Unique Net from Konnect (KCMS) : vns to Chitrawan Unique Net
Expand Down
82 changes: 82 additions & 0 deletions content/TV/maxtv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# 7.5 Max TV API Documentation

## Overview

This document describes the multi-step API for fetching details and processing payments related to Max TV services. It includes request and response formats for both the Detail Fetch API and the Payment API.

## Detail Fetch API

**Request URL:** `{{base_url}}/api/servicegroup/details/max-tv/`
**Request Method:** POST

### Service Params

<pre><code class="json">
{
"token": "token",
"customer_id": "0000405146", // (Numeric value)
"reference": "unique reference id"
}
</code></pre>

### Response

<pre><code class="json">
{
"customer_name": "vod test All",
"cid_stb_smartcard": "0000405146",
"amount": 600,
"tvs": [
{
"stb_no": "6030637000423863",
"smartcard_no": "6030637000423863"
}
],
"session_id": 51,
"status": true
}
</code></pre>

### Error Response

<pre><code class="json">
{
"status": false,
"error_code": "4000",
"message": "Can't fulfill request",
"error": "client_error",
"details": "Invalid customer id / stb no. / smartcard no.",
"error_data": {},
"state": "Error"
}
</code></pre>

## Payment API

**Request URL:** `{{base_url}}/api/use/max-tv/`
**Request Method:** POST

### Service Params

<pre><code class="json">
{
"token": "token",
"customer_id": "0000405146",
"amount": 100,
"session_id": 51,
"reference": "unique reference id"
}
</code></pre>

### Response

<pre><code class="json">
{
"status": true,
"state": "Success",
"message": "Successfully Completed Transaction",
"extra_data": {},
"detail": "Successful",
"id": 5035
}
</code></pre>
6 changes: 3 additions & 3 deletions content/bluebook/bluebook.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ The Bluebook API allows users to calculate and process bluebook renewals for veh
"reference": "unique reference",
"vehicle_type": "vehicle_type", // 4W, 2W
"cc": "cc",
"valid_start_date": "valid_start_date",
"valid_end_date": "valid_end_date",
"manufacture_date": "manufacture_date",
"valid_start_date": "valid_start_date in Nepali date ",
"valid_end_date": "valid_end_date in Nepali date ",
"manufacture_date": "manufacture_date Year only in English Year",
"thirdparty_insurance": "True/False"
}
</code></pre>
Expand Down
6 changes: 3 additions & 3 deletions content/datapacks/NcellProduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Ncell Data Pack API provides two main functionalities:

2. **Ncell Data Pack Payment API**: Process payment for a selected Ncell data pack.

### Get Packages API
## 1. Get Packages API

**Request URL:**
`{{base_url}}/api/servicegroup/getpackages/ncell-product/`
Expand All @@ -24,7 +24,7 @@ The Ncell Data Pack API provides two main functionalities:

</code></pre>


### Success Response
<pre><code class="json">
{
"status": true,
Expand Down Expand Up @@ -79,7 +79,7 @@ The Ncell Data Pack API provides two main functionalities:
}
</code></pre>

## Ncell Data Pack Payment API
## 2. Payment

### Request URL:
```{{base_url}}/api/use/ncell-product/```
Expand Down
Loading

0 comments on commit c5dd1c1

Please sign in to comment.