Data Script API Gateway Documentation

Base URL

https://yourdomain.com/api/mtn.php

Request Method

POST

Content Type

Content-Type: application/json

Response Format

All responses are returned in JSON format.

Success Response

{
    "success": true,
    "data": {}
}

Error Response

{
    "success": false,
    "message": "Error description"
}

1. Data Gifting

Transfer a data bundle from one MTN subscriber to another.

Request

{
    "action": "gift",
    "sender": "2348012345678",
    "receiver": "2348098765432",
    "bundle_id": "100MB"
}

Parameters

Example Response

{
    "success": true,
    "data": {
        "status": "SUCCESS",
        "transactionId": "TX123456789"
    }
}

2. Customer Data Share

Add a consumer to a provider's data sharing group.

Request

{
    "action": "datashare",
    "provider": "2348012345678",
    "consumer": "2348098765432"
}

Parameters

3. Activate Data Share Provider

Activate a provider for data sharing.

Request

{
    "action": "activate",
    "provider": "2348012345678"
}

Parameters

4. Check Data Share Eligibility

Verify whether a subscriber is eligible for data sharing.

Request

{
    "action": "eligibility",
    "provider": "2348012345678"
}

Parameters

5. Customer Summary

Retrieve customer sharing information and summary.

Request

{
    "action": "summary",
    "customer_id": "2348012345678"
}

Parameters

6. Data Transfer

Transfer data allocation between MTN customers.

Request

{
    "action": "transfer",
    "sender": "2348012345678",
    "receiver": "2348098765432",
    "amount": "500"
}

Parameters

7. Transaction Status

Retrieve the status of a previous transaction.

Request

{
    "action": "status",
    "transaction_id": "TX123456789"
}

Parameters

HTTP Status Codes

Notes