API Reference Data Plans

Data Plans

POST

This service provides a list of all available and active data plans based on the specified Service ID .

Service Information

baseUrl/api/v1/mdataplans
POST
application/json
Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
serviceId String M Corresponding service id for the request type. See "Services" section for the available services and corresponding service codes for each.
key String M Merchant (public) key 

{
    "loginId": "{{loginId}}",
    "serviceId": "D03D",
    "key": "{{publicKey}}"
}
Parameter Name Type M/O Description
statusCode Numeric M Status of the transaction. 00 signifies success
statusDescription String M Corresponding description for the status code. 00=Successful
serviceId String M The serviceId provided in the request body
productId String M The corresponding productId
dataPlan String M An array of all data plans available for the supplied serviceId 
{
    "statusCode": "00",
    "statusDescription": "successful",
    "serviceId": "D04D",
    "dataPlan": [
        {
            "amount": 100,
            "databundle": "110MB",
            "short_description": null,
            "productId": "MTN-110MB-11",
            "validity": "1 Day"
        },
        {
            "amount": 200,
            "databundle": "230MB",
            "short_description": null,
            "productId": "MTN-200MB-2",
            "validity": "1 Day"
        },
        {
            "amount": 350,
            "databundle": "500MB",
            "short_description": null,
            "productId": "MTN-500MB-35",
            "validity": "1 Day"
        },
        {
            "amount": 500,
            "databundle": "500MB + 1GB YouTube Night + 100MB YouTube Music",
            "short_description": null,
            "productId": "MTN-600MB-5",
            "validity": "7 Days"
        },
        {
            "amount": 500,
            "databundle": "1GB Daily Plan + 1.5mins.",
            "short_description": null,
            "productId": "MTN-1GB-11",
            "validity": "1 Day"
        },
        {
            "amount": 500,
            "databundle": "600MB + 2mins + 2 SMS",
            "short_description": null,
            "productId": "MTN-XD500-46",
            "validity": "7 Days"
        },
        {
            "amount": 600,
            "databundle": "1.5GB + 100MB YouTube Music ",
            "short_description": null,
            "productId": "MTN-1-5GB-21",
            "validity": "1 Day"
        },
        {
            "amount": 750,
            "databundle": "2GB",
            "short_description": null,
            "productId": "MTN-2GB 2-75",
            "validity": "2 Days"
        },
        {
            "amount": 750,
            "databundle": "2.5GB Daily Plan",
            "short_description": null,
            "productId": "MTN-2-5GB-D12",
            "validity": "1 Day"
        },
        {
            "amount": 800,
            "databundle": "1GB + 1GB YouTube Night + 100MB YouTube Music",
            "short_description": null,
            "productId": "MTN-1GB-26",
            "validity": "7 Days"
        },
        {
            "amount": 900,
            "databundle": "2.5GB",
            "short_description": null,
            "productId": "MTN-2-5GB-27",
            "validity": "2 Days"
        },
        {
            "amount": 1000,
            "databundle": "3.2GB",
            "short_description": null,
            "productId": "MTN-3GB-72",
            "validity": "2 Days"
        },
        {
            "amount": 1000,
            "databundle": "1.5GB + 1GB YouTube Night + 100MB YouTube Music",
            "short_description": null,
            "productId": "MTN-1-5GB-31",
            "validity": "7 Days"
        },
        {
            "amount": 1500,
            "databundle": "2GB + 2mins + 2GB All Night Streaming + 200MB YouTube Music",
            "short_description": "N1,500 = 2GB+2GB",
            "productId": "MTN-1-5GB-4",
            "validity": "30 Days"
        },
        {
            "amount": 1500,
            "databundle": "1.8GB + 6mins + 5 SMS",
            "short_description": null,
            "productId": "MTN-XD1000-47",
            "validity": "7 Days"
        },
        {
            "amount": 1500,
            "databundle": "3.5GB",
            "short_description": null,
            "productId": "MTN-3-5GB-15",
            "validity": "7 Days"
        },
        {
            "amount": 2000,
            "databundle": "2.7GB + 2mins + 2GB All Night Streaming + 200MB YouTube Music",
            "short_description": null,
            "productId": "MTN-2GB-20",
            "validity": "30 Days"
        },
        {
            "amount": 2500,
            "databundle": "3.5GB + 5mins + 2GB All Night Streaming + 200MB YouTube Music",
            "short_description": null,
            "productId": "MTN-3GB-5",
            "validity": "30 Days"
        },
        {
            "amount": 2500,
            "databundle": "6GB Weekly Plan",
            "short_description": null,
            "productId": "MTN-6GB-29",
            "validity": "7 Days"
        },
        {
            "amount": 3000,
            "databundle": " 2.7GB+15mins",
            "short_description": null,
            "productId": "MTN-XD2000-48",
            "validity": "30 Days"
        },
        {
            "amount": 3500,
            "databundle": "7GB + 2GB All Night Streaming",
            "short_description": null,
            "productId": "MTN-4-5GB-6",
            "validity": "30 Days"
        },
        {
            "amount": 3500,
            "databundle": "11GB Weekly Bundle",
            "short_description": null,
            "productId": "MTN-7GB-73",
            "validity": "7 Days"
        },
        {
            "amount": 4500,
            "databundle": "10GB + 10mins + 2GB All Night Streaming + 200MB YouTube Music",
            "short_description": null,
            "productId": "MTN-6GB-21",
            "validity": "30 Days"
        },
        {
            "amount": 5000,
            "databundle": "20GB Weekly Plan",
            "short_description": null,
            "productId": "MTN-20GB-71",
            "validity": "7 Days"
        },
        {
            "amount": 5500,
            "databundle": "12.5GB + 2GB All Night Streaming + 300MB YouTube Music",
            "short_description": null,
            "productId": "MTN-10GB-22",
            "validity": "30 Days"
        },
        {
            "amount": 5500,
            "databundle": "12.5GB + 36mins + 15 SMS",
            "short_description": null,
            "productId": "MTN-XD5000-49",
            "validity": "7 Days"
        },
        {
            "amount": 6500,
            "databundle": "16.5GB + 10mins + 2GB All Night Streaming + 300MB YouTube Music",
            "short_description": null,
            "productId": "MTN-12GB-12",
            "validity": "30 Days"
        },
        {
            "amount": 7500,
            "databundle": "20GB+2GB YouTube Night+300MB YouTube Music + 25mins.",
            "short_description": null,
            "productId": "MTN-20GB-7",
            "validity": "30 Days"
        },
        {
            "amount": 9000,
            "databundle": "25GB + 4GB All Night Streaming",
            "short_description": null,
            "productId": "MTN-25GB-61",
            "validity": "30 Days"
        },
        {
            "amount": 9000,
            "databundle": "30GB Broadband Router only",
            "short_description": null,
            "productId": "MTN-BR30-30",
            "validity": "30 Days"
        },
        {
            "amount": 11000,
            "databundle": "36GB",
            "short_description": null,
            "productId": "MTN-40GB-9",
            "validity": "30 Days"
        },
        {
            "amount": 14500,
            "databundle": "60GB Monthly Broadband Plan",
            "short_description": null,
            "productId": "MTN-BR45-30",
            "validity": "30 Days"
        },
        {
            "amount": 16000,
            "databundle": "65GB",
            "short_description": null,
            "productId": "MTN-65GB-16",
            "validity": "30 Days"
        },
        {
            "amount": 18000,
            "databundle": "75GB",
            "short_description": null,
            "productId": "MTN-75GB-13",
            "validity": "30 Days"
        },
        {
            "amount": 24000,
            "databundle": "120GB + 5GB Youtube/MS Teams/Zoom (Broadband)",
            "short_description": null,
            "productId": "MTN-BR120GB-24",
            "validity": "30 Days"
        },
        {
            "amount": 35000,
            "databundle": "165GB",
            "short_description": null,
            "productId": "MTN-110GB-30",
            "validity": "30 Days"
        },
        {
            "amount": 40000,
            "databundle": "150GB 2-Month Plan",
            "short_description": null,
            "productId": "MTN-75GB-14",
            "validity": "60 Days"
        },
        {
            "amount": 75000,
            "databundle": "450GB Broadband Plan",
            "short_description": null,
            "productId": "MTN-BR400-3",
            "validity": "90 Days"
        },
        {
            "amount": 90000,
            "databundle": "480GB 3-Month Plan",
            "short_description": null,
            "productId": "MTN-150GB-16",
            "validity": "90 Days"
        }
    ]
}

