openapi: 3.0.1 info: title: MTN TMF620 Product Catalogue V1 description: "This service provides comprehensive product catalogue management capabilities\ \ following TMF620 standards for MTN operations. It handles product information\ \ management, catalogue browsing, product lifecycle management, and pricing information,\ \ serving as the central processing layer for all product catalogue operations\ \ across the MTN ecosystem." license: name: MADAPI url: https://developers.mtn.com/ version: 3.0.0 - Last updated date:2026-09-11 13:01:15 servers: - url: https://api.mtn.com/v1 description: Production Server security: - OAuth2: [] tags: - name: Tmf620ProductCatalogue paths: /catalog: get: tags: - Tmf620ProductCatalogue summary: List or Find Catalog Objects description: "This operation lists or finds Catalog objects with comprehensive\ \ filtering capabilities. The endpoint supports multiple business parameters\ \ including category names, market segments, business types, lifecycle status,\ \ and various filtering options for optimized catalog retrieval." operationId: ProductCatalogueAggregator_get_getCatalog_catalog parameters: - name: businessType in: query required: false schema: type: string - name: categoryName in: query required: false schema: type: string - name: countryCode in: header required: false schema: type: string - name: depth in: query required: false schema: type: string - name: endDate in: query required: false schema: type: string - name: fields in: query required: false schema: type: string - name: isSellable in: query required: false schema: type: string - name: lifeCycle in: query required: false schema: type: string - name: limit in: query required: false schema: type: string - name: marketSegment in: query required: false schema: type: string - name: offset in: query required: false schema: type: string - name: productId in: query required: false schema: type: string - name: productProviderId in: query required: false schema: type: string - name: senderId in: query required: false schema: type: string - name: serviceNumber in: query required: false schema: type: string - name: startDate 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: unit in: query 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 tmf620 product catalogue flows. content: application/json: schema: title: ProductCatalogResponse type: object properties: offset: type: string resultCode: type: string statusCode: type: string statusMessage: type: string next: type: string previous: type: string pageSize: type: string responseCount: type: string resultDescription: type: string transactionId: type: string data: type: array items: title: CatalogResponseData type: object properties: serviceType: type: string catalogType: type: string lifecycleStatus: type: string freeCounter: type: string type: type: string consentRequired: type: string consentKeywords: type: string thirdConsentRequired: type: string offNet: type: string id: type: string href: type: string shortCode: type: string cli: type: string serviceValidity: type: string fBreqFamilyPlan: type: string notificationReqFamilyPlan: type: string balanceQueryReq: type: string familyPlanReq: type: string version: type: string secondarySpName: type: string lastUpdate: type: string name: type: string promoContentMtLimited: type: string servicePausable: type: string status: type: string chargingMode: type: string secondarySpId: type: string access: type: string dndCategory: type: string description: type: string planLinked: type: string consentReqFreePlan: type: string callbackRegRequired: type: string baseType: type: string tenantName: type: string amountBasedChargingReq: type: string chargingReqFreePlan: type: string freeMOService: type: string directSubscription: type: string ready: type: string fallbackConsentRequired: type: string gatewayCharging: type: string requestType: type: string dndCheck: type: string serviceName: type: string priceQueryReq: type: string spId: type: string mtPushEnabled: type: string activeStatus: type: string typeOfService: type: string tenantId: type: string catalogCategory: type: string subMtCpDaily: type: string validFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string category: type: array items: title: Category type: object properties: referredType: type: string lifecycleStatus: type: string renewalPrice: type: string endDate: type: string discountAmount: type: string type: type: string validityPeriod: type: string allowInGrace: type: string promoText: type: string id: type: string href: type: string isSuspendChargeable: type: string resubsAllowed: type: string periodicityPlan: type: string level: type: string allowInSuspend: type: string preRenewalConsent: type: string version: type: string renewalPricePoint: type: string renewalPlanId: type: string isfallBackReq: type: string isOneOffReq: type: string validityType: type: string pricePoint: type: string failAction: type: string isRenFbReg: type: string name: type: string renewalLifecycleId: type: string startDate: type: string gracePeriod: type: string description: type: string isFoc: type: string baseType: type: string allowInParking: type: string discountText: type: string discountPercentage: type: string autoRenew: type: string subPrice: type: string microChargingEnabled: type: string isGraceChargeble: type: string parkingPeriod: type: string disableFallback: type: string deactivationMode: type: string isFamilyPlan: type: string periodicityPeriod: type: string haSubCategory: type: string renValPeriod: type: string lifecycleId: type: string isParkingChargeable: type: string suspendPeriod: type: string timeDurationList: type: array items: type: string focDaysList: type: array items: type: string specialDaysList: type: array items: type: string planMetadata: type: array items: title: ResponsePlanMetadata type: object properties: promoText: type: string validityType: type: string planMetadataId: type: string languageId: type: string planName: type: string description: type: string planId: type: string searchKeyword: type: string discountText: type: string planMsgList: type: array items: title: ResponsePlanMsgList type: object properties: frequencyId: type: string isFrequencyRequest: type: string msgTypeId: type: string msgTypeName: type: string active: type: string frequency: type: string msgList: type: array items: title: ResponseMsgList type: object properties: msgTypeId: type: string renewalMessage: type: string msgId: type: string isFilled: type: string language: type: string languageCode: type: string message: type: string subKeywords: type: string unsubKeywords: type: string flexibleCharging: type: string shortCode: type: string planItemList: type: array items: title: PlanItemResponse type: object properties: itemId: type: string itemType: type: string itemName: type: string price: type: string relatedParty: type: array items: title: RelatedParty type: object properties: role: type: string referredType: type: string name: type: string id: type: string type: type: string baseType: type: string serviceMsgList: type: array items: title: ResponseServiceMsgList type: object properties: frequencyId: type: string isFreqReq: type: string msgTypeId: type: string msgTypeName: type: string msgList: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_product_response_ResponseMsgList' isActive: type: string frequency: type: string dndCategoryMap: type: string serviceImageList: type: string isDirectCallbackReq: type: string userTypeMap: type: string serviceValidityMap: type: string noOfFamilyMembersList: type: array items: type: string isPackRequired: type: string primaryURL: type: string serviceMetadata: type: array items: title: ResponseServiceMetadata type: object properties: serviceDesc: type: string languageId: type: string serviceName: type: string keyword: type: string image: type: string languageName: type: string giftOptionEnabled: type: string typeOfServiceMap: title: ResponseTypeOfServiceMap type: object properties: R: type: string E: type: string "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' 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 "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "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' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "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' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false /catalog/{id}: get: tags: - Tmf620ProductCatalogue summary: Retrieve Category by ID description: "This operation retrieves a specific Category entity by ID with\ \ comprehensive attribute selection enabled. The endpoint supports filtering\ \ by fields, target system specification, and various business parameters\ \ for optimized data retrieval." operationId: ProductCatalogueAggregator_get_getCategory_catalogid parameters: - name: countryCode in: header required: false schema: type: string - name: custom in: query required: false schema: type: string - name: fields in: query required: false schema: type: string - name: id in: path required: true schema: type: string - name: senderId in: query required: false schema: type: string - name: serviceNumber in: query required: false schema: type: string - name: target in: query required: false schema: type: string - name: transactionId 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 tmf620 product catalogue flows. content: application/json: schema: title: CategoryByIdResponse type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string catalog: title: CatalogByIdData type: object properties: name: type: string description: type: string businessType: type: string version: type: string category: title: CatalogByIdCategory type: object properties: productoffering: title: ProductOffering type: object properties: id: type: string productOfferingTerm: type: array items: title: ProductOfferingTerm type: object properties: validFor: title: OfferinTermValidFor type: object properties: amount: type: string unitofmeasure: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: value: type: string name: type: string unit: type: string type: type: string recurringChargePeriodType: type: string recurringChargePeriodLength: type: string constraint: title: Constraint type: object properties: productOfferingPrice: type: array items: title: ProductOfferingPriceData type: object properties: name: type: string value: type: string unit: type: string amount: type: string currency: type: string prodSpecCharValueUse: type: array items: title: ProdSpecCharValueUse type: object properties: productSpecCharacteristicValue: type: array items: title: ProductSpecCharacteristic type: object properties: value: type: string unitOfMeasure: type: string '@type': type: string unit: type: string productSpecCharacteristic: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_apiGee_ProductSpecCharacteristic' productSpecification: type: string name: type: string description: type: string valueType: type: string '@type': type: string price: title: Price type: object properties: unit: type: string value: type: string productSpecification: title: DclmProductSpecification type: object properties: id: type: string name: type: string lifecycleStatus: type: string '@type': type: string version: type: string href: type: string bundledProductSpecification: type: array items: title: DclmBundledProductSpecification type: object properties: id: type: string name: type: string description: type: string resourcePoolType: type: string lifeCycleStatus: type: string '@type': type: string productSpecCharacteristic: type: array items: title: BundeledProductSpecCharacteristic type: object properties: valueType: type: string '@type': type: string unitOfMeasure: type: string value: type: string productSpecCharacteristic: type: array items: title: DclmProductSpecificationProductSpecCharacteristic type: object properties: name: type: string description: type: string valueType: type: string minCardinality: type: string maxCardinality: type: string productSpecCharacteristicValue: type: array items: title: DclmProductOfferingPriceProdSpecCharacteristicValue type: object properties: valueType: type: string '@type': type: string value: type: string unitOfMeasure: type: string '@type': type: string productSpecificationRelationship: type: array items: title: BundledProductSpecificationRelationship type: object properties: '@type': type: string relationshipType: type: string lastUpdate: type: string timestamp: type: string status: type: string error: type: string message: type: string path: type: string "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' 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 "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "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' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "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' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false /category: get: tags: - Tmf620ProductCatalogue summary: Retrieve CRBT Categories description: This operation retrieves available CRBT categories information based on the provided country code and target system. The endpoint supports various business parameters. operationId: ProductCatalogueAggregator_get_getCategoryListing_category parameters: - name: Accept-Language in: header required: false schema: type: string - name: X-Request-Mode in: header required: false schema: type: string - name: catLimit in: query required: false schema: type: string - name: catOffset in: query required: false schema: type: string - name: categoryId in: query required: false schema: type: string - name: limit in: query required: false schema: type: string - name: offset in: query required: false schema: type: string - name: paginated in: query required: false schema: type: string - name: requestType in: header required: false schema: type: string - name: targetSystem in: header required: false schema: type: string - name: transactionId in: header required: false schema: type: string - name: x-country-code 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 tmf620 product catalogue flows. content: application/json: schema: title: CrbtResponse type: object properties: code: type: string reason: type: string status: type: string message: type: string externalIdentifier: type: array items: title: ExternalIdentifier type: object properties: owner: type: string id: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: id: type: string priceType: type: string price: title: Price type: object properties: value: type: string unit: type: string unitOfMeasure: title: UnitOfMeasure type: object properties: amount: type: string units: type: string description: type: string prodSpecCharValueUse: type: array items: title: ProdSpecCharValueUse type: object properties: name: type: string productSpecCharacteristicValue: type: array items: title: ProductSpecCharacteristicValue type: object properties: value: type: string category: type: array items: title: CrbtCategory type: object properties: id: type: string title: type: string imagePath: type: string type: type: string name: type: string externalIdentifier: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ExternalIdentifier' subCategory: type: array items: title: SubCategory type: object properties: id: type: string name: type: string externalIdentifier: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ExternalIdentifier' parentId: type: string productOffering: type: array items: title: ProductOffering type: object properties: id: type: string name: type: string lifecycleStatus: type: string lastUpdate: type: string validFor: title: ValidFor type: object properties: endDateTime: type: string category: type: array items: title: ProductCategory type: object properties: '@referredType': type: string name: type: string productOfferingPrice: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ProductOfferingPrice' productOfferingCharacteristic: type: array items: title: ProductOfferingCharacteristic type: object properties: name: type: string characteristicValueSpecification: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ProductSpecCharacteristicValue' '@referredType': type: string productOffering: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ProductOffering' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' 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 "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "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' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "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' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false /productOffering: get: tags: - Tmf620ProductCatalogue summary: RBT Content Search description: "This operation searches for RBT (Ring Back Tone) content offerings.\ \ Supports two modes: contentSearchFilter for multi-field filter search, and\ \ contentSearchMetadata for single-criteria metadata search by title, artist,\ \ movie, tune name, or album. Returns content matched as TMF620 ProductOffering\ \ resources with pagination support." operationId: ProductCatalogueAggregator_get_getProductOffering_productOffering parameters: - name: Accept-Language in: header required: false schema: type: string - name: X-Request-Mode in: header required: false schema: type: string - name: artist in: query required: false schema: type: string - name: artistSex in: query required: false schema: type: string - name: categoryId in: query required: false schema: type: string - name: contentType in: query required: false schema: type: string - name: cpId in: query required: false schema: type: string - name: expiryDateCriteria in: query required: false schema: type: string - name: externalId in: query required: false schema: type: string - name: field in: query required: false schema: type: string - name: hotToneCode in: query required: false schema: type: string - name: keyToSearch in: query required: false schema: type: string - name: lifecycleStatus in: query required: false schema: type: string - name: limit in: query required: false schema: type: string - name: movie in: query required: false schema: type: string - name: name in: query required: false schema: type: string - name: offset in: query required: false schema: type: string - name: queryType in: query required: false schema: type: string - name: requestType in: header required: false schema: type: string - name: subCategoryId in: query required: false schema: type: string - name: targetSystem in: header required: false schema: type: string - name: toneCode in: query required: false schema: type: string - name: transactionId in: header required: false schema: type: string - name: value in: query required: false schema: type: string - name: vcode in: query required: false schema: type: string - name: x-country-code 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 tmf620 product catalogue flows. content: application/json: schema: title: RbtSearchContentBackendResponse type: object properties: respCode: type: string respMsg: type: string resultCode: type: integer format: int32 result: type: string transactionId: type: string childTrId: type: string title: type: string artist: type: string movie: type: string album: type: string nametune: type: string data: title: RbtSearchContentData type: object properties: totalContent: type: integer format: int32 nextContentAvailable: type: boolean currentOffset: type: integer format: int32 content: type: array items: title: RbtContentItem type: object properties: contentPlan: type: string contentPrice: type: string contentPath: type: string contentValidity: type: string contentImagePath: type: string contentArtist: type: string contentAlbum: type: string contentType: type: string ccode: type: string shortCode: type: string genre: type: string subGenre: type: string subSubGenre: type: string cpName: type: string subscriptionPrice: type: string subscriptionValidity: type: string contentValidityType: type: string subscriptionValidityType: type: string currencyCode: type: string language: type: string orderInfo: type: string info: type: string uploadTime: type: string copyrightEndDate: type: string toneApprovalTime: type: string toneUpdatedTime: type: string cpCode: type: string artistNameLetter: type: string artistSex: type: string toneNameLetter: type: string toneCode: type: string hdTonePath: type: string contentLanguage: type: string status: type: string contentId: type: string contentInPlaylist: type: string title: type: string id: type: string contentList: type: string "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' 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 "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "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' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "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' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false /productOfferingPrice: get: tags: - Tmf620ProductCatalogue summary: Retrieve product pricing description: This operation retrieves product pricing information based on the provided country code and target system. The endpoint supports various business parameters for optimized pricing retrieval. operationId: ProductCatalogueAggregator_get_getPricing_productOfferingPrice parameters: - name: Accept-Language in: header required: false schema: type: string - name: X-Request-Mode in: header required: false schema: type: string - name: contentType in: query required: false schema: type: string - name: msisdn in: query required: false schema: type: string - name: requestType in: header required: false schema: type: string - name: targetSystem in: header required: false schema: type: string - name: toneId in: query required: false schema: type: string - name: transactionId in: header required: false schema: type: string - name: x-country-code 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 tmf620 product catalogue flows. content: application/json: schema: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_CrbtResponse' "400": description: "Bad request. Invalid request parameters, missing required\ \ fields, or validation errors." content: application/json: schema: $ref: '#/components/schemas/APIError' 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 "401": description: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "401" statusMessage: "Unauthorized. Invalid or missing authorization credentials,\ \ insufficient permissions, or authentication failure." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "403": description: Forbidden. Access denied. The request is valid but the server refuses to perform it. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "403" statusMessage: Forbidden. Access denied. The request is valid but the server refuses to perform it. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "404": description: Not found. The requested resource was not found or does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "404" statusMessage: Not found. The requested resource was not found or does not exist. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "500": description: "Internal server error. Unexpected system failure, database\ \ connectivity issues, or external service integration problems." content: application/json: schema: $ref: '#/components/schemas/APIError' example: statusCode: "500" statusMessage: "Internal server error. Unexpected system failure,\ \ database connectivity issues, or external service integration\ \ problems." supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "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' example: statusCode: "502" statusMessage: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z "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' example: statusCode: "503" statusMessage: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. supportMessage: API_ERROR transactionId: "1234567890" sequenceNo: "20250115120000001" timestamp: 2025-01-15T12:00:00Z deprecated: false components: schemas: com_mtn_aggregator_models_response_crbt_ProductSpecCharacteristicValue: title: ProductSpecCharacteristicValue type: object properties: value: type: string com_mtn_aggregator_models_response_crbt_ProductOffering: title: ProductOffering type: object properties: id: type: string name: type: string lifecycleStatus: type: string lastUpdate: type: string validFor: title: ValidFor type: object properties: endDateTime: type: string category: type: array items: title: ProductCategory type: object properties: '@referredType': type: string name: type: string productOfferingPrice: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ProductOfferingPrice' productOfferingCharacteristic: type: array items: title: ProductOfferingCharacteristic type: object properties: name: type: string characteristicValueSpecification: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ProductSpecCharacteristicValue' '@referredType': type: string com_mtn_aggregator_models_response_crbt_ValidFor: title: ValidFor type: object properties: endDateTime: type: string com_mtn_aggregator_models_product_response_ResponsePlanMetadata: title: ResponsePlanMetadata type: object properties: promoText: type: string validityType: type: string planMetadataId: type: string languageId: type: string planName: type: string description: type: string planId: type: string searchKeyword: type: string discountText: type: string com_mtn_madapi_crbt_models_response_RbtSearchContentData: title: RbtSearchContentData type: object properties: totalContent: type: integer format: int32 nextContentAvailable: type: boolean currentOffset: type: integer format: int32 content: type: array items: title: RbtContentItem type: object properties: contentPlan: type: string contentPrice: type: string contentPath: type: string contentValidity: type: string contentImagePath: type: string contentArtist: type: string contentAlbum: type: string contentType: type: string ccode: type: string shortCode: type: string genre: type: string subGenre: type: string subSubGenre: type: string cpName: type: string subscriptionPrice: type: string subscriptionValidity: type: string contentValidityType: type: string subscriptionValidityType: type: string currencyCode: type: string language: type: string orderInfo: type: string info: type: string uploadTime: type: string copyrightEndDate: type: string toneApprovalTime: type: string toneUpdatedTime: type: string cpCode: type: string artistNameLetter: type: string artistSex: type: string toneNameLetter: type: string toneCode: type: string hdTonePath: type: string contentLanguage: type: string status: type: string contentId: type: string contentInPlaylist: type: string title: type: string id: type: string contentList: type: string com_mtn_aggregator_models_response_apiGee_BundledProductSpecificationRelationship: title: BundledProductSpecificationRelationship type: object properties: '@type': type: string relationshipType: type: string com_mtn_aggregator_models_response_apiGee_ProductSpecCharacteristic: title: ProductSpecCharacteristic type: object properties: value: type: string unitOfMeasure: type: string '@type': type: string unit: type: string com_mtn_aggregator_models_response_apiGee_DclmProductOfferingPriceProdSpecCharacteristicValue: title: DclmProductOfferingPriceProdSpecCharacteristicValue type: object properties: valueType: type: string '@type': type: string value: type: string unitOfMeasure: type: string com_mtn_aggregator_models_response_apiGee_ProductOfferingPrice: title: ProductOfferingPrice type: object properties: value: type: string name: type: string unit: type: string type: type: string recurringChargePeriodType: type: string recurringChargePeriodLength: type: string constraint: title: Constraint type: object properties: productOfferingPrice: type: array items: title: ProductOfferingPriceData type: object properties: name: type: string value: type: string unit: type: string amount: type: string currency: type: string prodSpecCharValueUse: type: array items: title: ProdSpecCharValueUse type: object properties: productSpecCharacteristicValue: type: array items: title: ProductSpecCharacteristic type: object properties: value: type: string unitOfMeasure: type: string '@type': type: string unit: type: string productSpecCharacteristic: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_apiGee_ProductSpecCharacteristic' productSpecification: type: string name: type: string description: type: string valueType: type: string '@type': type: string price: title: Price type: object properties: unit: type: string value: type: string com_mtn_aggregator_models_product_response_ResponsePlanMsgList: title: ResponsePlanMsgList type: object properties: frequencyId: type: string isFrequencyRequest: type: string msgTypeId: type: string msgTypeName: type: string active: type: string frequency: type: string msgList: type: array items: title: ResponseMsgList type: object properties: msgTypeId: type: string renewalMessage: type: string msgId: type: string isFilled: type: string language: type: string languageCode: type: string message: type: string com_mtn_aggregator_models_response_crbt_ProductOfferingPrice: title: ProductOfferingPrice type: object properties: id: type: string priceType: type: string price: title: Price type: object properties: value: type: string unit: type: string unitOfMeasure: title: UnitOfMeasure type: object properties: amount: type: string units: type: string description: type: string prodSpecCharValueUse: type: array items: title: ProdSpecCharValueUse type: object properties: name: type: string productSpecCharacteristicValue: type: array items: title: ProductSpecCharacteristicValue type: object properties: value: type: string com_mtn_aggregator_models_product_response_PlanItemResponse: title: PlanItemResponse type: object properties: itemId: type: string itemType: type: string itemName: type: string price: type: string com_mtn_aggregator_models_response_crbt_CrbtCategory: title: CrbtCategory type: object properties: id: type: string title: type: string imagePath: type: string type: type: string name: type: string externalIdentifier: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ExternalIdentifier' subCategory: type: array items: title: SubCategory type: object properties: id: type: string name: type: string externalIdentifier: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ExternalIdentifier' parentId: type: string productOffering: type: array items: title: ProductOffering type: object properties: id: type: string name: type: string lifecycleStatus: type: string lastUpdate: type: string validFor: title: ValidFor type: object properties: endDateTime: type: string category: type: array items: title: ProductCategory type: object properties: '@referredType': type: string name: type: string productOfferingPrice: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ProductOfferingPrice' productOfferingCharacteristic: type: array items: title: ProductOfferingCharacteristic type: object properties: name: type: string characteristicValueSpecification: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ProductSpecCharacteristicValue' '@referredType': type: string com_mtn_aggregator_models_response_apiGee_ProdSpecCharValueUse: title: ProdSpecCharValueUse type: object properties: productSpecCharacteristicValue: type: array items: title: ProductSpecCharacteristic type: object properties: value: type: string unitOfMeasure: type: string '@type': type: string unit: type: string productSpecCharacteristic: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_apiGee_ProductSpecCharacteristic' productSpecification: type: string name: type: string description: type: string valueType: type: string '@type': type: string com_mtn_aggregator_models_product_response_CatalogResponseData: title: CatalogResponseData type: object properties: serviceType: type: string catalogType: type: string lifecycleStatus: type: string freeCounter: type: string type: type: string consentRequired: type: string consentKeywords: type: string thirdConsentRequired: type: string offNet: type: string id: type: string href: type: string shortCode: type: string cli: type: string serviceValidity: type: string fBreqFamilyPlan: type: string notificationReqFamilyPlan: type: string balanceQueryReq: type: string familyPlanReq: type: string version: type: string secondarySpName: type: string lastUpdate: type: string name: type: string promoContentMtLimited: type: string servicePausable: type: string status: type: string chargingMode: type: string secondarySpId: type: string access: type: string dndCategory: type: string description: type: string planLinked: type: string consentReqFreePlan: type: string callbackRegRequired: type: string baseType: type: string tenantName: type: string amountBasedChargingReq: type: string chargingReqFreePlan: type: string freeMOService: type: string directSubscription: type: string ready: type: string fallbackConsentRequired: type: string gatewayCharging: type: string requestType: type: string dndCheck: type: string serviceName: type: string priceQueryReq: type: string spId: type: string mtPushEnabled: type: string activeStatus: type: string typeOfService: type: string tenantId: type: string catalogCategory: type: string subMtCpDaily: type: string validFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string category: type: array items: title: Category type: object properties: referredType: type: string lifecycleStatus: type: string renewalPrice: type: string endDate: type: string discountAmount: type: string type: type: string validityPeriod: type: string allowInGrace: type: string promoText: type: string id: type: string href: type: string isSuspendChargeable: type: string resubsAllowed: type: string periodicityPlan: type: string level: type: string allowInSuspend: type: string preRenewalConsent: type: string version: type: string renewalPricePoint: type: string renewalPlanId: type: string isfallBackReq: type: string isOneOffReq: type: string validityType: type: string pricePoint: type: string failAction: type: string isRenFbReg: type: string name: type: string renewalLifecycleId: type: string startDate: type: string gracePeriod: type: string description: type: string isFoc: type: string baseType: type: string allowInParking: type: string discountText: type: string discountPercentage: type: string autoRenew: type: string subPrice: type: string microChargingEnabled: type: string isGraceChargeble: type: string parkingPeriod: type: string disableFallback: type: string deactivationMode: type: string isFamilyPlan: type: string periodicityPeriod: type: string haSubCategory: type: string renValPeriod: type: string lifecycleId: type: string isParkingChargeable: type: string suspendPeriod: type: string timeDurationList: type: array items: type: string focDaysList: type: array items: type: string specialDaysList: type: array items: type: string planMetadata: type: array items: title: ResponsePlanMetadata type: object properties: promoText: type: string validityType: type: string planMetadataId: type: string languageId: type: string planName: type: string description: type: string planId: type: string searchKeyword: type: string discountText: type: string planMsgList: type: array items: title: ResponsePlanMsgList type: object properties: frequencyId: type: string isFrequencyRequest: type: string msgTypeId: type: string msgTypeName: type: string active: type: string frequency: type: string msgList: type: array items: title: ResponseMsgList type: object properties: msgTypeId: type: string renewalMessage: type: string msgId: type: string isFilled: type: string language: type: string languageCode: type: string message: type: string subKeywords: type: string unsubKeywords: type: string flexibleCharging: type: string shortCode: type: string planItemList: type: array items: title: PlanItemResponse type: object properties: itemId: type: string itemType: type: string itemName: type: string price: type: string relatedParty: type: array items: title: RelatedParty type: object properties: role: type: string referredType: type: string name: type: string id: type: string type: type: string baseType: type: string serviceMsgList: type: array items: title: ResponseServiceMsgList type: object properties: frequencyId: type: string isFreqReq: type: string msgTypeId: type: string msgTypeName: type: string msgList: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_product_response_ResponseMsgList' isActive: type: string frequency: type: string dndCategoryMap: type: string serviceImageList: type: string isDirectCallbackReq: type: string userTypeMap: type: string serviceValidityMap: type: string noOfFamilyMembersList: type: array items: type: string isPackRequired: type: string primaryURL: type: string serviceMetadata: type: array items: title: ResponseServiceMetadata type: object properties: serviceDesc: type: string languageId: type: string serviceName: type: string keyword: type: string image: type: string languageName: type: string giftOptionEnabled: type: string typeOfServiceMap: title: ResponseTypeOfServiceMap type: object properties: R: type: string E: type: string com_mtn_aggregator_models_product_response_ResponseServiceMetadata: title: ResponseServiceMetadata type: object properties: serviceDesc: type: string languageId: type: string serviceName: type: string keyword: type: string image: type: string languageName: type: string com_mtn_aggregator_models_response_apiGee_ProductOfferingPriceData: title: ProductOfferingPriceData type: object properties: name: type: string value: type: string unit: type: string amount: type: string currency: type: string com_mtn_aggregator_models_response_apiGee_Constraint: title: Constraint type: object properties: productOfferingPrice: type: array items: title: ProductOfferingPriceData type: object properties: name: type: string value: type: string unit: type: string amount: type: string currency: type: string prodSpecCharValueUse: type: array items: title: ProdSpecCharValueUse type: object properties: productSpecCharacteristicValue: type: array items: title: ProductSpecCharacteristic type: object properties: value: type: string unitOfMeasure: type: string '@type': type: string unit: type: string productSpecCharacteristic: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_apiGee_ProductSpecCharacteristic' productSpecification: type: string name: type: string description: type: string valueType: type: string '@type': type: string com_mtn_aggregator_models_response_apiGee_ProductOffering: title: ProductOffering type: object properties: id: type: string productOfferingTerm: type: array items: title: ProductOfferingTerm type: object properties: validFor: title: OfferinTermValidFor type: object properties: amount: type: string unitofmeasure: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: value: type: string name: type: string unit: type: string type: type: string recurringChargePeriodType: type: string recurringChargePeriodLength: type: string constraint: title: Constraint type: object properties: productOfferingPrice: type: array items: title: ProductOfferingPriceData type: object properties: name: type: string value: type: string unit: type: string amount: type: string currency: type: string prodSpecCharValueUse: type: array items: title: ProdSpecCharValueUse type: object properties: productSpecCharacteristicValue: type: array items: title: ProductSpecCharacteristic type: object properties: value: type: string unitOfMeasure: type: string '@type': type: string unit: type: string productSpecCharacteristic: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_apiGee_ProductSpecCharacteristic' productSpecification: type: string name: type: string description: type: string valueType: type: string '@type': type: string price: title: Price type: object properties: unit: type: string value: type: string productSpecification: title: DclmProductSpecification type: object properties: id: type: string name: type: string lifecycleStatus: type: string '@type': type: string version: type: string href: type: string bundledProductSpecification: type: array items: title: DclmBundledProductSpecification type: object properties: id: type: string name: type: string description: type: string resourcePoolType: type: string lifeCycleStatus: type: string '@type': type: string productSpecCharacteristic: type: array items: title: BundeledProductSpecCharacteristic type: object properties: valueType: type: string '@type': type: string unitOfMeasure: type: string value: type: string productSpecCharacteristic: type: array items: title: DclmProductSpecificationProductSpecCharacteristic type: object properties: name: type: string description: type: string valueType: type: string minCardinality: type: string maxCardinality: type: string productSpecCharacteristicValue: type: array items: title: DclmProductOfferingPriceProdSpecCharacteristicValue type: object properties: valueType: type: string '@type': type: string value: type: string unitOfMeasure: type: string '@type': type: string productSpecificationRelationship: type: array items: title: BundledProductSpecificationRelationship type: object properties: '@type': type: string relationshipType: type: string lastUpdate: type: string com_mtn_aggregator_models_response_apiGee_ProductOfferingTerm: title: ProductOfferingTerm type: object properties: validFor: title: OfferinTermValidFor type: object properties: amount: type: string unitofmeasure: type: string com_mtn_aggregator_models_response_crbt_CrbtResponse: title: CrbtResponse type: object properties: code: type: string reason: type: string status: type: string message: type: string externalIdentifier: type: array items: title: ExternalIdentifier type: object properties: owner: type: string id: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: id: type: string priceType: type: string price: title: Price type: object properties: value: type: string unit: type: string unitOfMeasure: title: UnitOfMeasure type: object properties: amount: type: string units: type: string description: type: string prodSpecCharValueUse: type: array items: title: ProdSpecCharValueUse type: object properties: name: type: string productSpecCharacteristicValue: type: array items: title: ProductSpecCharacteristicValue type: object properties: value: type: string category: type: array items: title: CrbtCategory type: object properties: id: type: string title: type: string imagePath: type: string type: type: string name: type: string externalIdentifier: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ExternalIdentifier' subCategory: type: array items: title: SubCategory type: object properties: id: type: string name: type: string externalIdentifier: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ExternalIdentifier' parentId: type: string productOffering: type: array items: title: ProductOffering type: object properties: id: type: string name: type: string lifecycleStatus: type: string lastUpdate: type: string validFor: title: ValidFor type: object properties: endDateTime: type: string category: type: array items: title: ProductCategory type: object properties: '@referredType': type: string name: type: string productOfferingPrice: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ProductOfferingPrice' productOfferingCharacteristic: type: array items: title: ProductOfferingCharacteristic type: object properties: name: type: string characteristicValueSpecification: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ProductSpecCharacteristicValue' '@referredType': type: string productOffering: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ProductOffering' com_mtn_madapi_crbt_models_response_RbtContentItem: title: RbtContentItem type: object properties: contentPlan: type: string contentPrice: type: string contentPath: type: string contentValidity: type: string contentImagePath: type: string contentArtist: type: string contentAlbum: type: string contentType: type: string ccode: type: string shortCode: type: string genre: type: string subGenre: type: string subSubGenre: type: string cpName: type: string subscriptionPrice: type: string subscriptionValidity: type: string contentValidityType: type: string subscriptionValidityType: type: string currencyCode: type: string language: type: string orderInfo: type: string info: type: string uploadTime: type: string copyrightEndDate: type: string toneApprovalTime: type: string toneUpdatedTime: type: string cpCode: type: string artistNameLetter: type: string artistSex: type: string toneNameLetter: type: string toneCode: type: string hdTonePath: type: string contentLanguage: type: string status: type: string contentId: type: string contentInPlaylist: type: string title: type: string id: type: string APIError: title: APIError required: - statusCode - statusMessage type: object properties: statusCode: type: string description: Error status code statusMessage: type: string description: Human-readable error message supportMessage: type: string description: Technical support message or error code for troubleshooting transactionId: type: string description: Transaction identifier for tracking and correlation sequenceNo: type: string description: Sequence number for request tracking timestamp: type: string description: Error timestamp in ISO 8601 format format: date-time path: type: string description: API endpoint path where the error occurred method: type: string description: HTTP method of the request that caused the error downstreamStatusCode: type: string description: Downstream service error code if applicable description: Generic MADAPI error response structure com_mtn_aggregator_models_response_apiGee_DclmBundledProductSpecification: title: DclmBundledProductSpecification type: object properties: id: type: string name: type: string description: type: string resourcePoolType: type: string lifeCycleStatus: type: string '@type': type: string productSpecCharacteristic: type: array items: title: BundeledProductSpecCharacteristic type: object properties: valueType: type: string '@type': type: string unitOfMeasure: type: string value: type: string com_mtn_aggregator_models_response_apiGee_BundeledProductSpecCharacteristic: title: BundeledProductSpecCharacteristic type: object properties: valueType: type: string '@type': type: string unitOfMeasure: type: string value: type: string com_mtn_aggregator_models_response_apiGee_DclmProductSpecification: title: DclmProductSpecification type: object properties: id: type: string name: type: string lifecycleStatus: type: string '@type': type: string version: type: string href: type: string bundledProductSpecification: type: array items: title: DclmBundledProductSpecification type: object properties: id: type: string name: type: string description: type: string resourcePoolType: type: string lifeCycleStatus: type: string '@type': type: string productSpecCharacteristic: type: array items: title: BundeledProductSpecCharacteristic type: object properties: valueType: type: string '@type': type: string unitOfMeasure: type: string value: type: string productSpecCharacteristic: type: array items: title: DclmProductSpecificationProductSpecCharacteristic type: object properties: name: type: string description: type: string valueType: type: string minCardinality: type: string maxCardinality: type: string productSpecCharacteristicValue: type: array items: title: DclmProductOfferingPriceProdSpecCharacteristicValue type: object properties: valueType: type: string '@type': type: string value: type: string unitOfMeasure: type: string '@type': type: string productSpecificationRelationship: type: array items: title: BundledProductSpecificationRelationship type: object properties: '@type': type: string relationshipType: type: string lastUpdate: type: string com_mtn_aggregator_models_product_response_ProductCatalogResponse: title: ProductCatalogResponse type: object properties: offset: type: string resultCode: type: string statusCode: type: string statusMessage: type: string next: type: string previous: type: string pageSize: type: string responseCount: type: string resultDescription: type: string transactionId: type: string data: type: array items: title: CatalogResponseData type: object properties: serviceType: type: string catalogType: type: string lifecycleStatus: type: string freeCounter: type: string type: type: string consentRequired: type: string consentKeywords: type: string thirdConsentRequired: type: string offNet: type: string id: type: string href: type: string shortCode: type: string cli: type: string serviceValidity: type: string fBreqFamilyPlan: type: string notificationReqFamilyPlan: type: string balanceQueryReq: type: string familyPlanReq: type: string version: type: string secondarySpName: type: string lastUpdate: type: string name: type: string promoContentMtLimited: type: string servicePausable: type: string status: type: string chargingMode: type: string secondarySpId: type: string access: type: string dndCategory: type: string description: type: string planLinked: type: string consentReqFreePlan: type: string callbackRegRequired: type: string baseType: type: string tenantName: type: string amountBasedChargingReq: type: string chargingReqFreePlan: type: string freeMOService: type: string directSubscription: type: string ready: type: string fallbackConsentRequired: type: string gatewayCharging: type: string requestType: type: string dndCheck: type: string serviceName: type: string priceQueryReq: type: string spId: type: string mtPushEnabled: type: string activeStatus: type: string typeOfService: type: string tenantId: type: string catalogCategory: type: string subMtCpDaily: type: string validFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string category: type: array items: title: Category type: object properties: referredType: type: string lifecycleStatus: type: string renewalPrice: type: string endDate: type: string discountAmount: type: string type: type: string validityPeriod: type: string allowInGrace: type: string promoText: type: string id: type: string href: type: string isSuspendChargeable: type: string resubsAllowed: type: string periodicityPlan: type: string level: type: string allowInSuspend: type: string preRenewalConsent: type: string version: type: string renewalPricePoint: type: string renewalPlanId: type: string isfallBackReq: type: string isOneOffReq: type: string validityType: type: string pricePoint: type: string failAction: type: string isRenFbReg: type: string name: type: string renewalLifecycleId: type: string startDate: type: string gracePeriod: type: string description: type: string isFoc: type: string baseType: type: string allowInParking: type: string discountText: type: string discountPercentage: type: string autoRenew: type: string subPrice: type: string microChargingEnabled: type: string isGraceChargeble: type: string parkingPeriod: type: string disableFallback: type: string deactivationMode: type: string isFamilyPlan: type: string periodicityPeriod: type: string haSubCategory: type: string renValPeriod: type: string lifecycleId: type: string isParkingChargeable: type: string suspendPeriod: type: string timeDurationList: type: array items: type: string focDaysList: type: array items: type: string specialDaysList: type: array items: type: string planMetadata: type: array items: title: ResponsePlanMetadata type: object properties: promoText: type: string validityType: type: string planMetadataId: type: string languageId: type: string planName: type: string description: type: string planId: type: string searchKeyword: type: string discountText: type: string planMsgList: type: array items: title: ResponsePlanMsgList type: object properties: frequencyId: type: string isFrequencyRequest: type: string msgTypeId: type: string msgTypeName: type: string active: type: string frequency: type: string msgList: type: array items: title: ResponseMsgList type: object properties: msgTypeId: type: string renewalMessage: type: string msgId: type: string isFilled: type: string language: type: string languageCode: type: string message: type: string subKeywords: type: string unsubKeywords: type: string flexibleCharging: type: string shortCode: type: string planItemList: type: array items: title: PlanItemResponse type: object properties: itemId: type: string itemType: type: string itemName: type: string price: type: string relatedParty: type: array items: title: RelatedParty type: object properties: role: type: string referredType: type: string name: type: string id: type: string type: type: string baseType: type: string serviceMsgList: type: array items: title: ResponseServiceMsgList type: object properties: frequencyId: type: string isFreqReq: type: string msgTypeId: type: string msgTypeName: type: string msgList: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_product_response_ResponseMsgList' isActive: type: string frequency: type: string dndCategoryMap: type: string serviceImageList: type: string isDirectCallbackReq: type: string userTypeMap: type: string serviceValidityMap: type: string noOfFamilyMembersList: type: array items: type: string isPackRequired: type: string primaryURL: type: string serviceMetadata: type: array items: title: ResponseServiceMetadata type: object properties: serviceDesc: type: string languageId: type: string serviceName: type: string keyword: type: string image: type: string languageName: type: string giftOptionEnabled: type: string typeOfServiceMap: title: ResponseTypeOfServiceMap type: object properties: R: type: string E: type: string com_mtn_aggregator_models_product_response_Category: title: Category type: object properties: referredType: type: string lifecycleStatus: type: string renewalPrice: type: string endDate: type: string discountAmount: type: string type: type: string validityPeriod: type: string allowInGrace: type: string promoText: type: string id: type: string href: type: string isSuspendChargeable: type: string resubsAllowed: type: string periodicityPlan: type: string level: type: string allowInSuspend: type: string preRenewalConsent: type: string version: type: string renewalPricePoint: type: string renewalPlanId: type: string isfallBackReq: type: string isOneOffReq: type: string validityType: type: string pricePoint: type: string failAction: type: string isRenFbReg: type: string name: type: string renewalLifecycleId: type: string startDate: type: string gracePeriod: type: string description: type: string isFoc: type: string baseType: type: string allowInParking: type: string discountText: type: string discountPercentage: type: string autoRenew: type: string subPrice: type: string microChargingEnabled: type: string isGraceChargeble: type: string parkingPeriod: type: string disableFallback: type: string deactivationMode: type: string isFamilyPlan: type: string periodicityPeriod: type: string haSubCategory: type: string renValPeriod: type: string lifecycleId: type: string isParkingChargeable: type: string suspendPeriod: type: string timeDurationList: type: array items: type: string focDaysList: type: array items: type: string specialDaysList: type: array items: type: string planMetadata: type: array items: title: ResponsePlanMetadata type: object properties: promoText: type: string validityType: type: string planMetadataId: type: string languageId: type: string planName: type: string description: type: string planId: type: string searchKeyword: type: string discountText: type: string planMsgList: type: array items: title: ResponsePlanMsgList type: object properties: frequencyId: type: string isFrequencyRequest: type: string msgTypeId: type: string msgTypeName: type: string active: type: string frequency: type: string msgList: type: array items: title: ResponseMsgList type: object properties: msgTypeId: type: string renewalMessage: type: string msgId: type: string isFilled: type: string language: type: string languageCode: type: string message: type: string subKeywords: type: string unsubKeywords: type: string flexibleCharging: type: string shortCode: type: string planItemList: type: array items: title: PlanItemResponse type: object properties: itemId: type: string itemType: type: string itemName: type: string price: type: string com_mtn_aggregator_models_product_response_RelatedParty: title: RelatedParty type: object properties: role: type: string referredType: type: string name: type: string id: type: string type: type: string baseType: type: string com_mtn_aggregator_models_response_apiGee_OfferinTermValidFor: title: OfferinTermValidFor type: object properties: amount: type: string unitofmeasure: type: string com_mtn_aggregator_models_response_apiGee_CatalogByIdData: title: CatalogByIdData type: object properties: name: type: string description: type: string businessType: type: string version: type: string category: title: CatalogByIdCategory type: object properties: productoffering: title: ProductOffering type: object properties: id: type: string productOfferingTerm: type: array items: title: ProductOfferingTerm type: object properties: validFor: title: OfferinTermValidFor type: object properties: amount: type: string unitofmeasure: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: value: type: string name: type: string unit: type: string type: type: string recurringChargePeriodType: type: string recurringChargePeriodLength: type: string constraint: title: Constraint type: object properties: productOfferingPrice: type: array items: title: ProductOfferingPriceData type: object properties: name: type: string value: type: string unit: type: string amount: type: string currency: type: string prodSpecCharValueUse: type: array items: title: ProdSpecCharValueUse type: object properties: productSpecCharacteristicValue: type: array items: title: ProductSpecCharacteristic type: object properties: value: type: string unitOfMeasure: type: string '@type': type: string unit: type: string productSpecCharacteristic: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_apiGee_ProductSpecCharacteristic' productSpecification: type: string name: type: string description: type: string valueType: type: string '@type': type: string price: title: Price type: object properties: unit: type: string value: type: string productSpecification: title: DclmProductSpecification type: object properties: id: type: string name: type: string lifecycleStatus: type: string '@type': type: string version: type: string href: type: string bundledProductSpecification: type: array items: title: DclmBundledProductSpecification type: object properties: id: type: string name: type: string description: type: string resourcePoolType: type: string lifeCycleStatus: type: string '@type': type: string productSpecCharacteristic: type: array items: title: BundeledProductSpecCharacteristic type: object properties: valueType: type: string '@type': type: string unitOfMeasure: type: string value: type: string productSpecCharacteristic: type: array items: title: DclmProductSpecificationProductSpecCharacteristic type: object properties: name: type: string description: type: string valueType: type: string minCardinality: type: string maxCardinality: type: string productSpecCharacteristicValue: type: array items: title: DclmProductOfferingPriceProdSpecCharacteristicValue type: object properties: valueType: type: string '@type': type: string value: type: string unitOfMeasure: type: string '@type': type: string productSpecificationRelationship: type: array items: title: BundledProductSpecificationRelationship type: object properties: '@type': type: string relationshipType: type: string lastUpdate: type: string com_mtn_aggregator_models_response_apiGee_CatalogByIdCategory: title: CatalogByIdCategory type: object properties: productoffering: title: ProductOffering type: object properties: id: type: string productOfferingTerm: type: array items: title: ProductOfferingTerm type: object properties: validFor: title: OfferinTermValidFor type: object properties: amount: type: string unitofmeasure: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: value: type: string name: type: string unit: type: string type: type: string recurringChargePeriodType: type: string recurringChargePeriodLength: type: string constraint: title: Constraint type: object properties: productOfferingPrice: type: array items: title: ProductOfferingPriceData type: object properties: name: type: string value: type: string unit: type: string amount: type: string currency: type: string prodSpecCharValueUse: type: array items: title: ProdSpecCharValueUse type: object properties: productSpecCharacteristicValue: type: array items: title: ProductSpecCharacteristic type: object properties: value: type: string unitOfMeasure: type: string '@type': type: string unit: type: string productSpecCharacteristic: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_apiGee_ProductSpecCharacteristic' productSpecification: type: string name: type: string description: type: string valueType: type: string '@type': type: string price: title: Price type: object properties: unit: type: string value: type: string productSpecification: title: DclmProductSpecification type: object properties: id: type: string name: type: string lifecycleStatus: type: string '@type': type: string version: type: string href: type: string bundledProductSpecification: type: array items: title: DclmBundledProductSpecification type: object properties: id: type: string name: type: string description: type: string resourcePoolType: type: string lifeCycleStatus: type: string '@type': type: string productSpecCharacteristic: type: array items: title: BundeledProductSpecCharacteristic type: object properties: valueType: type: string '@type': type: string unitOfMeasure: type: string value: type: string productSpecCharacteristic: type: array items: title: DclmProductSpecificationProductSpecCharacteristic type: object properties: name: type: string description: type: string valueType: type: string minCardinality: type: string maxCardinality: type: string productSpecCharacteristicValue: type: array items: title: DclmProductOfferingPriceProdSpecCharacteristicValue type: object properties: valueType: type: string '@type': type: string value: type: string unitOfMeasure: type: string '@type': type: string productSpecificationRelationship: type: array items: title: BundledProductSpecificationRelationship type: object properties: '@type': type: string relationshipType: type: string lastUpdate: type: string com_mtn_aggregator_models_response_crbt_ProductCategory: title: ProductCategory type: object properties: '@referredType': type: string name: type: string com_mtn_madapi_crbt_models_response_RbtSearchContentBackendResponse: title: RbtSearchContentBackendResponse type: object properties: respCode: type: string respMsg: type: string resultCode: type: integer format: int32 result: type: string transactionId: type: string childTrId: type: string title: type: string artist: type: string movie: type: string album: type: string nametune: type: string data: title: RbtSearchContentData type: object properties: totalContent: type: integer format: int32 nextContentAvailable: type: boolean currentOffset: type: integer format: int32 content: type: array items: title: RbtContentItem type: object properties: contentPlan: type: string contentPrice: type: string contentPath: type: string contentValidity: type: string contentImagePath: type: string contentArtist: type: string contentAlbum: type: string contentType: type: string ccode: type: string shortCode: type: string genre: type: string subGenre: type: string subSubGenre: type: string cpName: type: string subscriptionPrice: type: string subscriptionValidity: type: string contentValidityType: type: string subscriptionValidityType: type: string currencyCode: type: string language: type: string orderInfo: type: string info: type: string uploadTime: type: string copyrightEndDate: type: string toneApprovalTime: type: string toneUpdatedTime: type: string cpCode: type: string artistNameLetter: type: string artistSex: type: string toneNameLetter: type: string toneCode: type: string hdTonePath: type: string contentLanguage: type: string status: type: string contentId: type: string contentInPlaylist: type: string title: type: string id: type: string contentList: type: string com_mtn_aggregator_models_response_crbt_SubCategory: title: SubCategory type: object properties: id: type: string name: type: string externalIdentifier: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ExternalIdentifier' com_mtn_aggregator_models_response_crbt_Price: title: Price type: object properties: value: type: string unit: type: string com_mtn_aggregator_models_product_response_ResponseMsgList: title: ResponseMsgList type: object properties: msgTypeId: type: string renewalMessage: type: string msgId: type: string isFilled: type: string language: type: string languageCode: type: string message: type: string com_mtn_aggregator_models_response_apiGee_Price: title: Price type: object properties: unit: type: string value: type: string com_mtn_aggregator_models_response_crbt_ExternalIdentifier: title: ExternalIdentifier type: object properties: owner: type: string id: type: string com_mtn_aggregator_models_response_apiGee_DclmProductSpecificationProductSpecCharacteristic: title: DclmProductSpecificationProductSpecCharacteristic type: object properties: name: type: string description: type: string valueType: type: string minCardinality: type: string maxCardinality: type: string productSpecCharacteristicValue: type: array items: title: DclmProductOfferingPriceProdSpecCharacteristicValue type: object properties: valueType: type: string '@type': type: string value: type: string unitOfMeasure: type: string '@type': type: string com_mtn_aggregator_models_product_response_ResponseTypeOfServiceMap: title: ResponseTypeOfServiceMap type: object properties: R: type: string E: type: string com_mtn_aggregator_models_response_crbt_ProdSpecCharValueUse: title: ProdSpecCharValueUse type: object properties: name: type: string productSpecCharacteristicValue: type: array items: title: ProductSpecCharacteristicValue type: object properties: value: type: string com_mtn_aggregator_models_product_response_ResponseServiceMsgList: title: ResponseServiceMsgList type: object properties: frequencyId: type: string isFreqReq: type: string msgTypeId: type: string msgTypeName: type: string msgList: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_product_response_ResponseMsgList' isActive: type: string frequency: type: string com_mtn_aggregator_models_product_response_ValidFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string com_mtn_aggregator_models_response_apiGee_CategoryByIdResponse: title: CategoryByIdResponse type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string catalog: title: CatalogByIdData type: object properties: name: type: string description: type: string businessType: type: string version: type: string category: title: CatalogByIdCategory type: object properties: productoffering: title: ProductOffering type: object properties: id: type: string productOfferingTerm: type: array items: title: ProductOfferingTerm type: object properties: validFor: title: OfferinTermValidFor type: object properties: amount: type: string unitofmeasure: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: value: type: string name: type: string unit: type: string type: type: string recurringChargePeriodType: type: string recurringChargePeriodLength: type: string constraint: title: Constraint type: object properties: productOfferingPrice: type: array items: title: ProductOfferingPriceData type: object properties: name: type: string value: type: string unit: type: string amount: type: string currency: type: string prodSpecCharValueUse: type: array items: title: ProdSpecCharValueUse type: object properties: productSpecCharacteristicValue: type: array items: title: ProductSpecCharacteristic type: object properties: value: type: string unitOfMeasure: type: string '@type': type: string unit: type: string productSpecCharacteristic: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_apiGee_ProductSpecCharacteristic' productSpecification: type: string name: type: string description: type: string valueType: type: string '@type': type: string price: title: Price type: object properties: unit: type: string value: type: string productSpecification: title: DclmProductSpecification type: object properties: id: type: string name: type: string lifecycleStatus: type: string '@type': type: string version: type: string href: type: string bundledProductSpecification: type: array items: title: DclmBundledProductSpecification type: object properties: id: type: string name: type: string description: type: string resourcePoolType: type: string lifeCycleStatus: type: string '@type': type: string productSpecCharacteristic: type: array items: title: BundeledProductSpecCharacteristic type: object properties: valueType: type: string '@type': type: string unitOfMeasure: type: string value: type: string productSpecCharacteristic: type: array items: title: DclmProductSpecificationProductSpecCharacteristic type: object properties: name: type: string description: type: string valueType: type: string minCardinality: type: string maxCardinality: type: string productSpecCharacteristicValue: type: array items: title: DclmProductOfferingPriceProdSpecCharacteristicValue type: object properties: valueType: type: string '@type': type: string value: type: string unitOfMeasure: type: string '@type': type: string productSpecificationRelationship: type: array items: title: BundledProductSpecificationRelationship type: object properties: '@type': type: string relationshipType: type: string lastUpdate: type: string timestamp: type: string status: type: string error: type: string message: type: string path: type: string com_mtn_aggregator_models_response_crbt_UnitOfMeasure: title: UnitOfMeasure type: object properties: amount: type: string units: type: string com_mtn_aggregator_models_response_crbt_ProductOfferingCharacteristic: title: ProductOfferingCharacteristic type: object properties: name: type: string characteristicValueSpecification: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_crbt_ProductSpecCharacteristicValue' 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