Data Gifting v1

AVAILABLE IN

Nigeria

Download

Download Postman collection Download Swagger

Available endpoints

POST v1/datagifting/customers/{senderMsisdn}/dataGifting

Description

Requesting subscriber to purchase data on behalf of Beneficiary subscriber(customer).

Header parameters

Content-Type application/json

Auth parameters

apikey X-API-Key

Query parameters

nodeid string required
Third parties unique identifier. Can also be called channelId.

FormData parameters

receiverMsisdn string required
The Beneficiary subscriber msisdn. The format must be E.123
productCode string required
The product code, which already has a predefined data volumn and chargable amount in the Charging system
sendSms boolean required
SMS will be sent to both subscriber’s <msisdn=2349062058464, 2349062058463>
200OK
statusCode string
HTTP error code extension
statusMessage string
transactionId string
Client generated Id to include for tracing requests, so that the API can easily trace the HTTP request all the way from a client to MTNs backend processes (via our proxies). Each time a request is made to an MTN API the client should include a unique request reference in the HTTP Header. The value must be between 5 and 20 characters, and consist of ASCII letters, digits, or the characters +, /, =, and -. Invalid or blank IDs will be ignored and replaced with generated ones. MTN may use this to detect duplicate transactions from the client, but this functionality is not always guaranteed, so clients must make their own efforts to prevent duplicate transactions. MTN will also log the transactionId in order to assist with debugging and to correlate transactions processed by the API to requests from the client.
data
productName string
amtCharged integer
notification string
_link
self
href string
{
    "statusCode": "string",
    "statusMessage": "string",
    "transactionId": "string",
    "data": {
        "productName": "string",
        "amtCharged": 1,
        "notification": "string"
    },
    "_link": {
        "self": {
            "href": "string"
        }
    }
}
400Bad Request
transactionId string
Client generated Id to include for tracing requests.
timestamp string
Timestamp when the error occurred, using date-time format
statusCode string
Canonical Status code
error string
message string
More error details and corrective measures
path string
{
    "transactionId": "string",
    "timestamp": "string",
    "statusCode": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
401Unauthorized
transactionId string
Client generated Id to include for tracing requests.
timestamp string
Timestamp when the error occurred, using date-time format
statusCode string
Canonical Status code
error string
message string
More error details and corrective measures
path string
{
    "transactionId": "string",
    "timestamp": "string",
    "statusCode": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
403Forbidden
transactionId string
Client generated Id to include for tracing requests.
timestamp string
Timestamp when the error occurred, using date-time format
statusCode string
Canonical Status code
error string
message string
More error details and corrective measures
path string
{
    "transactionId": "string",
    "timestamp": "string",
    "statusCode": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
404Not Found
transactionId string
Client generated Id to include for tracing requests.
timestamp string
Timestamp when the error occurred, using date-time format
statusCode string
Canonical Status code
error string
message string
More error details and corrective measures
path string
{
    "transactionId": "string",
    "timestamp": "string",
    "statusCode": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
405Method Not Allowed
transactionId string
Client generated Id to include for tracing requests.
timestamp string
Timestamp when the error occurred, using date-time format
statusCode string
Canonical Status code
error string
message string
More error details and corrective measures
path string
{
    "transactionId": "string",
    "timestamp": "string",
    "statusCode": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
406Not Acceptable
transactionId string
Client generated Id to include for tracing requests.
timestamp string
Timestamp when the error occurred, using date-time format
statusCode string
Canonical Status code
error string
message string
More error details and corrective measures
path string
{
    "transactionId": "string",
    "timestamp": "string",
    "statusCode": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
415Unsupported Media Type
transactionId string
Client generated Id to include for tracing requests.
timestamp string
Timestamp when the error occurred, using date-time format
statusCode string
Canonical Status code
error string
message string
More error details and corrective measures
path string
{
    "transactionId": "string",
    "timestamp": "string",
    "statusCode": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
500Internal Server Error
transactionId string
Client generated Id to include for tracing requests.
timestamp string
Timestamp when the error occurred, using date-time format
statusCode string
Canonical Status code
error string
message string
More error details and corrective measures
path string
{
    "transactionId": "string",
    "timestamp": "string",
    "statusCode": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}