Customer Datashare

AVAILABLE IN

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": [],
    "statusMessage": [],
    "transactionId": [],
    "data": [],
    "_link": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "statusMessage": [],
    "transactionId": [],
    "data": [],
    "_link": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "statusMessage": [],
    "_link": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "statusMessage": [],
    "_link": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

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": [],
    "timestamp": [],
    "statusCode": [],
    "Error": [],
    "message": [],
    "path": []
}

Check out some of our other products.

MTN

Retrieve usage history, OOB usage charge and recharge history details for a particular subscriber MSISDN

View

MTN

View the product

View

MTN

View the product

View