openapi: 3.0.1 info: title: TMF676 Payment Management description: "The TMF676 Payment Management Aggregator API provides comprehensive\ \ payment management capabilities following TM Forum TMF676 standards. This service\ \ enables payment processing, payment method management, payment status tracking,\ \ and payment reconciliation operations. It serves as the central aggregator for\ \ all payment-related operations, integrating with various payment systems and\ \ providers across the MTN ecosystem." license: name: MADAPI url: https://developers.mtn.com/ version: 3.0.0 - Last updated date:2026-07-29 11:27:02 servers: - url: https://api.mtn.com/v1 description: Production Server security: - OAuth2: [] tags: - name: TMF676 Payment Management Aggregator paths: /payment: get: tags: - TMF676 Payment Management Aggregator summary: Retrieve OTT tax status details description: "Fetches the OTT tax status details for a specific customer from\ \ the configured CIS system, forwarding the request to downstream services\ \ while preserving the optional transaction identifier." operationId: TMF676PaymentManagementAggregatorService_get_getOTTStatus_payment parameters: - name: clientTransactionId in: header required: false schema: type: string - name: countryCode in: header required: false schema: type: string - name: customerId in: query required: false schema: type: string - name: limit in: query required: false schema: type: string - name: msisdn in: query required: false schema: type: string - name: offset in: query required: false schema: type: string - name: ottTaxStatus in: query required: true schema: type: string - name: requestCategory in: header required: false schema: type: string - name: subscriptionId in: query required: false schema: type: string - name: targetSystem 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 TMF676 Payment Management flows. content: application/json: schema: title: Payment type: object properties: id: type: string href: type: string authorizationCode: type: string correlatorId: type: string description: type: string name: type: string paymentDate: type: string status: type: string statusDate: type: string account: title: Account type: object properties: id: type: string href: type: string description: type: string name: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string entityLevel: type: string role: type: string amount: title: Amount type: object properties: unit: type: string value: type: integer format: int32 amount: type: integer format: int32 units: type: string channel: title: Channel type: object properties: id: type: string name: type: string role: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string '@baseType': type: string '@type': type: string payer: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Account' paymentItem: type: array items: title: PaymentItem type: object properties: id: type: string amount: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Amount' item: title: Item type: object properties: id: type: string href: type: string customFields: title: CustomFields type: object properties: productOrderGroup: type: array items: type: string registrationType: type: string moMoFlag: type: boolean assignType: type: string externalSystem: type: array items: title: ExternalSystem type: object properties: id: type: string system: type: string '@type': type: string '@baseType': type: string '@baseType': type: string '@type': type: string '@schemaLocation': type: string request: title: Request type: object properties: id: type: string '@referredType': type: string '@baseType': type: string '@schemaLocation': type: string href: type: string createdDate: type: string format: date-time orderItem: type: array items: title: OrderItem type: object properties: id: type: string href: type: string action: type: string actionSubType: type: string productOffering: title: ProductOffering type: object properties: id: type: string href: type: string name: type: string code: type: string '@type': type: string '@schemaLocation': type: string externalSystem: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ExternalSystem' category: type: array items: title: Category type: object properties: name: type: string version: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string productSpecification: title: ProductSpecification type: object properties: id: type: string '@referredType': type: string '@type': type: string '@baseType': type: string '@schemaLocation': type: string href: type: string name: type: string version: type: string technology: type: array items: type: string product: title: Product type: object properties: id: type: string href: type: string customFields: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_CustomFields' externalSystem: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ExternalSystem' name: type: string startDate: type: string format: date-time status: type: string createdDate: type: string format: date-time modifiedDate: type: string format: date-time businessType: type: string technology: type: string publicIdentifier: type: string productSpecification: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ProductSpecification' productOffering: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ProductOffering' productOrder: type: array items: title: ProductOrder type: object properties: orderItemId: type: string orderItemAction: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string orderItemActionSubType: type: string channel: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Channel' relatedParty: type: array items: title: RelatedParty type: object properties: role: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string name: type: string engagedParty: title: EngagedParty type: object properties: id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string '@baseType': type: string '@type': type: string productRelationship: type: array items: title: ProductRelationship type: object properties: product: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Product' type: type: string relationshipType: type: string place: type: array items: title: Place type: object properties: role: type: string '@type': type: string productPrice: type: array items: title: ProductPrice type: object properties: href: type: string name: type: string description: type: string priceType: type: string recurringChargePeriod: type: string price: title: Price type: object properties: taxIncludedAmount: title: TaxIncludedAmount type: object properties: value: type: string unit: type: string dutyFreeAmount: title: DutyFreeAmount type: object properties: value: type: string unit: type: string taxRate: type: integer format: int32 tax: type: array items: title: Tax type: object properties: value: type: integer format: int32 unit: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: id: type: string href: type: string name: type: string '@schemaLocation': type: string '@schemaLocation': type: string productTerm: type: array items: title: ProductTerm type: object properties: description: type: string status: type: string validFor: title: ValidFor type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time '@type': type: string activationDate: type: string format: date-time suspensions: type: array items: title: Suspension type: object properties: id: type: string reason: type: string interactionDate: title: InteractionDate type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time suspensionType: type: string imsiNumber: type: string simNumber: type: string '@baseType': type: string '@type': type: string '@schemaLocation': type: string isCustomerVisible: type: boolean LoB: type: string xDir: type: string isPrimaryMSISDN: type: boolean '@referredType': type: string modifiable: type: boolean '@schemaLocation': type: string channel: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Channel' modifiedDate: type: string format: date-time state: type: string relatedParty: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_RelatedParty' modifiable: type: boolean orderDate: type: string format: date-time cancellable: type: boolean requestedStartDate: type: string format: date-time name: type: string '@referredType': type: string taxAmount: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Amount' totalAmount: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Amount' '@baseType': type: string '@schemaLocation': type: string '@type': type: string paymentMethod: title: PaymentMethod type: object properties: id: type: string href: type: string description: type: string isPreferred: type: boolean name: type: string status: type: string statusDate: type: string account: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Account' relatedParty: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_RelatedParty' validFor: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ValidFor' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string details: title: Details type: object properties: mobileNumber: type: string reference: type: string preferred: type: boolean taxAmount: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Amount' totalAmount: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Amount' '@baseType': type: string '@schemaLocation': type: string '@type': type: string code: type: string reason: type: string message: type: string referenceError: type: string paidDays: type: string consent: 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 post: tags: - TMF676 Payment Management Aggregator summary: Process customer payment via MoMo description: "Initiates a customer payment using MTN MoMo channels, generating\ \ or reusing a transaction reference, logging the full request payload, and\ \ delegating downstream payment execution with comprehensive response auditing." operationId: TMF676PaymentManagementAggregatorService_post_payViaMomo_payment parameters: - name: countryCode in: header required: false schema: type: string - name: requestCategory 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Payment' 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 TMF676 Payment Management flows. content: application/json: schema: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Payment' "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 /payment/{id}: get: tags: - TMF676 Payment Management Aggregator summary: Get transaction details by identifier description: "Retrieves detailed information for a specific payment transaction,\ \ invoking downstream services with a generated correlation identifier and\ \ capturing the full service response for auditability and traceability." operationId: TMF676PaymentManagementAggregatorService_get_getTransactionDetails_paymentid parameters: - name: countryCode in: header required: false schema: type: string - name: id in: path required: true schema: type: string - name: requestType 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 TMF676 Payment Management flows. content: application/json: schema: title: DetailsResponse type: object properties: transactionType: type: string transactionKey: type: string transactionNumber: type: string additionalInformation: type: array items: title: AdditionalInformation type: object properties: key: type: string value: type: string adjustedAmount: title: AdjustedAmount type: object properties: value: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdjustedAmount' correlatorId: type: string debitCreditArticle: title: DebitCreditArticle type: object properties: name: type: string type: type: string financialPosting: title: FinancialPosting type: object properties: reference: type: string status: type: string invoiceDetails: title: InvoiceDetails type: object properties: billRunId: type: string billCycleId: type: string billingAccountId: type: string id: type: string dueDate: type: string billStartDate: type: string billEndDate: type: string payableAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdjustedAmount' userDetails: title: UserDetails type: object properties: userName: type: string location: type: string uploadedBy: type: string uraDetails: title: UraDetails type: object properties: oriInvoiceId: type: string oriInvoiceNo: type: string qrCode: type: string digitalSignature: type: string crDbFDN: type: string paymentItem: type: array items: title: PaymentItem type: object properties: paymentMethod: title: PaymentMethod type: object properties: name: type: string financialInstitutionBranch: type: string financialInstitutionCode: type: string paymentNumber: type: string paymentDate: type: string cardType: type: string paymentReference: type: string mobileNumber: type: string payeeNote: type: string eftIssuer: type: string paymentTransactionID: type: string cardIssuer: type: string cardNumber: type: string cardExpiryDate: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdjustedAmount' foreignCurrencyAmount: title: ForeignCurrencyAmount type: object properties: value: type: string unit: type: string exchangeRate: type: string item: title: Item type: object properties: id: type: string additionalInformation: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdditionalInformation' description: type: string rules: type: array items: title: Rules type: object properties: ruleCode: type: string criteria: type: string criteriaValues: type: array items: title: CriteriaValues type: object properties: value: type: string unit: type: string status: type: string statusDate: type: string taxAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdjustedAmount' transactionDate: type: string channel: title: Channel type: object properties: name: type: string totalAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdjustedAmount' taxBreakUp: type: array items: title: TaxBreakUp type: object properties: name: type: string taxAmount: type: string id: type: string payer: title: Payer type: object properties: name: type: string contact: title: Contact type: object properties: email: type: string mobileNumber: 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_madapi_tecnotree_models_responses_ValidFor: title: ValidFor type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time com_mtn_madapi_tecnotree_models_responses_ProductRelationship: title: ProductRelationship type: object properties: product: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Product' type: type: string relationshipType: type: string com_mtn_madapi_tecnotree_models_responses_Suspension: title: Suspension type: object properties: id: type: string reason: type: string interactionDate: title: InteractionDate type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time suspensionType: type: string com_mtn_madapi_tecnotree_models_responses_Place: title: Place type: object properties: role: type: string '@type': type: string com_mtn_aggregator_models_response_details_PaymentMethod: title: PaymentMethod type: object properties: name: type: string financialInstitutionBranch: type: string financialInstitutionCode: type: string paymentNumber: type: string paymentDate: type: string cardType: type: string paymentReference: type: string mobileNumber: type: string payeeNote: type: string eftIssuer: type: string paymentTransactionID: type: string cardIssuer: type: string cardNumber: type: string cardExpiryDate: type: string com_mtn_aggregator_models_response_details_TaxBreakUp: title: TaxBreakUp type: object properties: name: type: string taxAmount: type: string com_mtn_aggregator_models_response_details_UraDetails: title: UraDetails type: object properties: oriInvoiceId: type: string oriInvoiceNo: type: string qrCode: type: string digitalSignature: type: string crDbFDN: type: string com_mtn_madapi_tecnotree_models_responses_ProductTerm: title: ProductTerm type: object properties: description: type: string status: type: string validFor: title: ValidFor type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time '@type': 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_details_FinancialPosting: title: FinancialPosting type: object properties: reference: type: string status: type: string com_mtn_madapi_tecnotree_models_requests_OrderItem: title: OrderItem type: object properties: id: type: string href: type: string action: type: string actionSubType: type: string productOffering: title: ProductOffering type: object properties: id: type: string href: type: string name: type: string code: type: string '@type': type: string '@schemaLocation': type: string externalSystem: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ExternalSystem' category: type: array items: title: Category type: object properties: name: type: string version: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string productSpecification: title: ProductSpecification type: object properties: id: type: string '@referredType': type: string '@type': type: string '@baseType': type: string '@schemaLocation': type: string href: type: string name: type: string version: type: string technology: type: array items: type: string product: title: Product type: object properties: id: type: string href: type: string customFields: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_CustomFields' externalSystem: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ExternalSystem' name: type: string startDate: type: string format: date-time status: type: string createdDate: type: string format: date-time modifiedDate: type: string format: date-time businessType: type: string technology: type: string publicIdentifier: type: string productSpecification: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ProductSpecification' productOffering: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ProductOffering' productOrder: type: array items: title: ProductOrder type: object properties: orderItemId: type: string orderItemAction: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string orderItemActionSubType: type: string channel: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Channel' relatedParty: type: array items: title: RelatedParty type: object properties: role: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string name: type: string engagedParty: title: EngagedParty type: object properties: id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string '@baseType': type: string '@type': type: string productRelationship: type: array items: title: ProductRelationship type: object properties: product: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Product' type: type: string relationshipType: type: string place: type: array items: title: Place type: object properties: role: type: string '@type': type: string productPrice: type: array items: title: ProductPrice type: object properties: href: type: string name: type: string description: type: string priceType: type: string recurringChargePeriod: type: string price: title: Price type: object properties: taxIncludedAmount: title: TaxIncludedAmount type: object properties: value: type: string unit: type: string dutyFreeAmount: title: DutyFreeAmount type: object properties: value: type: string unit: type: string taxRate: type: integer format: int32 tax: type: array items: title: Tax type: object properties: value: type: integer format: int32 unit: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: id: type: string href: type: string name: type: string '@schemaLocation': type: string '@schemaLocation': type: string productTerm: type: array items: title: ProductTerm type: object properties: description: type: string status: type: string validFor: title: ValidFor type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time '@type': type: string activationDate: type: string format: date-time suspensions: type: array items: title: Suspension type: object properties: id: type: string reason: type: string interactionDate: title: InteractionDate type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time suspensionType: type: string imsiNumber: type: string simNumber: type: string '@baseType': type: string '@type': type: string '@schemaLocation': type: string isCustomerVisible: type: boolean LoB: type: string xDir: type: string isPrimaryMSISDN: type: boolean '@referredType': type: string modifiable: type: boolean '@schemaLocation': type: string com_mtn_madapi_tecnotree_models_responses_DutyFreeAmount: title: DutyFreeAmount type: object properties: value: type: string unit: type: string com_mtn_madapi_tecnotree_models_requests_Item: title: Item type: object properties: id: type: string href: type: string customFields: title: CustomFields type: object properties: productOrderGroup: type: array items: type: string registrationType: type: string moMoFlag: type: boolean assignType: type: string externalSystem: type: array items: title: ExternalSystem type: object properties: id: type: string system: type: string '@type': type: string '@baseType': type: string '@baseType': type: string '@type': type: string '@schemaLocation': type: string request: title: Request type: object properties: id: type: string '@referredType': type: string '@baseType': type: string '@schemaLocation': type: string href: type: string createdDate: type: string format: date-time orderItem: type: array items: title: OrderItem type: object properties: id: type: string href: type: string action: type: string actionSubType: type: string productOffering: title: ProductOffering type: object properties: id: type: string href: type: string name: type: string code: type: string '@type': type: string '@schemaLocation': type: string externalSystem: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ExternalSystem' category: type: array items: title: Category type: object properties: name: type: string version: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string productSpecification: title: ProductSpecification type: object properties: id: type: string '@referredType': type: string '@type': type: string '@baseType': type: string '@schemaLocation': type: string href: type: string name: type: string version: type: string technology: type: array items: type: string product: title: Product type: object properties: id: type: string href: type: string customFields: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_CustomFields' externalSystem: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ExternalSystem' name: type: string startDate: type: string format: date-time status: type: string createdDate: type: string format: date-time modifiedDate: type: string format: date-time businessType: type: string technology: type: string publicIdentifier: type: string productSpecification: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ProductSpecification' productOffering: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ProductOffering' productOrder: type: array items: title: ProductOrder type: object properties: orderItemId: type: string orderItemAction: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string orderItemActionSubType: type: string channel: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Channel' relatedParty: type: array items: title: RelatedParty type: object properties: role: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string name: type: string engagedParty: title: EngagedParty type: object properties: id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string '@baseType': type: string '@type': type: string productRelationship: type: array items: title: ProductRelationship type: object properties: product: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Product' type: type: string relationshipType: type: string place: type: array items: title: Place type: object properties: role: type: string '@type': type: string productPrice: type: array items: title: ProductPrice type: object properties: href: type: string name: type: string description: type: string priceType: type: string recurringChargePeriod: type: string price: title: Price type: object properties: taxIncludedAmount: title: TaxIncludedAmount type: object properties: value: type: string unit: type: string dutyFreeAmount: title: DutyFreeAmount type: object properties: value: type: string unit: type: string taxRate: type: integer format: int32 tax: type: array items: title: Tax type: object properties: value: type: integer format: int32 unit: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: id: type: string href: type: string name: type: string '@schemaLocation': type: string '@schemaLocation': type: string productTerm: type: array items: title: ProductTerm type: object properties: description: type: string status: type: string validFor: title: ValidFor type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time '@type': type: string activationDate: type: string format: date-time suspensions: type: array items: title: Suspension type: object properties: id: type: string reason: type: string interactionDate: title: InteractionDate type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time suspensionType: type: string imsiNumber: type: string simNumber: type: string '@baseType': type: string '@type': type: string '@schemaLocation': type: string isCustomerVisible: type: boolean LoB: type: string xDir: type: string isPrimaryMSISDN: type: boolean '@referredType': type: string modifiable: type: boolean '@schemaLocation': type: string channel: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Channel' modifiedDate: type: string format: date-time state: type: string relatedParty: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_RelatedParty' modifiable: type: boolean orderDate: type: string format: date-time cancellable: type: boolean requestedStartDate: type: string format: date-time name: type: string '@referredType': type: string com_mtn_aggregator_models_response_details_AdjustedAmount: title: AdjustedAmount type: object properties: value: type: string com_mtn_madapi_tecnotree_models_responses_Category: title: Category type: object properties: name: type: string version: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string com_mtn_aggregator_models_response_details_Payer: title: Payer type: object properties: name: type: string contact: title: Contact type: object properties: email: type: string mobileNumber: type: string com_mtn_madapi_tecnotree_models_responses_ProductOffering: title: ProductOffering type: object properties: id: type: string href: type: string name: type: string code: type: string '@type': type: string '@schemaLocation': type: string externalSystem: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ExternalSystem' category: type: array items: title: Category type: object properties: name: type: string version: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string com_mtn_aggregator_models_response_details_InvoiceDetails: title: InvoiceDetails type: object properties: billRunId: type: string billCycleId: type: string billingAccountId: type: string id: type: string dueDate: type: string billStartDate: type: string billEndDate: type: string payableAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdjustedAmount' com_mtn_aggregator_models_response_details_ForeignCurrencyAmount: title: ForeignCurrencyAmount type: object properties: value: type: string unit: type: string com_mtn_aggregator_models_response_details_Contact: title: Contact type: object properties: email: type: string mobileNumber: type: string com_mtn_madapi_tecnotree_models_responses_EngagedParty: title: EngagedParty type: object properties: id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string com_mtn_madapi_tecnotree_models_payment_PaymentItem: title: PaymentItem type: object properties: id: type: string amount: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Amount' item: title: Item type: object properties: id: type: string href: type: string customFields: title: CustomFields type: object properties: productOrderGroup: type: array items: type: string registrationType: type: string moMoFlag: type: boolean assignType: type: string externalSystem: type: array items: title: ExternalSystem type: object properties: id: type: string system: type: string '@type': type: string '@baseType': type: string '@baseType': type: string '@type': type: string '@schemaLocation': type: string request: title: Request type: object properties: id: type: string '@referredType': type: string '@baseType': type: string '@schemaLocation': type: string href: type: string createdDate: type: string format: date-time orderItem: type: array items: title: OrderItem type: object properties: id: type: string href: type: string action: type: string actionSubType: type: string productOffering: title: ProductOffering type: object properties: id: type: string href: type: string name: type: string code: type: string '@type': type: string '@schemaLocation': type: string externalSystem: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ExternalSystem' category: type: array items: title: Category type: object properties: name: type: string version: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string productSpecification: title: ProductSpecification type: object properties: id: type: string '@referredType': type: string '@type': type: string '@baseType': type: string '@schemaLocation': type: string href: type: string name: type: string version: type: string technology: type: array items: type: string product: title: Product type: object properties: id: type: string href: type: string customFields: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_CustomFields' externalSystem: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ExternalSystem' name: type: string startDate: type: string format: date-time status: type: string createdDate: type: string format: date-time modifiedDate: type: string format: date-time businessType: type: string technology: type: string publicIdentifier: type: string productSpecification: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ProductSpecification' productOffering: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ProductOffering' productOrder: type: array items: title: ProductOrder type: object properties: orderItemId: type: string orderItemAction: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string orderItemActionSubType: type: string channel: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Channel' relatedParty: type: array items: title: RelatedParty type: object properties: role: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string name: type: string engagedParty: title: EngagedParty type: object properties: id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string '@baseType': type: string '@type': type: string productRelationship: type: array items: title: ProductRelationship type: object properties: product: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Product' type: type: string relationshipType: type: string place: type: array items: title: Place type: object properties: role: type: string '@type': type: string productPrice: type: array items: title: ProductPrice type: object properties: href: type: string name: type: string description: type: string priceType: type: string recurringChargePeriod: type: string price: title: Price type: object properties: taxIncludedAmount: title: TaxIncludedAmount type: object properties: value: type: string unit: type: string dutyFreeAmount: title: DutyFreeAmount type: object properties: value: type: string unit: type: string taxRate: type: integer format: int32 tax: type: array items: title: Tax type: object properties: value: type: integer format: int32 unit: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: id: type: string href: type: string name: type: string '@schemaLocation': type: string '@schemaLocation': type: string productTerm: type: array items: title: ProductTerm type: object properties: description: type: string status: type: string validFor: title: ValidFor type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time '@type': type: string activationDate: type: string format: date-time suspensions: type: array items: title: Suspension type: object properties: id: type: string reason: type: string interactionDate: title: InteractionDate type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time suspensionType: type: string imsiNumber: type: string simNumber: type: string '@baseType': type: string '@type': type: string '@schemaLocation': type: string isCustomerVisible: type: boolean LoB: type: string xDir: type: string isPrimaryMSISDN: type: boolean '@referredType': type: string modifiable: type: boolean '@schemaLocation': type: string channel: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Channel' modifiedDate: type: string format: date-time state: type: string relatedParty: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_RelatedParty' modifiable: type: boolean orderDate: type: string format: date-time cancellable: type: boolean requestedStartDate: type: string format: date-time name: type: string '@referredType': type: string taxAmount: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Amount' totalAmount: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Amount' '@baseType': type: string '@schemaLocation': type: string '@type': type: string com_mtn_madapi_tecnotree_models_payment_PaymentMethod: title: PaymentMethod type: object properties: id: type: string href: type: string description: type: string isPreferred: type: boolean name: type: string status: type: string statusDate: type: string account: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Account' relatedParty: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_RelatedParty' validFor: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ValidFor' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string details: title: Details type: object properties: mobileNumber: type: string reference: type: string preferred: type: boolean com_mtn_madapi_tecnotree_models_responses_ProductSpecification: title: ProductSpecification type: object properties: id: type: string '@referredType': type: string '@type': type: string '@baseType': type: string '@schemaLocation': type: string href: type: string name: type: string version: type: string technology: type: array items: type: string com_mtn_madapi_tecnotree_models_responses_Price: title: Price type: object properties: taxIncludedAmount: title: TaxIncludedAmount type: object properties: value: type: string unit: type: string dutyFreeAmount: title: DutyFreeAmount type: object properties: value: type: string unit: type: string taxRate: type: integer format: int32 tax: type: array items: title: Tax type: object properties: value: type: integer format: int32 unit: type: string com_mtn_madapi_tecnotree_models_payment_Account: title: Account type: object properties: id: type: string href: type: string description: type: string name: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string entityLevel: type: string role: type: string com_mtn_madapi_tecnotree_models_responses_ProductOrder: title: ProductOrder type: object properties: orderItemId: type: string orderItemAction: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string orderItemActionSubType: type: string com_mtn_madapi_tecnotree_models_responses_TaxIncludedAmount: title: TaxIncludedAmount type: object properties: value: type: string unit: type: string com_mtn_aggregator_models_response_details_AdditionalInformation: title: AdditionalInformation type: object properties: key: type: string value: type: string com_mtn_madapi_tecnotree_models_requests_Channel: title: Channel type: object properties: id: type: string name: type: string role: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string '@baseType': type: string '@type': type: string com_mtn_madapi_tecnotree_models_responses_Request: title: Request type: object properties: id: type: string '@referredType': type: string '@baseType': type: string '@schemaLocation': type: string href: type: string com_mtn_aggregator_models_response_details_DetailsResponse: title: DetailsResponse type: object properties: transactionType: type: string transactionKey: type: string transactionNumber: type: string additionalInformation: type: array items: title: AdditionalInformation type: object properties: key: type: string value: type: string adjustedAmount: title: AdjustedAmount type: object properties: value: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdjustedAmount' correlatorId: type: string debitCreditArticle: title: DebitCreditArticle type: object properties: name: type: string type: type: string financialPosting: title: FinancialPosting type: object properties: reference: type: string status: type: string invoiceDetails: title: InvoiceDetails type: object properties: billRunId: type: string billCycleId: type: string billingAccountId: type: string id: type: string dueDate: type: string billStartDate: type: string billEndDate: type: string payableAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdjustedAmount' userDetails: title: UserDetails type: object properties: userName: type: string location: type: string uploadedBy: type: string uraDetails: title: UraDetails type: object properties: oriInvoiceId: type: string oriInvoiceNo: type: string qrCode: type: string digitalSignature: type: string crDbFDN: type: string paymentItem: type: array items: title: PaymentItem type: object properties: paymentMethod: title: PaymentMethod type: object properties: name: type: string financialInstitutionBranch: type: string financialInstitutionCode: type: string paymentNumber: type: string paymentDate: type: string cardType: type: string paymentReference: type: string mobileNumber: type: string payeeNote: type: string eftIssuer: type: string paymentTransactionID: type: string cardIssuer: type: string cardNumber: type: string cardExpiryDate: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdjustedAmount' foreignCurrencyAmount: title: ForeignCurrencyAmount type: object properties: value: type: string unit: type: string exchangeRate: type: string item: title: Item type: object properties: id: type: string additionalInformation: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdditionalInformation' description: type: string rules: type: array items: title: Rules type: object properties: ruleCode: type: string criteria: type: string criteriaValues: type: array items: title: CriteriaValues type: object properties: value: type: string unit: type: string status: type: string statusDate: type: string taxAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdjustedAmount' transactionDate: type: string channel: title: Channel type: object properties: name: type: string totalAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdjustedAmount' taxBreakUp: type: array items: title: TaxBreakUp type: object properties: name: type: string taxAmount: type: string id: type: string payer: title: Payer type: object properties: name: type: string contact: title: Contact type: object properties: email: type: string mobileNumber: type: string com_mtn_madapi_tecnotree_models_responses_ExternalSystem: title: ExternalSystem type: object properties: id: type: string system: type: string '@type': type: string '@baseType': type: string com_mtn_madapi_tecnotree_models_responses_ProductOfferingPrice: title: ProductOfferingPrice type: object properties: id: type: string href: type: string name: type: string '@schemaLocation': type: string com_mtn_aggregator_models_response_details_PaymentItem: title: PaymentItem type: object properties: paymentMethod: title: PaymentMethod type: object properties: name: type: string financialInstitutionBranch: type: string financialInstitutionCode: type: string paymentNumber: type: string paymentDate: type: string cardType: type: string paymentReference: type: string mobileNumber: type: string payeeNote: type: string eftIssuer: type: string paymentTransactionID: type: string cardIssuer: type: string cardNumber: type: string cardExpiryDate: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdjustedAmount' foreignCurrencyAmount: title: ForeignCurrencyAmount type: object properties: value: type: string unit: type: string exchangeRate: type: string item: title: Item type: object properties: id: type: string additionalInformation: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_details_AdditionalInformation' com_mtn_madapi_tecnotree_models_responses_InteractionDate: title: InteractionDate type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time com_mtn_madapi_tecnotree_models_payment_Details: title: Details type: object properties: mobileNumber: type: string reference: type: string com_mtn_madapi_tecnotree_models_responses_ProductPrice: title: ProductPrice type: object properties: href: type: string name: type: string description: type: string priceType: type: string recurringChargePeriod: type: string price: title: Price type: object properties: taxIncludedAmount: title: TaxIncludedAmount type: object properties: value: type: string unit: type: string dutyFreeAmount: title: DutyFreeAmount type: object properties: value: type: string unit: type: string taxRate: type: integer format: int32 tax: type: array items: title: Tax type: object properties: value: type: integer format: int32 unit: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: id: type: string href: type: string name: type: string '@schemaLocation': type: string '@schemaLocation': type: string com_mtn_aggregator_models_response_details_Item: title: Item type: object properties: id: type: string com_mtn_aggregator_models_response_details_CriteriaValues: title: CriteriaValues type: object properties: value: type: string unit: type: string com_mtn_madapi_tecnotree_models_responses_RelatedParty: title: RelatedParty type: object properties: role: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string name: type: string engagedParty: title: EngagedParty type: object properties: id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string '@baseType': type: string '@type': type: string com_mtn_aggregator_models_response_details_DebitCreditArticle: title: DebitCreditArticle type: object properties: name: type: string type: type: string com_mtn_aggregator_models_response_details_UserDetails: title: UserDetails type: object properties: userName: type: string location: type: string uploadedBy: type: string com_mtn_madapi_tecnotree_models_payment_Payment: title: Payment type: object properties: id: type: string href: type: string authorizationCode: type: string correlatorId: type: string description: type: string name: type: string paymentDate: type: string status: type: string statusDate: type: string account: title: Account type: object properties: id: type: string href: type: string description: type: string name: type: string '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string entityLevel: type: string role: type: string amount: title: Amount type: object properties: unit: type: string value: type: integer format: int32 amount: type: integer format: int32 units: type: string channel: title: Channel type: object properties: id: type: string name: type: string role: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string '@baseType': type: string '@type': type: string payer: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Account' paymentItem: type: array items: title: PaymentItem type: object properties: id: type: string amount: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Amount' item: title: Item type: object properties: id: type: string href: type: string customFields: title: CustomFields type: object properties: productOrderGroup: type: array items: type: string registrationType: type: string moMoFlag: type: boolean assignType: type: string externalSystem: type: array items: title: ExternalSystem type: object properties: id: type: string system: type: string '@type': type: string '@baseType': type: string '@baseType': type: string '@type': type: string '@schemaLocation': type: string request: title: Request type: object properties: id: type: string '@referredType': type: string '@baseType': type: string '@schemaLocation': type: string href: type: string createdDate: type: string format: date-time orderItem: type: array items: title: OrderItem type: object properties: id: type: string href: type: string action: type: string actionSubType: type: string productOffering: title: ProductOffering type: object properties: id: type: string href: type: string name: type: string code: type: string '@type': type: string '@schemaLocation': type: string externalSystem: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ExternalSystem' category: type: array items: title: Category type: object properties: name: type: string version: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string productSpecification: title: ProductSpecification type: object properties: id: type: string '@referredType': type: string '@type': type: string '@baseType': type: string '@schemaLocation': type: string href: type: string name: type: string version: type: string technology: type: array items: type: string product: title: Product type: object properties: id: type: string href: type: string customFields: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_CustomFields' externalSystem: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ExternalSystem' name: type: string startDate: type: string format: date-time status: type: string createdDate: type: string format: date-time modifiedDate: type: string format: date-time businessType: type: string technology: type: string publicIdentifier: type: string productSpecification: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ProductSpecification' productOffering: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ProductOffering' productOrder: type: array items: title: ProductOrder type: object properties: orderItemId: type: string orderItemAction: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string orderItemActionSubType: type: string channel: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Channel' relatedParty: type: array items: title: RelatedParty type: object properties: role: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string name: type: string engagedParty: title: EngagedParty type: object properties: id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string '@baseType': type: string '@type': type: string productRelationship: type: array items: title: ProductRelationship type: object properties: product: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Product' type: type: string relationshipType: type: string place: type: array items: title: Place type: object properties: role: type: string '@type': type: string productPrice: type: array items: title: ProductPrice type: object properties: href: type: string name: type: string description: type: string priceType: type: string recurringChargePeriod: type: string price: title: Price type: object properties: taxIncludedAmount: title: TaxIncludedAmount type: object properties: value: type: string unit: type: string dutyFreeAmount: title: DutyFreeAmount type: object properties: value: type: string unit: type: string taxRate: type: integer format: int32 tax: type: array items: title: Tax type: object properties: value: type: integer format: int32 unit: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: id: type: string href: type: string name: type: string '@schemaLocation': type: string '@schemaLocation': type: string productTerm: type: array items: title: ProductTerm type: object properties: description: type: string status: type: string validFor: title: ValidFor type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time '@type': type: string activationDate: type: string format: date-time suspensions: type: array items: title: Suspension type: object properties: id: type: string reason: type: string interactionDate: title: InteractionDate type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time suspensionType: type: string imsiNumber: type: string simNumber: type: string '@baseType': type: string '@type': type: string '@schemaLocation': type: string isCustomerVisible: type: boolean LoB: type: string xDir: type: string isPrimaryMSISDN: type: boolean '@referredType': type: string modifiable: type: boolean '@schemaLocation': type: string channel: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Channel' modifiedDate: type: string format: date-time state: type: string relatedParty: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_RelatedParty' modifiable: type: boolean orderDate: type: string format: date-time cancellable: type: boolean requestedStartDate: type: string format: date-time name: type: string '@referredType': type: string taxAmount: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Amount' totalAmount: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Amount' '@baseType': type: string '@schemaLocation': type: string '@type': type: string paymentMethod: title: PaymentMethod type: object properties: id: type: string href: type: string description: type: string isPreferred: type: boolean name: type: string status: type: string statusDate: type: string account: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Account' relatedParty: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_RelatedParty' validFor: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ValidFor' '@baseType': type: string '@schemaLocation': type: string '@type': type: string '@referredType': type: string details: title: Details type: object properties: mobileNumber: type: string reference: type: string preferred: type: boolean taxAmount: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Amount' totalAmount: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_payment_Amount' '@baseType': type: string '@schemaLocation': type: string '@type': type: string code: type: string reason: type: string message: type: string referenceError: type: string paidDays: type: string consent: type: string com_mtn_madapi_tecnotree_models_responses_CustomFields: title: CustomFields type: object properties: productOrderGroup: type: array items: type: string registrationType: type: string moMoFlag: type: boolean assignType: type: string com_mtn_madapi_tecnotree_models_payment_Amount: title: Amount type: object properties: unit: type: string value: type: integer format: int32 amount: type: integer format: int32 units: type: string com_mtn_madapi_tecnotree_models_requests_Product: title: Product type: object properties: id: type: string href: type: string customFields: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_CustomFields' externalSystem: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ExternalSystem' name: type: string startDate: type: string format: date-time status: type: string createdDate: type: string format: date-time modifiedDate: type: string format: date-time businessType: type: string technology: type: string publicIdentifier: type: string productSpecification: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ProductSpecification' productOffering: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_responses_ProductOffering' productOrder: type: array items: title: ProductOrder type: object properties: orderItemId: type: string orderItemAction: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string orderItemActionSubType: type: string channel: type: array items: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Channel' relatedParty: type: array items: title: RelatedParty type: object properties: role: type: string id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string name: type: string engagedParty: title: EngagedParty type: object properties: id: type: string '@referredType': type: string '@schemaLocation': type: string href: type: string '@baseType': type: string '@type': type: string productRelationship: type: array items: title: ProductRelationship type: object properties: product: $ref: '#/components/schemas/com_mtn_madapi_tecnotree_models_requests_Product' type: type: string relationshipType: type: string place: type: array items: title: Place type: object properties: role: type: string '@type': type: string productPrice: type: array items: title: ProductPrice type: object properties: href: type: string name: type: string description: type: string priceType: type: string recurringChargePeriod: type: string price: title: Price type: object properties: taxIncludedAmount: title: TaxIncludedAmount type: object properties: value: type: string unit: type: string dutyFreeAmount: title: DutyFreeAmount type: object properties: value: type: string unit: type: string taxRate: type: integer format: int32 tax: type: array items: title: Tax type: object properties: value: type: integer format: int32 unit: type: string productOfferingPrice: type: array items: title: ProductOfferingPrice type: object properties: id: type: string href: type: string name: type: string '@schemaLocation': type: string '@schemaLocation': type: string productTerm: type: array items: title: ProductTerm type: object properties: description: type: string status: type: string validFor: title: ValidFor type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time '@type': type: string activationDate: type: string format: date-time suspensions: type: array items: title: Suspension type: object properties: id: type: string reason: type: string interactionDate: title: InteractionDate type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time suspensionType: type: string imsiNumber: type: string simNumber: type: string '@baseType': type: string '@type': type: string '@schemaLocation': type: string isCustomerVisible: type: boolean LoB: type: string xDir: type: string isPrimaryMSISDN: type: boolean '@referredType': type: string com_mtn_madapi_tecnotree_models_responses_Tax: title: Tax type: object properties: value: type: integer format: int32 unit: type: string com_mtn_aggregator_models_response_details_Rules: title: Rules type: object properties: ruleCode: type: string criteria: type: string criteriaValues: type: array items: title: CriteriaValues type: object properties: value: type: string unit: type: string com_mtn_aggregator_models_response_details_Channel: title: Channel type: object properties: name: 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