openapi: 3.0.1 info: title: Customer Data Share description: The Data Share API facilitates data share between Data Share Agent(Data Sender) and Customer(Data Receiver) also provides a data analytics. It also provides functionality to manage provider and consumer msisdns that are linked as part of the Internet Share Bundles Product license: name: MADAPI url: https://developers.mtn.com/ version: 3.0.0 - Last updated date:2026-08-06 14:20:59 servers: - url: https://api.mtn.com/v1 description: Production Server security: - OAuth2: [] tags: - name: CustomerDataShare paths: /customers/{customerId}/analytics: get: tags: - CustomerDataShare summary: Get analytic information of your data usage description: Get analytic information of your data usage and list of beneficiaries enjoying from the data. operationId: CustomerDataShareService_get_getCustomerDataUsage_customerscustomerIda parameters: - name: customerId in: path required: true schema: type: string - name: endDate in: query required: true schema: type: string - name: pageNum in: query required: false schema: type: integer format: int32 - name: pageSize in: query required: false schema: type: integer format: int32 - name: startDate in: query required: true schema: type: string - name: targetSystem in: query required: false schema: type: string - name: transactionId in: header required: false schema: type: string - name: type in: query required: false schema: type: string - name: x-origin-channelid in: header required: false schema: type: string responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI customer data share flows. content: application/json: schema: title: CustomerDataShareAnalysisResponse type: object properties: statusCode: type: string statusMessage: type: string transactionId: type: string data: type: array items: title: CustomerDataShareAnalysisResponseData type: object properties: serviceDurationUnit: type: string servedMsisdn: type: string providerMsisdn: type: string serviceDuration: type: integer format: int32 serviceClassId: type: string serviceType: type: string currencyCode: type: string dateKey: type: integer format: int32 apn: type: string "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' deprecated: false /customers/{customerId}/summary: get: tags: - CustomerDataShare summary: Get GDS summary your data usage description: Get group data share summary for your data usage. operationId: CustomerDataShareService_get_getCustomerDataUsage_customerscustomerIds parameters: - name: customerId in: path required: true schema: type: string - name: endDate in: query required: true schema: type: string - name: pageNum in: query required: false schema: type: integer format: int32 - name: pageSize in: query required: false schema: type: integer format: int32 - name: startDate in: query required: true schema: type: string - name: summaryPeriod in: query required: false schema: type: string - name: targetSystem in: query required: false schema: type: string - name: transactionId in: header required: false schema: type: string - name: type in: query required: true schema: type: string - name: x-origin-channelid in: header required: false schema: type: string responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI customer data share flows. content: application/json: schema: title: CustomerDataShareSummaryResponse type: object properties: statusCode: type: string statusMessage: type: string transactionId: type: string customerId: type: string data: title: DataShareSummaryData type: object properties: pageNumber: type: integer format: int32 recordsCount: type: integer format: int32 maximumRecords: type: integer format: int32 summaryDetails: type: array items: title: DataSummaryDetails type: object properties: id: type: string summaryType: type: string date: type: string week: type: string month: type: string yearMonth: type: string dataUsage: title: DataUsage type: object properties: value: type: string unit: type: string "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' deprecated: false /customers/{senderMsisdn}: post: tags: - CustomerDataShare summary: TransferDataToShareAccountFromMain description: provider transfers data to shared account from main account operationId: CustomerDataShareService_post_transferDataToShareAccount_customerssenderMsisd parameters: - name: productCode in: query required: false schema: type: string - name: senderMsisdn in: path required: true schema: type: string - name: transactionId in: header required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_request_datashare_DataShareRequestForHynetFlex' required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI customer data share flows. content: application/json: schema: title: DataShareResponseForHynetFlex type: object properties: statusCode: type: string statusMessage: type: string transactionId: type: string data: title: ConsumerDataShareLimitData type: object properties: requestId: type: string responseType: type: string action: type: string countryCode: type: string product: $ref: '#/components/schemas/com_mtn_aggregator_models_response_sharedaccount_Product' amount: type: string notification: type: string circleCode: type: string input: type: string "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' deprecated: false /customers/{senderMsisdn}/datashare: post: tags: - CustomerDataShare summary: DataShare description: Provides the ability to share data with customer. operationId: CustomerDataShareService_post_shareData_customerssenderMsisd parameters: - name: countryCode in: header required: false schema: type: string - name: productCode in: query required: false schema: type: string - name: senderMsisdn in: path required: true schema: type: string - name: targetSystem in: header required: false schema: type: string - name: transactionId in: header required: false schema: type: string - name: x-origin-channelid in: header required: false schema: type: string - name: x-registration-channel-id in: header required: false schema: type: string requestBody: content: application/json: schema: title: DataShareRequest required: - receiverMsisdn - requestedDataAmount type: object properties: receiverMsisdn: type: string requestedDataAmount: type: string senderId: type: string productId: type: string category: type: string required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI customer data share flows. content: application/json: schema: title: DataShareResponse type: object properties: statusCode: type: string statusMessage: type: string transactionId: type: string sequenceNo: type: string data: title: DataShareResponseData type: object properties: productName: type: string notification: type: string "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' deprecated: false /providers/{providerMsisdn}: get: tags: - CustomerDataShare summary: DataShare description: Provides the ability to retrieve all consumers that are sharing the internet share bundle with the provider operationId: CustomerDataShareService_get_viewProviderOrConsumer_providersproviderMsi parameters: - name: action in: query required: true schema: type: string - name: autoShare in: query required: false schema: type: boolean - name: clientTransactionId in: query required: true schema: type: string - name: partnerId in: query required: true schema: type: string - name: prefLanguage in: query required: false schema: type: string - name: productId in: query required: true schema: type: string - name: providerMsisdn in: path required: true schema: type: string - name: targetSystem in: header required: false schema: type: string - name: transactionId in: header required: false schema: type: string - name: viewType in: query required: true schema: type: string - name: x-origin-channelid in: header required: false schema: type: string responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI customer data share flows. content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_response_APIResponse' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' deprecated: false put: tags: - CustomerDataShare summary: Set datashare limits description: Allows a provider to adjust consumer limits operationId: CustomerDataShareService_put_setDataLimitConsumerFamilyPack_providersproviderMsi parameters: - name: providerMsisdn in: path required: true schema: type: string - name: transactionId in: header required: false schema: type: string - name: x-country-code in: header required: false schema: type: string - name: x-origin-channelid in: header required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_request_ConsumerFamilyPackRequest' required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI customer data share flows. content: application/json: schema: title: ConsumerProviderResponse type: object properties: statusCode: type: string displayName: type: string productName: type: string description: type: string amount: type: string bundleCode: type: string duration: type: string statusMessage: type: string transactionId: type: string errorCode: type: string message: type: string timestamp: type: string error: type: string path: type: string requestId: type: string plans: type: array items: title: CSMConsumerPlansResponse type: object properties: name: type: string displayName: type: string description: type: string cost: type: string bundleCode: type: string duration: type: string data: title: ConsumerProviderResponseData type: object properties: notification: type: string amount: type: integer format: int32 requestId: type: string responseType: type: string action: type: string countryCode: type: string product: $ref: '#/components/schemas/com_mtn_aggregator_models_response_sharedaccount_Product' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' deprecated: false post: tags: - CustomerDataShare summary: "/providers/{providerMsisdn}" description: Allows a provider to add a customer to use their internet share bundle operationId: CustomerDataShareService_post_addConsumerFamilyPack_providersproviderMsi parameters: - name: providerMsisdn in: path required: true schema: type: string - name: transactionId in: header required: false schema: type: string - name: x-origin-channelid in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_request_ConsumerFamilyPackRequest' required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI customer data share flows. content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_response_APIResponse' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' deprecated: false delete: tags: - CustomerDataShare summary: Deactivates Internet sharing for a provider/consumer msisdn or removes consumer msisdns from the provider msisdn description: Allows a provider to leave data sharing or to remove a customer and hence stop them from using their internet share bundle operationId: CustomerDataShareService_delete_deactivateSharing_providersproviderMsi parameters: - name: action in: query required: false schema: type: string - name: clientTransactionId in: query required: false schema: type: string - name: consumerMsisdn in: query required: false schema: type: string - name: input in: query required: false schema: type: string - name: nodeId in: query required: false schema: type: string - name: pin in: query required: false schema: type: string - name: providerMsisdn in: path required: true schema: type: string - name: removeConsumers in: query required: false schema: type: string - name: targetSystem in: query required: false schema: type: string - name: transactionId in: header required: false schema: type: string - name: x-origin-channelid in: header required: false schema: type: string responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI customer data share flows. content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_response_APIResponse' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' deprecated: false patch: tags: - CustomerDataShare summary: Update datashare limits description: Allows a provider to adjust consumer limits operationId: CustomerDataShareService_patch_updateConsumerFamilyPack_providersproviderMsi parameters: - name: providerMsisdn in: path required: true schema: type: string - name: transactionId in: header required: false schema: type: string - name: x-origin-channelid in: header required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_request_ConsumerFamilyPackRequest' required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI customer data share flows. content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_response_APIResponse' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' deprecated: false /providers/{providerMsisdn}/activate: post: tags: - CustomerDataShare summary: "/providers/{providerMsisdn}/activate" description: "Activate data sharing plan, Allows a provider to activate data\ \ sharing bundle." operationId: CustomerDataShareService_post_activateFamilyPack_providersproviderMsi parameters: - name: providerMsisdn in: path required: true schema: type: string - name: transactionId in: header required: false schema: type: string requestBody: content: application/json: schema: title: ConsumerFamilyPackRequest type: object properties: customerId: type: string threshold: type: string unit: type: string nodeId: type: string input: type: string targetSystem: type: string operationType: type: string consumerMsisdn: type: string agentId: type: string customerMsisdn: type: string pin: type: string prefLanguage: type: string paymentOption: type: string removeConsumers: type: string consumerMsisdns: type: array items: type: string requestDate: type: string clientTransactionId: type: string setCharging: type: boolean clientId: type: string renewalOption: type: string transactionId: type: string preferredLanguage: type: string required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI customer data share flows. content: application/json: schema: title: APIResponse type: object "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' deprecated: false /providers/{providerMsisdn}/eligibility: get: tags: - CustomerDataShare summary: DataShare description: Check if a number is a provider operationId: CustomerDataShareService_get_getProviderEligibility_providersproviderMsi parameters: - name: action in: query required: true schema: type: string - name: clientTransactionId in: query required: true schema: type: string - name: partnerId in: query required: true schema: type: string - name: productId in: query required: true schema: type: string - name: providerMsisdn in: path required: true schema: type: string - name: transactionId in: header required: false schema: type: string - name: x-origin-channelid in: header required: false schema: type: string responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI customer data share flows. content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_response_APIResponse' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' deprecated: false /providers/{providerMsisdn}/registration: post: tags: - CustomerDataShare summary: Registration description: Registration Request for Shared Account services operationId: CustomerDataShareService_post_registerSponsor_providersproviderMsi parameters: - name: providerMsisdn in: path required: true schema: type: string - name: transactionId in: header required: false schema: type: string requestBody: content: application/json: schema: title: DataShareRequestForHynetFlex type: object properties: customerId: type: string threshold: type: string unit: type: string nodeId: type: string input: type: string targetSystem: type: string operationType: type: string consumerMsisdn: type: string agentId: type: string customerMsisdn: type: string pin: type: string requestedDataAmount: type: string requestPath: type: string providerMsisdn: type: string senderMsisdn: type: string receiverMsisdn: type: string clientTransactionId: type: string required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI customer data share flows. content: application/json: schema: title: CustomerRegisterResponse type: object properties: statusCode: type: string statusMessage: type: string transactionId: type: string data: title: CustomerRegisterResponseData type: object properties: requestId: type: string responseType: type: string action: type: string inputCode: type: string countryCode: type: string product: title: Product type: object properties: productId: type: string productName: type: string productType: type: string amount: type: string notification: type: string consumers: title: Consumers type: object properties: consumersMsisdn: type: array items: type: string amount: type: string notification: type: string "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' "502": description: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. content: application/json: schema: $ref: '#/components/schemas/APIError' "503": description: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. content: application/json: schema: $ref: '#/components/schemas/APIError' deprecated: false components: schemas: com_mtn_aggregator_models_response_data_CustomerRegisterResponseData: title: CustomerRegisterResponseData type: object properties: requestId: type: string responseType: type: string action: type: string inputCode: type: string countryCode: type: string product: title: Product type: object properties: productId: type: string productName: type: string productType: type: string amount: type: string notification: type: string consumers: title: Consumers type: object properties: consumersMsisdn: type: array items: type: string amount: type: string notification: type: string com_mtn_aggregator_models_response_data_DataSummaryDetails: title: DataSummaryDetails type: object properties: id: type: string summaryType: type: string date: type: string week: type: string month: type: string yearMonth: type: string dataUsage: title: DataUsage type: object properties: value: type: string unit: type: string com_mtn_aggregator_models_response_data_ConsumerDataShareLimitData: title: ConsumerDataShareLimitData type: object properties: requestId: type: string responseType: type: string action: type: string countryCode: type: string product: $ref: '#/components/schemas/com_mtn_aggregator_models_response_sharedaccount_Product' amount: type: string notification: type: string circleCode: type: string input: type: string com_mtn_aggregator_models_request_datashare_DataShareRequestForHynetFlex: title: DataShareRequestForHynetFlex type: object properties: customerId: type: string threshold: type: string unit: type: string nodeId: type: string input: type: string targetSystem: type: string operationType: type: string consumerMsisdn: type: string agentId: type: string customerMsisdn: type: string pin: type: string requestedDataAmount: type: string requestPath: type: string providerMsisdn: type: string senderMsisdn: type: string receiverMsisdn: type: string clientTransactionId: type: string com_mtn_aggregator_models_response_sharedaccount_Product: title: Product type: object properties: productId: type: string productName: type: string productType: type: string amount: type: string notification: type: string consumers: title: Consumers type: object properties: consumersMsisdn: type: array items: type: string com_mtn_aggregator_models_response_Consumers: title: Consumers type: object properties: consumersMsisdn: type: array items: type: string com_mtn_aggregator_models_response_CustomerDataShareSummaryResponse: title: CustomerDataShareSummaryResponse type: object properties: statusCode: type: string statusMessage: type: string transactionId: type: string customerId: type: string data: title: DataShareSummaryData type: object properties: pageNumber: type: integer format: int32 recordsCount: type: integer format: int32 maximumRecords: type: integer format: int32 summaryDetails: type: array items: title: DataSummaryDetails type: object properties: id: type: string summaryType: type: string date: type: string week: type: string month: type: string yearMonth: type: string dataUsage: title: DataUsage type: object properties: value: type: string unit: type: string com_mtn_aggregator_models_response_data_DataShareResponseData: title: DataShareResponseData type: object properties: productName: type: string notification: type: string com_mtn_aggregator_models_response_data_CustomerDataShareAnalysisResponseData: title: CustomerDataShareAnalysisResponseData type: object properties: serviceDurationUnit: type: string servedMsisdn: type: string providerMsisdn: type: string serviceDuration: type: integer format: int32 serviceClassId: type: string serviceType: type: string currencyCode: type: string dateKey: type: integer format: int32 apn: type: string com_mtn_aggregator_models_response_sharedaccount_ConsumerProviderResponse: title: ConsumerProviderResponse type: object properties: statusCode: type: string displayName: type: string productName: type: string description: type: string amount: type: string bundleCode: type: string duration: type: string statusMessage: type: string transactionId: type: string errorCode: type: string message: type: string timestamp: type: string error: type: string path: type: string requestId: type: string plans: type: array items: title: CSMConsumerPlansResponse type: object properties: name: type: string displayName: type: string description: type: string cost: type: string bundleCode: type: string duration: type: string data: title: ConsumerProviderResponseData type: object properties: notification: type: string amount: type: integer format: int32 requestId: type: string responseType: type: string action: type: string countryCode: type: string product: $ref: '#/components/schemas/com_mtn_aggregator_models_response_sharedaccount_Product' com_mtn_aggregator_models_response_CustomerRegisterResponse: title: CustomerRegisterResponse type: object properties: statusCode: type: string statusMessage: type: string transactionId: type: string data: title: CustomerRegisterResponseData type: object properties: requestId: type: string responseType: type: string action: type: string inputCode: type: string countryCode: type: string product: title: Product type: object properties: productId: type: string productName: type: string productType: type: string amount: type: string notification: type: string consumers: title: Consumers type: object properties: consumersMsisdn: type: array items: type: string amount: type: string notification: type: string com_mtn_aggregator_models_response_APIResponse: title: APIResponse type: object com_mtn_madapi_models_response_CSMConsumerPlansResponse: title: CSMConsumerPlansResponse type: object properties: name: type: string displayName: type: string description: type: string cost: type: string bundleCode: type: string duration: type: string com_mtn_aggregator_models_response_sharedaccount_ConsumerProviderResponseData: title: ConsumerProviderResponseData type: object properties: notification: type: string amount: type: integer format: int32 requestId: type: string responseType: type: string action: type: string countryCode: type: string product: $ref: '#/components/schemas/com_mtn_aggregator_models_response_sharedaccount_Product' com_mtn_aggregator_models_request_datashare_DataShareRequest: title: DataShareRequest required: - receiverMsisdn - requestedDataAmount type: object properties: receiverMsisdn: type: string requestedDataAmount: type: string senderId: type: string productId: type: string category: type: string com_mtn_aggregator_models_response_data_DataUsage: title: DataUsage type: object properties: value: type: string unit: type: string com_mtn_aggregator_models_request_ConsumerFamilyPackRequest: title: ConsumerFamilyPackRequest type: object properties: customerId: type: string threshold: type: string unit: type: string nodeId: type: string input: type: string targetSystem: type: string operationType: type: string consumerMsisdn: type: string agentId: type: string customerMsisdn: type: string pin: type: string prefLanguage: type: string paymentOption: type: string removeConsumers: type: string consumerMsisdns: type: array items: type: string requestDate: type: string clientTransactionId: type: string setCharging: type: boolean clientId: type: string renewalOption: type: string transactionId: type: string preferredLanguage: type: string APIError: title: APIError required: - statusCode - statusMessage type: object properties: statusCode: type: string description: Error status code example: "400" statusMessage: type: string description: Human-readable error message example: Bad request. Invalid parameters provided. supportMessage: type: string description: Technical support message or error code for troubleshooting example: VALIDATION_ERROR transactionId: type: string description: Transaction identifier for tracking and correlation example: "1234567890" sequenceNo: type: string description: Sequence number for request tracking example: "20250115120000001" timestamp: type: string description: Error timestamp in ISO 8601 format format: date-time example: 2025-01-15T12:00:00Z path: type: string description: API endpoint path where the error occurred example: /api/v1/resource method: type: string description: HTTP method of the request that caused the error example: POST downstreamStatusCode: type: string description: Downstream service error code if applicable description: Generic MADAPI error response structure example: statusCode: "400" statusMessage: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z com_mtn_aggregator_models_response_data_DataShareSummaryData: title: DataShareSummaryData type: object properties: pageNumber: type: integer format: int32 recordsCount: type: integer format: int32 maximumRecords: type: integer format: int32 summaryDetails: type: array items: title: DataSummaryDetails type: object properties: id: type: string summaryType: type: string date: type: string week: type: string month: type: string yearMonth: type: string dataUsage: title: DataUsage type: object properties: value: type: string unit: type: string com_mtn_aggregator_models_response_CustomerDataShareAnalysisResponse: title: CustomerDataShareAnalysisResponse type: object properties: statusCode: type: string statusMessage: type: string transactionId: type: string data: type: array items: title: CustomerDataShareAnalysisResponseData type: object properties: serviceDurationUnit: type: string servedMsisdn: type: string providerMsisdn: type: string serviceDuration: type: integer format: int32 serviceClassId: type: string serviceType: type: string currencyCode: type: string dateKey: type: integer format: int32 apn: type: string com_mtn_aggregator_models_response_DataShareResponseForHynetFlex: title: DataShareResponseForHynetFlex type: object properties: statusCode: type: string statusMessage: type: string transactionId: type: string data: title: ConsumerDataShareLimitData type: object properties: requestId: type: string responseType: type: string action: type: string countryCode: type: string product: $ref: '#/components/schemas/com_mtn_aggregator_models_response_sharedaccount_Product' amount: type: string notification: type: string circleCode: type: string input: type: string com_mtn_aggregator_models_response_DataShareResponse: title: DataShareResponse type: object properties: statusCode: type: string statusMessage: type: string transactionId: type: string sequenceNo: type: string data: title: DataShareResponseData type: object properties: productName: type: string notification: type: string securitySchemes: OAuth2: type: oauth2 flows: clientCredentials: tokenUrl: https://api.mtn.com/v1/oauth/access_token scopes: {} Bearer: type: http description: Bearer token received from OAuth2.0 authentication with the MADAPI scheme: bearer bearerFormat: JWT