-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #26 from om-ghimire/main
update Bluebook api docs, added Max Tv and made minior changes in docs
- Loading branch information
Showing
16 changed files
with
556 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.