Data Vend

POST

Service for processing mobile data top-ups on a customer’s phone number via the merchant’s account.

Service Information

baseUrl/api/v1/dvend
POST
application/json
Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
key String M Merchant’s (public) key supplied during integration
requestId String M Unique transaction Id for the request. Maxlength (36characters)
serviceId String M Corresponding service id for the request type. See "Services" section for the available services and corresponding service codes for each.
amount Numeric M Amount with which to top-up amount customers phone Maximum 100000
recipient Numeric M Customers phone number to top-up
date String M Date-time at which the request was sent .
productId String M The identifier of each data bundle e.g MTN-25MB-10.
checksum String M Checksum computed for the request. See "Security: Checksum" section for hash computation steps 

{
    "loginId": "{{loginId}}",
    "key": "{{publicKey}}",
    "requestId": "{{random12digit}}",
    "serviceId": "D04D",
    "amount": 200,
    "productId": "MTN-200MB-2",
    "recipient": "08134045387",
    "date": "{{$isoTimestamp}}",
    "checksum": "{{checkSum}}"
}
Parameter Name Type M/O Description
statusCode Numeric M Status of the transaction. 00 signifies success
statusDescription String M Corresponding description for the status code. 00=Successful
mReference String M Unique transaction id supplied by the integrator for the request
tranxReference Numeric M Creditswitch’s unique id generated for the transaction
recipient String M Customers number on the network to which top-up was sent
amount Numeric M Amount credited the customer
confirmCode Numeric M Confirmation code returned by the network. Sent only for successful transactions
Network String M The actual network fulfilled by the Telco
tranxDate Numeric M Date at which transaction was carried out 
{
    "statusCode": "00",
    "statusDescription": "Successful",
    "mReference": "iib9ja15i5j1",
    "tranxReference": "2108021419282563095",
    "recipient": "1711004587",
    "amount": 200,
    "confirmCode": "2108021419282563095",
    "network": "Mtn",
    "tranxDate": "02-08-2025 2:19 pm"
}