MTN Nigeria Customer Datashare

AVAILABLE IN

Nigeria

Download

Download Postman collection Download Swagger

Available endpoints

POST v1/datashare/customers/{senderMsisdn}/dataShare

Description

Provides the ability to share data with customer.

Header parameters

Content-Type application/json

Auth parameters

apikey X-API-Key

Query parameters

productcode string required
The product code e.g NACT_NG_others_1

FormData parameters

receiverMsisdn string required
The beneficiary msisdn. The format must be E.123
requestedDataAmount string required
Total amount of data to be shared with the customer in MBs
200OK
statusCode string
HTTP Error code extension
statusMessage string
transactionId string
Client generated Id to include for tracing requests.
data
productName string
notification string
_link
self
href string
{
    "statusCode": "string",
    "statusMessage": "string",
    "transactionId": "string",
    "data": {
        "productName": "string",
        "notification": "string"
    },
    "_link": {
        "self": {
            "href": "string"
        }
    }
}
400Bad Request
transactionId string
Client generated Id to include for tracing requests.
timestamp string
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "transactionId": "string",
    "timestamp": "string",
    "statusCode": "string",
    "Error": "string",
    "message": "string",
    "path": "string"
}
GET v1/datashare/customers/{senderMsisdn}/dataShare

Description

Provides the ability to retrieve all registered receiver's msisdn.

Header parameters

Content-Type application/json

Auth parameters

apikey X-API-Key
200OK
statusCode string
HTTP Error code extension
statusMessage string
transactionId string
Client generated Id to include for tracing requests.
data
receiverMsisdn string
The beneficiary msisdn. The format must be E.123
requestedDataAmount string
Total amount of data to be shared with the customer in MBs
_link
self
href string
{
    "statusCode": "string",
    "statusMessage": "string",
    "transactionId": "string",
    "data": {
        "receiverMsisdn": "string",
        "requestedDataAmount": "string"
    },
    "_link": {
        "self": {
            "href": "string"
        }
    }
}
400Bad Request
transactionId string
Client generated Id to include for tracing requests.
timestamp string
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "transactionId": "string",
    "timestamp": "string",
    "statusCode": "string",
    "Error": "string",
    "message": "string",
    "path": "string"
}
PATCH v1/datashare/customers/{senderMsisdn}/dataShare

Description

Provides the ability to update the receiver's msisdn and sharable data amount.

Header parameters

Content-Type application/json

Auth parameters

apikey X-API-Key

FormData parameters

receiverMsisdn string required
The beneficiary msisdn. The format must be E.123
requestedDataAmount string required
Total amount of data to be shared with the customer in MBs
200OK
statusCode string
HTTP Error code extension
statusMessage string
_link
self
href string
{
    "statusCode": "string",
    "statusMessage": "string",
    "_link": {
        "self": {
            "href": "string"
        }
    }
}
400Bad Request
transactionId string
Client generated Id to include for tracing requests.
timestamp string
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "transactionId": "string",
    "timestamp": "string",
    "statusCode": "string",
    "Error": "string",
    "message": "string",
    "path": "string"
}
DELETE v1/datashare/customers/{senderMsisdn}/dataShare

Description

Provides the ability for removing receiver's msisdn.

Header parameters

Content-Type application/json

Auth parameters

apikey X-API-Key

Query parameters

receiverMsisdn string
The beneficiary msisdn. The format must be E.123
200OK
statusCode string
HTTP Error code extension
statusMessage string
_link
self
href string
{
    "statusCode": "string",
    "statusMessage": "string",
    "_link": {
        "self": {
            "href": "string"
        }
    }
}
400Bad Request
transactionId string
Client generated Id to include for tracing requests.
timestamp string
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "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
Timestamps of Error
statusCode string
Error Code
Error string
Short Description
message string
More Error details and corrective measures
path string
The path to the request
{
    "transactionId": "string",
    "timestamp": "string",
    "statusCode": "string",
    "Error": "string",
    "message": "string",
    "path": "string"
}