add support to detect dhiraagu and ooredoo packages

2026-05-17 00:25:48 +05:00
parent 93405aade2
commit ccc9e11d55
9 changed files with 781 additions and 3 deletions
@@ -0,0 +1,85 @@
+# Ooredoo API Documentation
+
+Reverse-engineered from traffic captures of the Ooredoo Quick Pay web service (`ooredoo.mv`).
+
+---
+
+## Overview
+
+Ooredoo exposes a number-validation API used by their Quick Pay service to check mobile numbers before payment. It is a single unauthenticated GET request that returns the customer type for a given MSISDN.
+
+The response determines which payment service to offer:
+
+- **PRE** (prepaid) → Raastas top-up only
+- **POST** (postpaid) → Ooredoo Bill Pay only
+- **HYBRID** → both Raastas and Ooredoo Bill Pay (user must choose)
+- No match → number is not an Ooredoo number
+
+---
+
+## Base URL
+
+```
+https://www.ooredoo.mv
+```
+
+---
+
+## Authentication Model
+
+No authentication required. The endpoint is publicly accessible.
+
+---
+
+## Common Request Headers
+
+No special headers are required. Standard HTTP/HTTPS headers apply.
+
+---
+
+## Number Lookup Flow
+
+```
+Client                                       Server
+  |                                            |
+  |  GET /ooredoo-prod/QuickPayPackage/v1/     |
+  |      numberTypeValidation                  |
+  |      ?action=cust_details                  |
+  |      &msisdn=9607654321                    |
+  |------------------------------------------->|
+  |  { custType: "PRE" }                       |
+  |<-------------------------------------------|
+```
+
+---
+
+## Result Interpretation
+
+| `custType` | Meaning |
+|---|---|
+| `"PRE"` | Prepaid — offer **Raastas** top-up |
+| `"POST"` | Postpaid — offer **Ooredoo Bill Pay** |
+| `"HYBRID"` | Both prepaid and postpaid — offer both (user selects) |
+| `null` / absent | Not an Ooredoo number |
+
+---
+
+## Applicable Numbers
+
+Only Ooredoo mobile numbers are returned by this API. Ooredoo numbers in the Maldives start with **9** (7-digit local format, e.g. `9654321`). The API expects the full MSISDN including country code `960`.
+
+---
+
+## Documents
+
+| # | File | Description |
+|---|---|---|
+| 1 | [Number Validation](01-number-validation.md) | Validate an Ooredoo number and determine account type |
+
+---
+
+&nbsp;
+
+---
+
+> **Next →** [Number Validation](01-number-validation.md)