openapi: 3.0.1 info: title: MTN TMF678 Customer Bill Management description: "Used to facilitate the capability for consumers to retrieve bill information\ \ at service level, account level or invoice level. This API provides comprehensive\ \ bill management functionality including retrieval of customer bills, payment\ \ status updates, invoice validation, and auto-debit management." license: name: MADAPI url: https://developers.mtn.com/ version: 3.0.0 - Last updated date:2026-09-16 09:03:58 servers: - url: https://api.mtn.com/v1 description: Production Server security: - OAuth2: [] tags: - name: CustomerBillManagementService paths: /customerBill: get: tags: - CustomerBillManagementService summary: Provides the ability for a consumer to retrieve account balance information description: "Provides the ability for a consumer to retrieve list of unpaid\ \ bill amount, advance payment amount and total due amount. This endpoint\ \ supports various query types including completeBill, validateBill, billHistory,\ \ and autoDebitBillHistory with flexible filtering options." operationId: CustomerBillManagementService_get_customerBill parameters: - name: billCycleId in: query required: false schema: type: string - name: billingFlag in: query required: false schema: type: string - name: correlationId in: query required: false schema: type: string - name: countryCode in: header required: true schema: type: string - name: custom in: query required: false schema: type: string - name: customerId in: query required: true schema: type: string - name: customerType in: query required: true schema: type: string - name: endDate in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer format: int32 - name: offset in: query required: false schema: type: integer format: int32 - name: queryType in: query required: true schema: type: string - name: startDate in: query 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-origin-channelid in: header required: false schema: type: string responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: title: BillResponseWithList type: object properties: result: title: Result type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string sequenceNumber: type: string data: type: array items: title: BillResponseData type: object properties: id: type: string href: type: string billType: type: string billNo: type: string billDate: type: string category: type: string billRunType: type: string lastUpdate: type: string nextBillDate: type: string paymentDueDate: type: string state: type: string currentBalance: type: string amountDue: title: Amount type: object properties: amount: type: string unit: type: string remainingAmount: title: RemainingAmount type: object properties: amount: type: string unit: type: string type: type: string amountDueDetail: type: array items: title: AmountDueDetail type: object properties: id: type: string validFor: title: TimePeriod type: object properties: startDate: type: string endDate: type: string dueDate: type: string description: type: string unpaidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' advanceAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxExcludedAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxIncludedAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' totalDueAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' relatedParty: type: array items: title: RelatedParty type: object properties: id: type: string customerType: type: string customerName: type: string href: type: string role: type: string validFor: type: array items: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string '@referredType': type: string name: type: string contactMedium: type: array items: title: ContactMedium type: object properties: medium: title: Medium type: object properties: type: type: string verified: type: boolean number: type: string emailAddress: type: string type: type: string preferred: type: boolean location: type: string engagedParty: title: EngagedParty type: object properties: id: type: string '@referredType': type: string name: type: string billCycle: type: array items: title: BillCycle type: object properties: href: type: string billingCycleId: type: string billingName: type: string billingType: type: string startDate: type: string endDate: type: string creditLimit: type: array items: title: CreditLimit type: object properties: idType: type: string id: type: string creditLimitType: type: string creditLimitName: type: string creditLimit: type: string effectiveDate: type: string expiryDate: type: string appliedPayment: title: AppliedPayment type: object properties: idType: type: string id: type: string totalPaidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' payment: type: array items: title: Payment type: object properties: id: type: string paymentRef: type: array items: title: PaymentRef type: object properties: referenceId: type: string referenceType: type: string referenceName: type: string billNumber: type: string transactionDate: type: string paidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' paymentMethod: title: PaymentMethod type: object properties: name: type: string description: type: string type: type: string details: title: Details type: object properties: bank: title: Bank type: object properties: bankName: type: string bankCode: type: string branchCode: type: string paymentMode: type: string cash: title: Cash type: object properties: centerName: type: string centerCode: type: string atm: title: Atm type: object properties: bankName: type: string branchCode: type: string atmCode: type: string cheque: title: Cheque type: object properties: chequeNumber: type: string issueDate: type: string expiryDate: type: string accountNumber: type: string bankCode: type: string bankCard: title: BankCard type: object properties: brand: type: string type: type: string cardNumber: type: string expirationDate: type: string cvv: type: string lastFourDigits: type: string nameOnCard: type: string bank: type: string issuer: type: string tokenizedCard: title: TokenizedCard type: object properties: brand: type: string type: type: string lastFourDigits: type: string tokenType: type: string token: type: string issuer: type: string pan: type: string tokenUserId: type: string registrationDate: type: string status: type: string invoiceDetails: type: array items: title: InvoiceDetails type: object properties: invoiceNumber: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' billDocument: type: array items: title: BillDocument type: object properties: id: type: string description: type: string href: type: string attachmentType: type: string content: type: string mimeType: type: string size: type: string validFor: type: string referredType: type: string billingAccount: type: array items: title: BillingAccount type: object properties: accountType: type: string accountId: type: string accountname: type: string href: type: string name: type: string id: type: string '@referredType': type: string '@baseType': type: string '@type': type: string customFields: title: CustomFields type: object properties: registrationType: type: string assignType: type: string vip: type: boolean moMoFlag: type: boolean isMNP: type: boolean financialAccount: type: array items: title: FinancialAccount type: object properties: name: type: string id: type: string href: type: string type: type: string accountBalance: type: array items: title: AccountBalance type: object properties: balanceType: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxItem: type: array items: title: TaxItem type: object properties: taxAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxCategory: type: string taxRate: type: string type: type: string originReferenceId: type: string statusCode: type: string statusCode: 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 /customerBill/activation/status: get: tags: - CustomerBillManagementService summary: 'Provides the ability for a consumer to retrieve Activation Status ' description: "This GetMapping operation method provides the consumer with the\ \ ability of retrieving the debit Activation Status. The endpoint allows consumers\ \ to query the activation status of auto-debit functionality for a specific\ \ customer by providing customer type, customer ID, and query type parameters.\ \ The response includes the current activation state of the service." operationId: CustomerBillManagementService_get_autoDebitActivationStatus_customerBillactivati parameters: - name: customerId in: query required: false schema: type: string - name: customerType in: query required: false schema: type: integer format: int32 - name: queryType 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 usage management flows. content: application/json: schema: title: QueryActivationStatusResponse type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string activationStatus: type: string apiError: title: APIError type: object properties: sequenceNo: type: string transactionId: type: string path: type: string error: type: string status: type: string timestamp: 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 /customerBill/create: post: tags: - CustomerBillManagementService summary: Creates a new invoice in the system description: "This operation is utilized for creating a new invoice in the system,\ \ storing it in the system and a confirmation with the invoice ID(unique identifier)\ \ and status is send as a response. The endpoint is specifically designed\ \ for CFIS system in Nigeria (NGA) and accepts invoice creation requests with\ \ business details, line items, and other required invoice information for\ \ processing." operationId: CustomerBillManagementService_post_createInvoice_customerBillcreate parameters: - name: countryCode 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: title: InvoiceRequest type: object properties: businessId: type: string irn: type: string system: type: string issueDate: type: string dueDate: type: string issueTime: type: string invoiceType: type: string invoiceTypeCode: type: string paymentStatus: type: string note: type: string taxPointDate: type: string documentCurrencyCode: type: string taxCurrencyCode: type: string accountingCost: type: string buyerReference: type: string invoiceDeliveryPeriod: title: InvoiceDeliveryPeriod type: object properties: startDate: type: string endDate: type: string orderReference: type: string billingReference: type: array items: title: BillingReference type: object properties: irn: type: string issueDate: type: string dispatchDocumentReference: title: DispatchDocumentReference type: object properties: irn: type: string issueDate: type: string receiptDocumentReference: title: ReceiptDocumentReference type: object properties: irn: type: string issueDate: type: string originatorDocumentReference: title: OriginatorDocumentReference type: object properties: irn: type: string issueDate: type: string contractDocumentReference: title: ContractDocumentReference type: object properties: irn: type: string issueDate: type: string documentReference: type: array items: title: DocumentReference type: object properties: irn: type: string issueDate: type: string accountingSupplierParty: title: AccountingSupplierParty type: object properties: partyName: type: string tin: type: string email: type: string telephone: type: string businessDescription: type: string postalAddress: title: PostalAddress type: object properties: streetName: type: string cityName: type: string postalZone: type: string country: type: string accountingCustomerParty: title: AccountingCustomerParty type: object properties: partyName: type: string tin: type: string email: type: string telephone: type: string businessDescription: type: string postalAddress: $ref: '#/components/schemas/com_mtn_aggregator_models_request_firs_PostalAddress' actualDeliveryDate: type: string paymentMeans: type: array items: title: PaymentMean type: object properties: paymentMeansCode: type: string paymentDueDate: type: string paymentTermsNote: type: string allowanceCharge: type: array items: title: AllowanceCharge type: object properties: chargeIndicator: type: boolean amount: type: number format: double taxTotal: type: array items: title: TaxTotal type: object properties: taxAmount: type: number format: double taxSubtotal: type: array items: title: TaxSubtotal type: object properties: taxableAmount: type: integer format: int32 taxAmount: type: integer format: int32 taxCategory: title: TaxCategory type: object properties: id: type: string percent: type: number format: double legalMonetaryTotal: title: LegalMonetaryTotal type: object properties: lineExtensionAmount: type: number format: double taxExclusiveAmount: type: integer format: int32 taxInclusiveAmount: type: integer format: int32 payableAmount: type: integer format: int32 invoiceLine: type: array items: title: InvoiceLine type: object properties: hsnCode: type: string productCategory: type: string discountRate: type: number format: double discountAmount: type: integer format: int32 feeRate: type: number format: double feeAmount: type: integer format: int32 invoicedQuantity: type: integer format: int32 lineExtensionAmount: type: integer format: int32 item: title: Item type: object properties: name: type: string description: type: string sellersItemIdentification: type: string price: title: Price type: object properties: priceAmount: type: integer format: int32 baseQuantity: type: integer format: int32 priceUnit: type: string required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: title: InvoiceResponse type: object properties: statusCode: type: string supportMessage: type: string statusMessage: type: string resultCode: type: string result: title: Result type: object properties: resultDescription: type: string resultCode: type: string transactionId: type: string sequenceNo: type: string apiError: title: APIError type: object properties: sequenceNo: type: string transactionId: type: string path: type: string error: type: string status: type: string timestamp: type: string data: title: InvoiceResponseData type: object properties: irn: type: string id: type: string serviceRequestDetails: title: ServiceRequestDetails type: object properties: requestType: title: RequestType type: object requestLevel: type: string notes: type: string autoDebitType: title: AutoDebitType type: object validFor: title: ValidFor type: object properties: endDate: type: string startDate: type: string uppeLimit: type: integer format: int32 entityCode: type: string entityLevel: type: integer format: int32 orderStatus: 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 /customerBill/irnValidate: post: tags: - CustomerBillManagementService summary: 'Provides the ability for a consumer to validate irn ' description: "This Post operation method provides the consumer with the capabilities\ \ of validating irn(invoice reference number) provided that is, it is valid.\ \ The endpoint accepts an invoice request containing the IRN and validates\ \ it against the system records. It returns a response indicating whether\ \ the IRN is valid and associated invoice details if found in the system." operationId: CustomerBillManagementService_post_validateIrn_customerBillirnValid parameters: - name: countryCode in: header required: true 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_connector_model_request_dto_InvoiceRequest' 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 usage management flows. content: application/json: schema: $ref: '#/components/schemas/com_mtn_madapi_connector_model_request_dto_InvoiceResponse' "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 /customerBill/sign: post: tags: - CustomerBillManagementService summary: 'Provides the ability for a consumer to sign invoice ' description: "This Post operation provides the ability for a consumer to sign\ \ and submit an invoice after validating the content of the invoice to ensure\ \ all is in order. The endpoint processes the invoice signing request, applies\ \ digital signatures as required, and updates the invoice status to signed\ \ in the system with confirmation details." operationId: CustomerBillManagementService_post_signInvoice_customerBillsign parameters: - name: countryCode in: header required: true 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: title: InvoiceRequest type: object properties: businessId: type: string invoiceKind: type: string irn: type: string invoiceReference: type: string issueDate: type: string dueDate: type: string issueTime: type: string invoiceTypeCode: type: string paymentStatus: type: string note: type: string taxPointDate: type: string documentCurrencyCode: type: string taxCurrencyCode: type: string accountingCost: type: string buyerReference: type: string invoiceDeliveryPeriod: title: InvoiceDeliveryPeriod type: object properties: startDate: type: string endDate: type: string orderReference: type: string billingReference: type: array items: title: BillingReference type: object properties: irn: type: string issueDate: type: string dispatchDocumentReference: title: DispatchDocumentReference type: object properties: irn: type: string issueDate: type: string receiptDocumentReference: title: ReceiptDocumentReference type: object properties: irn: type: string issueDate: type: string originatorDocumentReference: title: OriginatorDocumentReference type: object properties: irn: type: string issueDate: type: string contractDocumentReference: title: ContractDocumentReference type: object properties: irn: type: string issueDate: type: string documentReference: type: array items: title: DocumentReference type: object properties: irn: type: string issueDate: type: string accountingSupplierParty: title: AccountingSupplierParty type: object properties: partyName: type: string tin: type: string email: type: string telephone: type: string businessDescription: type: string postalAddress: title: PostalAddress type: object properties: streetName: type: string cityName: type: string postalZone: type: string country: type: string state: type: string lga: type: string accountingCustomerParty: title: AccountingCustomerParty type: object properties: partyName: type: string tin: type: string email: type: string telephone: type: string businessDescription: type: string postalAddress: $ref: '#/components/schemas/com_mtn_madapi_connector_model_request_dto_PostalAddress' actualDeliveryDate: type: string paymentMeans: type: array items: title: PaymentMean type: object properties: paymentMeansCode: type: string paymentDueDate: type: string paymentTermsNote: type: string allowanceCharge: type: array items: title: AllowanceCharge type: object properties: chargeIndicator: type: boolean amount: type: number format: double taxTotal: type: array items: title: TaxTotal type: object properties: taxAmount: type: number format: double taxSubtotal: type: array items: title: TaxSubtotal type: object properties: taxableAmount: type: string taxAmount: type: string taxCategory: title: TaxCategory type: object properties: id: type: string percent: type: number format: double legalMonetaryTotal: title: LegalMonetaryTotal type: object properties: lineExtensionAmount: type: number format: double taxExclusiveAmount: type: string taxInclusiveAmount: type: string payableAmount: type: string invoiceLine: type: array items: title: InvoiceLine type: object properties: hsnCode: type: string productCategory: type: string discountRate: type: number format: double discountAmount: type: string feeRate: type: number format: double feeAmount: type: string invoicedQuantity: type: integer format: int32 lineExtensionAmount: type: string item: title: Item type: object properties: name: type: string description: type: string sellersItemIdentification: type: string price: title: Price type: object properties: priceAmount: type: string baseQuantity: type: integer format: int32 priceUnit: type: string required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: title: InvoiceResponse type: object properties: resultCode: type: string result: title: Result type: object properties: resultDescription: type: string resultCode: type: string transactionId: type: string sequenceNo: type: string apiError: $ref: '#/components/schemas/com_mtn_madapi_connector_model_response_APIError' "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 /customerBill/validate: post: tags: - CustomerBillManagementService summary: 'Provides the ability for a consumer to validate invoice ' description: "Provides the ability for a consumer to validate the content of\ \ the invoice to ensure all content are properly in order before sending for\ \ signing. This endpoint performs comprehensive validation checks on the invoice\ \ data including format validation, required field checks, and business rule\ \ validation to ensure invoice integrity." operationId: CustomerBillManagementService_post_validateInvoice_customerBillvalidate parameters: - name: countryCode in: header required: true 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_connector_model_request_dto_InvoiceRequest' 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 usage management flows. content: application/json: schema: $ref: '#/components/schemas/com_mtn_madapi_connector_model_request_dto_InvoiceResponse' "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 /customerBill/{id}: get: tags: - CustomerBillManagementService summary: "Provides the ability for a consumer to retrieve list of paid and unpaid\ \ bill amount, advance payment amount and total due amount." description: "Provides the ability for a consumer to retrieve list of paid and\ \ unpaid bill amount, advance payment amount and total due amount. This endpoint\ \ supports retrieving bill information by customer ID with various query types\ \ such as completeBill, unpaidBill, and downloadBill. It can return responses\ \ in both JSON and PDF formats based on the query type and Accept header." operationId: CustomerBillManagementService_get_customerBillById_customerBillid parameters: - name: amount in: query required: false schema: type: string - name: amountType in: query required: false schema: type: string - name: billCycleId in: query required: false schema: type: string - name: billingAccountId in: query required: false schema: type: string - name: billingFlag in: query required: false schema: type: string - name: countryCode in: header required: true schema: type: string - name: currency in: query required: false schema: type: string - name: custom in: query required: false schema: type: string - name: customerType in: query required: false schema: type: string - name: endDate in: query required: false schema: type: string - name: id in: path required: true schema: type: string - name: isCustomerVisible in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer format: int32 - name: message in: query required: false schema: type: string - name: offset in: query required: false schema: type: integer format: int32 - name: product in: query required: false schema: type: string - name: queryType in: query required: false schema: type: string - name: quoteId in: query required: false schema: type: string - name: receivingCustomerId in: query required: false schema: type: string - name: startDate in: query required: false schema: type: string - name: status in: query required: false schema: type: string - name: systemId 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: transactionType in: query required: false schema: type: string - name: x-origin-channelid in: header required: false schema: type: string responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: title: BillResponse type: object properties: result: $ref: '#/components/schemas/com_mtn_aggregator_models_response_Result' data: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_BillResponseData' financialResourceData: title: FinancialResourceInfo type: object properties: message: type: string premium: title: Premium type: object properties: type: type: string value: type: string unit: type: string loyaltyInformation: title: LoyaltyInformation type: object properties: generatedAmount: title: GeneratedAmount type: object properties: type: type: string value: type: string unit: type: string consumedAmount: title: ConsumedAmount type: object properties: type: type: string value: type: string unit: type: string newBalance: title: NewBalance type: object properties: type: type: string value: type: string unit: type: string id: type: string href: type: string billType: type: string billNo: type: string billDate: type: string category: type: string billRunType: type: string lastUpdate: type: string nextBillDate: type: string paymentDueDate: type: string state: type: string currentBalance: type: string amountDue: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' remainingAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_RemainingAmount' amountDueDetail: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_AmountDueDetail' relatedParty: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_RelatedParty' billCycle: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_BillCycle' appliedPayment: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_AppliedPayment' billDocument: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_BillDocument' billingAccount: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_BillingAccount' financialAccount: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_FinancialAccount' taxItem: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_TaxItem' originReferenceId: type: string statusCode: type: string statusCode: 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 patch: tags: - CustomerBillManagementService summary: Provides the ability for a consumer to update postpaid bill balance description: "This PatchMapping operation method provides the ability for a\ \ consumer to update the account's postpaid bill balances. The endpoint supports\ \ various update operations including payment status updates, opt-in/opt-out\ \ functionality for auto-debit, and invoice status updates for CFIS and FIRS\ \ systems. The request body contains the update details and service request\ \ information." operationId: CustomerBillManagementService_patch_patchCustomerBillWithId_customerBillid parameters: - name: channelName in: header required: false schema: type: string - name: countryCode in: header required: true schema: type: string - name: id in: path required: true schema: type: string - name: targetSystem in: header required: false schema: type: string - name: transactionId in: header required: false schema: type: string - name: x-authorization-claims in: header required: false schema: type: string - name: x-origin-channelid in: header required: false schema: type: string requestBody: content: application/json: schema: title: UpdateBillRequest type: object properties: idType: type: string id: type: string phoneNumber: type: string totalPaidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' payment: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_Payment' invoiceDetails: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_request_updatebill_InvoiceDetails' serviceRequestDetails: $ref: '#/components/schemas/com_mtn_aggregator_models_request_updatebill_ServiceRequestDetails' payment_status: type: string lastUpdate: type: string reference: type: string required: true responses: "200": description: HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI usage management flows. content: application/json: schema: title: UpdateBillResponse type: object properties: result: $ref: '#/components/schemas/com_mtn_aggregator_models_response_Result' data: title: UpdateBillResponseData type: object properties: idType: type: string id: type: string paymentRef: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_PaymentRef' amountPaid: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' advancePayment: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' statusCode: 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 /customerBill/{id}/billingAccountDetails: get: tags: - CustomerBillManagementService summary: Provides the ability for a consumer to retrieve list of billing amount of an MTN customer. description: Provides the ability for a consumer to retrieve list of billing amount of an MTN customer.This endpoint supports retrieving bill account details by customer ID with various id types such as account statement.It can return responses in both JSON and PDF formats based on the query type and Accept header. operationId: CustomerBillManagementService_get_customerBillAccountDetailsById_customerBillidbillin parameters: - name: id in: path required: true schema: type: string - name: idType in: query required: false schema: type: string - name: month in: query 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 - name: year 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 usage management flows. content: application/json: schema: title: AccountStatementResponse type: object properties: additionalInformation: title: AdditionalInformation type: object properties: summary: title: Summary type: object properties: count_credit: type: string count_debt: type: string total_credit: type: string total_debt: type: string total_outstanding_balance: type: string transactions: type: array items: title: Transactions type: object properties: year: type: string month: type: string credit: type: string debit: type: string net_adjustment: type: string invoice: type: string receipts: type: string grand_total: type: string running_balance: 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 components: schemas: com_mtn_aggregator_models_response_accountStatement_AccountStatementResponse: title: AccountStatementResponse type: object properties: additionalInformation: title: AdditionalInformation type: object properties: summary: title: Summary type: object properties: count_credit: type: string count_debt: type: string total_credit: type: string total_debt: type: string total_outstanding_balance: type: string transactions: type: array items: title: Transactions type: object properties: year: type: string month: type: string credit: type: string debit: type: string net_adjustment: type: string invoice: type: string receipts: type: string grand_total: type: string running_balance: type: string com_mtn_aggregator_models_response_customerbill_BillResponse: title: BillResponse type: object properties: result: $ref: '#/components/schemas/com_mtn_aggregator_models_response_Result' data: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_BillResponseData' financialResourceData: title: FinancialResourceInfo type: object properties: message: type: string premium: title: Premium type: object properties: type: type: string value: type: string unit: type: string loyaltyInformation: title: LoyaltyInformation type: object properties: generatedAmount: title: GeneratedAmount type: object properties: type: type: string value: type: string unit: type: string consumedAmount: title: ConsumedAmount type: object properties: type: type: string value: type: string unit: type: string newBalance: title: NewBalance type: object properties: type: type: string value: type: string unit: type: string id: type: string href: type: string billType: type: string billNo: type: string billDate: type: string category: type: string billRunType: type: string lastUpdate: type: string nextBillDate: type: string paymentDueDate: type: string state: type: string currentBalance: type: string amountDue: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' remainingAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_RemainingAmount' amountDueDetail: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_AmountDueDetail' relatedParty: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_RelatedParty' billCycle: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_BillCycle' appliedPayment: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_AppliedPayment' billDocument: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_BillDocument' billingAccount: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_BillingAccount' financialAccount: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_FinancialAccount' taxItem: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_TaxItem' originReferenceId: type: string statusCode: type: string statusCode: type: string timestamp: type: string status: type: string error: type: string message: type: string path: type: string com_mtn_madapi_connector_model_request_dto_TaxTotal: title: TaxTotal type: object properties: taxAmount: type: number format: double taxSubtotal: type: array items: title: TaxSubtotal type: object properties: taxableAmount: type: string taxAmount: type: string taxCategory: title: TaxCategory type: object properties: id: type: string percent: type: number format: double com_mtn_madapi_connector_model_request_dto_InvoiceRequest: title: InvoiceRequest type: object properties: businessId: type: string invoiceKind: type: string irn: type: string invoiceReference: type: string issueDate: type: string dueDate: type: string issueTime: type: string invoiceTypeCode: type: string paymentStatus: type: string note: type: string taxPointDate: type: string documentCurrencyCode: type: string taxCurrencyCode: type: string accountingCost: type: string buyerReference: type: string invoiceDeliveryPeriod: title: InvoiceDeliveryPeriod type: object properties: startDate: type: string endDate: type: string orderReference: type: string billingReference: type: array items: title: BillingReference type: object properties: irn: type: string issueDate: type: string dispatchDocumentReference: title: DispatchDocumentReference type: object properties: irn: type: string issueDate: type: string receiptDocumentReference: title: ReceiptDocumentReference type: object properties: irn: type: string issueDate: type: string originatorDocumentReference: title: OriginatorDocumentReference type: object properties: irn: type: string issueDate: type: string contractDocumentReference: title: ContractDocumentReference type: object properties: irn: type: string issueDate: type: string documentReference: type: array items: title: DocumentReference type: object properties: irn: type: string issueDate: type: string accountingSupplierParty: title: AccountingSupplierParty type: object properties: partyName: type: string tin: type: string email: type: string telephone: type: string businessDescription: type: string postalAddress: title: PostalAddress type: object properties: streetName: type: string cityName: type: string postalZone: type: string country: type: string state: type: string lga: type: string accountingCustomerParty: title: AccountingCustomerParty type: object properties: partyName: type: string tin: type: string email: type: string telephone: type: string businessDescription: type: string postalAddress: $ref: '#/components/schemas/com_mtn_madapi_connector_model_request_dto_PostalAddress' actualDeliveryDate: type: string paymentMeans: type: array items: title: PaymentMean type: object properties: paymentMeansCode: type: string paymentDueDate: type: string paymentTermsNote: type: string allowanceCharge: type: array items: title: AllowanceCharge type: object properties: chargeIndicator: type: boolean amount: type: number format: double taxTotal: type: array items: title: TaxTotal type: object properties: taxAmount: type: number format: double taxSubtotal: type: array items: title: TaxSubtotal type: object properties: taxableAmount: type: string taxAmount: type: string taxCategory: title: TaxCategory type: object properties: id: type: string percent: type: number format: double legalMonetaryTotal: title: LegalMonetaryTotal type: object properties: lineExtensionAmount: type: number format: double taxExclusiveAmount: type: string taxInclusiveAmount: type: string payableAmount: type: string invoiceLine: type: array items: title: InvoiceLine type: object properties: hsnCode: type: string productCategory: type: string discountRate: type: number format: double discountAmount: type: string feeRate: type: number format: double feeAmount: type: string invoicedQuantity: type: integer format: int32 lineExtensionAmount: type: string item: title: Item type: object properties: name: type: string description: type: string sellersItemIdentification: type: string price: title: Price type: object properties: priceAmount: type: string baseQuantity: type: integer format: int32 priceUnit: type: string com_mtn_aggregator_models_response_customerbill_RelatedParty: title: RelatedParty type: object properties: id: type: string customerType: type: string customerName: type: string href: type: string role: type: string validFor: type: array items: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string '@referredType': type: string name: type: string contactMedium: type: array items: title: ContactMedium type: object properties: medium: title: Medium type: object properties: type: type: string verified: type: boolean number: type: string emailAddress: type: string type: type: string preferred: type: boolean location: type: string engagedParty: title: EngagedParty type: object properties: id: type: string '@referredType': type: string name: type: string com_mtn_aggregator_models_response_accountStatement_Transactions: title: Transactions type: object properties: year: type: string month: type: string credit: type: string debit: type: string net_adjustment: type: string invoice: type: string receipts: type: string grand_total: type: string running_balance: type: string com_mtn_aggregator_models_request_firs_InvoiceDeliveryPeriod: title: InvoiceDeliveryPeriod type: object properties: startDate: type: string endDate: type: string com_mtn_aggregator_models_response_customerbill_CustomFields: title: CustomFields type: object properties: registrationType: type: string assignType: type: string vip: type: boolean moMoFlag: type: boolean isMNP: type: boolean com_mtn_aggregator_models_request_firs_DocumentReference: title: DocumentReference type: object properties: irn: type: string issueDate: type: string com_mtn_madapi_connector_model_request_dto_TaxCategory: title: TaxCategory type: object properties: id: type: string percent: type: number format: double com_mtn_aggregator_models_response_customerbill_EngagedParty: title: EngagedParty type: object properties: id: type: string '@referredType': type: string name: type: string com_mtn_aggregator_models_request_firs_TaxSubtotal: title: TaxSubtotal type: object properties: taxableAmount: type: integer format: int32 taxAmount: type: integer format: int32 taxCategory: title: TaxCategory type: object properties: id: type: string percent: type: number format: double com_mtn_madapi_connector_model_request_dto_PostalAddress: title: PostalAddress type: object properties: streetName: type: string cityName: type: string postalZone: type: string country: type: string state: type: string lga: type: string com_mtn_aggregator_models_request_firs_InvoiceLine: title: InvoiceLine type: object properties: hsnCode: type: string productCategory: type: string discountRate: type: number format: double discountAmount: type: integer format: int32 feeRate: type: number format: double feeAmount: type: integer format: int32 invoicedQuantity: type: integer format: int32 lineExtensionAmount: type: integer format: int32 item: title: Item type: object properties: name: type: string description: type: string sellersItemIdentification: type: string price: title: Price type: object properties: priceAmount: type: integer format: int32 baseQuantity: type: integer format: int32 priceUnit: type: string com_mtn_aggregator_models_response_customerbill_RemainingAmount: title: RemainingAmount type: object properties: amount: type: string unit: type: string type: type: string com_mtn_aggregator_models_response_PaymentRef: title: PaymentRef type: object properties: referenceId: type: string referenceType: type: string referenceName: type: string com_mtn_aggregator_models_response_financialresource_Premium: title: Premium type: object properties: type: type: string value: type: string unit: type: string com_mtn_aggregator_models_request_firs_InvoiceResponse: title: InvoiceResponse type: object properties: statusCode: type: string supportMessage: type: string statusMessage: type: string resultCode: type: string result: title: Result type: object properties: resultDescription: type: string resultCode: type: string transactionId: type: string sequenceNo: type: string apiError: title: APIError type: object properties: sequenceNo: type: string transactionId: type: string path: type: string error: type: string status: type: string timestamp: type: string data: title: InvoiceResponseData type: object properties: irn: type: string id: type: string serviceRequestDetails: title: ServiceRequestDetails type: object properties: requestType: title: RequestType type: object requestLevel: type: string notes: type: string autoDebitType: title: AutoDebitType type: object validFor: title: ValidFor type: object properties: endDate: type: string startDate: type: string uppeLimit: type: integer format: int32 entityCode: type: string entityLevel: type: integer format: int32 orderStatus: type: string com_mtn_aggregator_models_request_updatebill_ServiceRequestDetails_RequestType: title: RequestType type: object com_mtn_aggregator_models_response_customerbill_BankCard: title: BankCard type: object properties: brand: type: string type: type: string cardNumber: type: string expirationDate: type: string cvv: type: string lastFourDigits: type: string nameOnCard: type: string bank: type: string issuer: type: string com_mtn_aggregator_models_response_financialresource_FinancialResourceInfo: title: FinancialResourceInfo type: object properties: message: type: string premium: title: Premium type: object properties: type: type: string value: type: string unit: type: string loyaltyInformation: title: LoyaltyInformation type: object properties: generatedAmount: title: GeneratedAmount type: object properties: type: type: string value: type: string unit: type: string consumedAmount: title: ConsumedAmount type: object properties: type: type: string value: type: string unit: type: string newBalance: title: NewBalance type: object properties: type: type: string value: type: string unit: type: string id: type: string href: type: string billType: type: string billNo: type: string billDate: type: string category: type: string billRunType: type: string lastUpdate: type: string nextBillDate: type: string paymentDueDate: type: string state: type: string currentBalance: type: string amountDue: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' remainingAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_RemainingAmount' amountDueDetail: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_AmountDueDetail' relatedParty: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_RelatedParty' billCycle: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_BillCycle' appliedPayment: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_AppliedPayment' billDocument: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_BillDocument' billingAccount: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_BillingAccount' financialAccount: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_FinancialAccount' taxItem: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_customerbill_TaxItem' originReferenceId: type: string statusCode: type: string com_mtn_aggregator_models_request_firs_PostalAddress: title: PostalAddress type: object properties: streetName: type: string cityName: type: string postalZone: type: string country: type: string com_mtn_madapi_connector_model_request_dto_LegalMonetaryTotal: title: LegalMonetaryTotal type: object properties: lineExtensionAmount: type: number format: double taxExclusiveAmount: type: string taxInclusiveAmount: type: string payableAmount: type: string com_mtn_aggregator_models_request_firs_Price: title: Price type: object properties: priceAmount: type: integer format: int32 baseQuantity: type: integer format: int32 priceUnit: type: string com_mtn_aggregator_models_response_customerbill_Details: title: Details type: object properties: bank: title: Bank type: object properties: bankName: type: string bankCode: type: string branchCode: type: string paymentMode: type: string cash: title: Cash type: object properties: centerName: type: string centerCode: type: string atm: title: Atm type: object properties: bankName: type: string branchCode: type: string atmCode: type: string cheque: title: Cheque type: object properties: chequeNumber: type: string issueDate: type: string expiryDate: type: string accountNumber: type: string bankCode: type: string bankCard: title: BankCard type: object properties: brand: type: string type: type: string cardNumber: type: string expirationDate: type: string cvv: type: string lastFourDigits: type: string nameOnCard: type: string bank: type: string issuer: type: string tokenizedCard: title: TokenizedCard type: object properties: brand: type: string type: type: string lastFourDigits: type: string tokenType: type: string token: type: string issuer: type: string pan: type: string tokenUserId: type: string registrationDate: type: string status: type: string com_mtn_madapi_connector_models_dtos_response_APIError: title: APIError type: object properties: sequenceNo: type: string transactionId: type: string path: type: string error: type: string status: type: string timestamp: type: string com_mtn_aggregator_models_response_accountStatement_Summary: title: Summary type: object properties: count_credit: type: string count_debt: type: string total_credit: type: string total_debt: type: string total_outstanding_balance: type: string com_mtn_aggregator_models_response_customerbill_BillResponseWithList: title: BillResponseWithList type: object properties: result: title: Result type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string sequenceNumber: type: string data: type: array items: title: BillResponseData type: object properties: id: type: string href: type: string billType: type: string billNo: type: string billDate: type: string category: type: string billRunType: type: string lastUpdate: type: string nextBillDate: type: string paymentDueDate: type: string state: type: string currentBalance: type: string amountDue: title: Amount type: object properties: amount: type: string unit: type: string remainingAmount: title: RemainingAmount type: object properties: amount: type: string unit: type: string type: type: string amountDueDetail: type: array items: title: AmountDueDetail type: object properties: id: type: string validFor: title: TimePeriod type: object properties: startDate: type: string endDate: type: string dueDate: type: string description: type: string unpaidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' advanceAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxExcludedAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxIncludedAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' totalDueAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' relatedParty: type: array items: title: RelatedParty type: object properties: id: type: string customerType: type: string customerName: type: string href: type: string role: type: string validFor: type: array items: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string '@referredType': type: string name: type: string contactMedium: type: array items: title: ContactMedium type: object properties: medium: title: Medium type: object properties: type: type: string verified: type: boolean number: type: string emailAddress: type: string type: type: string preferred: type: boolean location: type: string engagedParty: title: EngagedParty type: object properties: id: type: string '@referredType': type: string name: type: string billCycle: type: array items: title: BillCycle type: object properties: href: type: string billingCycleId: type: string billingName: type: string billingType: type: string startDate: type: string endDate: type: string creditLimit: type: array items: title: CreditLimit type: object properties: idType: type: string id: type: string creditLimitType: type: string creditLimitName: type: string creditLimit: type: string effectiveDate: type: string expiryDate: type: string appliedPayment: title: AppliedPayment type: object properties: idType: type: string id: type: string totalPaidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' payment: type: array items: title: Payment type: object properties: id: type: string paymentRef: type: array items: title: PaymentRef type: object properties: referenceId: type: string referenceType: type: string referenceName: type: string billNumber: type: string transactionDate: type: string paidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' paymentMethod: title: PaymentMethod type: object properties: name: type: string description: type: string type: type: string details: title: Details type: object properties: bank: title: Bank type: object properties: bankName: type: string bankCode: type: string branchCode: type: string paymentMode: type: string cash: title: Cash type: object properties: centerName: type: string centerCode: type: string atm: title: Atm type: object properties: bankName: type: string branchCode: type: string atmCode: type: string cheque: title: Cheque type: object properties: chequeNumber: type: string issueDate: type: string expiryDate: type: string accountNumber: type: string bankCode: type: string bankCard: title: BankCard type: object properties: brand: type: string type: type: string cardNumber: type: string expirationDate: type: string cvv: type: string lastFourDigits: type: string nameOnCard: type: string bank: type: string issuer: type: string tokenizedCard: title: TokenizedCard type: object properties: brand: type: string type: type: string lastFourDigits: type: string tokenType: type: string token: type: string issuer: type: string pan: type: string tokenUserId: type: string registrationDate: type: string status: type: string invoiceDetails: type: array items: title: InvoiceDetails type: object properties: invoiceNumber: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' billDocument: type: array items: title: BillDocument type: object properties: id: type: string description: type: string href: type: string attachmentType: type: string content: type: string mimeType: type: string size: type: string validFor: type: string referredType: type: string billingAccount: type: array items: title: BillingAccount type: object properties: accountType: type: string accountId: type: string accountname: type: string href: type: string name: type: string id: type: string '@referredType': type: string '@baseType': type: string '@type': type: string customFields: title: CustomFields type: object properties: registrationType: type: string assignType: type: string vip: type: boolean moMoFlag: type: boolean isMNP: type: boolean financialAccount: type: array items: title: FinancialAccount type: object properties: name: type: string id: type: string href: type: string type: type: string accountBalance: type: array items: title: AccountBalance type: object properties: balanceType: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxItem: type: array items: title: TaxItem type: object properties: taxAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxCategory: type: string taxRate: type: string type: type: string originReferenceId: type: string statusCode: type: string statusCode: type: string timestamp: type: string status: type: string error: type: string message: type: string path: type: string com_mtn_aggregator_models_request_updatebill_UpdateBillRequest: title: UpdateBillRequest type: object properties: idType: type: string id: type: string phoneNumber: type: string totalPaidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' payment: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_Payment' invoiceDetails: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_request_updatebill_InvoiceDetails' serviceRequestDetails: $ref: '#/components/schemas/com_mtn_aggregator_models_request_updatebill_ServiceRequestDetails' payment_status: type: string lastUpdate: type: string reference: type: string com_mtn_aggregator_models_response_customerbill_FinancialAccount: title: FinancialAccount type: object properties: name: type: string id: type: string href: type: string type: type: string accountBalance: type: array items: title: AccountBalance type: object properties: balanceType: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' com_mtn_aggregator_models_response_customerbill_Medium: title: Medium type: object properties: type: type: string verified: type: boolean number: type: string emailAddress: type: string com_mtn_madapi_connector_model_request_dto_InvoiceLine: title: InvoiceLine type: object properties: hsnCode: type: string productCategory: type: string discountRate: type: number format: double discountAmount: type: string feeRate: type: number format: double feeAmount: type: string invoicedQuantity: type: integer format: int32 lineExtensionAmount: type: string item: title: Item type: object properties: name: type: string description: type: string sellersItemIdentification: type: string price: title: Price type: object properties: priceAmount: type: string baseQuantity: type: integer format: int32 priceUnit: type: string com_mtn_madapi_connector_models_dtos_request_ValidFor: title: ValidFor type: object properties: endDate: type: string startDate: type: string com_mtn_aggregator_models_response_customerbill_Cash: title: Cash type: object properties: centerName: type: string centerCode: type: string com_mtn_madapi_connector_model_request_dto_Result: title: Result type: object properties: resultDescription: type: string resultCode: type: string com_mtn_aggregator_models_response_customerbill_CreditLimit: title: CreditLimit type: object properties: idType: type: string id: type: string creditLimitType: type: string creditLimitName: type: string creditLimit: type: string effectiveDate: type: string expiryDate: type: string com_mtn_aggregator_models_response_customerbill_Bank: title: Bank type: object properties: bankName: type: string bankCode: type: string branchCode: type: string paymentMode: type: string com_mtn_aggregator_models_Amount: title: Amount type: object properties: amount: type: string unit: type: string com_mtn_aggregator_models_response_updatebill_UpdateBillResponse: title: UpdateBillResponse type: object properties: result: $ref: '#/components/schemas/com_mtn_aggregator_models_response_Result' data: title: UpdateBillResponseData type: object properties: idType: type: string id: type: string paymentRef: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_PaymentRef' amountPaid: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' advancePayment: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' statusCode: type: string timestamp: type: string status: type: string error: type: string message: type: string path: type: string com_mtn_madapi_connector_model_request_dto_ContractDocumentReference: title: ContractDocumentReference type: object properties: irn: type: string issueDate: type: string com_mtn_aggregator_models_request_firs_InvoiceResponseData: title: InvoiceResponseData type: object properties: irn: type: string id: type: string serviceRequestDetails: title: ServiceRequestDetails type: object properties: requestType: title: RequestType type: object requestLevel: type: string notes: type: string autoDebitType: title: AutoDebitType type: object validFor: title: ValidFor type: object properties: endDate: type: string startDate: type: string uppeLimit: type: integer format: int32 entityCode: type: string entityLevel: type: integer format: int32 orderStatus: type: string com_mtn_aggregator_models_request_firs_ReceiptDocumentReference: title: ReceiptDocumentReference type: object properties: irn: type: string issueDate: type: string com_mtn_aggregator_models_request_firs_LegalMonetaryTotal: title: LegalMonetaryTotal type: object properties: lineExtensionAmount: type: number format: double taxExclusiveAmount: type: integer format: int32 taxInclusiveAmount: type: integer format: int32 payableAmount: type: integer format: int32 com_mtn_madapi_connector_model_request_dto_TaxSubtotal: title: TaxSubtotal type: object properties: taxableAmount: type: string taxAmount: type: string taxCategory: title: TaxCategory type: object properties: id: type: string percent: type: number format: double com_mtn_madapi_connector_model_request_dto_InvoiceResponse: title: InvoiceResponse type: object properties: resultCode: type: string result: title: Result type: object properties: resultDescription: type: string resultCode: type: string transactionId: type: string sequenceNo: type: string apiError: $ref: '#/components/schemas/com_mtn_madapi_connector_model_response_APIError' com_mtn_aggregator_models_response_customerbill_BillCycle: title: BillCycle type: object properties: href: type: string billingCycleId: type: string billingName: type: string billingType: type: string startDate: type: string endDate: type: string creditLimit: type: array items: title: CreditLimit type: object properties: idType: type: string id: type: string creditLimitType: type: string creditLimitName: type: string creditLimit: type: string effectiveDate: type: string expiryDate: type: string com_mtn_aggregator_models_response_accountStatement_AdditionalInformation: title: AdditionalInformation type: object properties: summary: title: Summary type: object properties: count_credit: type: string count_debt: type: string total_credit: type: string total_debt: type: string total_outstanding_balance: type: string transactions: type: array items: title: Transactions type: object properties: year: type: string month: type: string credit: type: string debit: type: string net_adjustment: type: string invoice: type: string receipts: type: string grand_total: type: string running_balance: type: string com_mtn_madapi_connector_model_request_dto_AccountingSupplierParty: title: AccountingSupplierParty type: object properties: partyName: type: string tin: type: string email: type: string telephone: type: string businessDescription: type: string postalAddress: title: PostalAddress type: object properties: streetName: type: string cityName: type: string postalZone: type: string country: type: string state: type: string lga: type: string com_mtn_madapi_connector_model_request_dto_PaymentMean: title: PaymentMean type: object properties: paymentMeansCode: type: string paymentDueDate: type: string com_mtn_aggregator_models_response_customerbill_AppliedPayment: title: AppliedPayment type: object properties: idType: type: string id: type: string totalPaidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' payment: type: array items: title: Payment type: object properties: id: type: string paymentRef: type: array items: title: PaymentRef type: object properties: referenceId: type: string referenceType: type: string referenceName: type: string billNumber: type: string transactionDate: type: string paidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' paymentMethod: title: PaymentMethod type: object properties: name: type: string description: type: string type: type: string details: title: Details type: object properties: bank: title: Bank type: object properties: bankName: type: string bankCode: type: string branchCode: type: string paymentMode: type: string cash: title: Cash type: object properties: centerName: type: string centerCode: type: string atm: title: Atm type: object properties: bankName: type: string branchCode: type: string atmCode: type: string cheque: title: Cheque type: object properties: chequeNumber: type: string issueDate: type: string expiryDate: type: string accountNumber: type: string bankCode: type: string bankCard: title: BankCard type: object properties: brand: type: string type: type: string cardNumber: type: string expirationDate: type: string cvv: type: string lastFourDigits: type: string nameOnCard: type: string bank: type: string issuer: type: string tokenizedCard: title: TokenizedCard type: object properties: brand: type: string type: type: string lastFourDigits: type: string tokenType: type: string token: type: string issuer: type: string pan: type: string tokenUserId: type: string registrationDate: type: string status: type: string invoiceDetails: type: array items: title: InvoiceDetails type: object properties: invoiceNumber: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' com_mtn_aggregator_models_request_firs_Result: title: Result type: object properties: resultDescription: type: string resultCode: type: string com_mtn_aggregator_models_response_customerbill_Atm: title: Atm type: object properties: bankName: type: string branchCode: type: string atmCode: type: string com_mtn_aggregator_models_request_updatebill_InvoiceDetails: title: InvoiceDetails type: object properties: invoiceNumber: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' com_mtn_aggregator_models_request_updatebill_ServiceRequestDetails_AutoDebitType: title: AutoDebitType type: object com_mtn_aggregator_models_response_customerbill_TokenizedCard: title: TokenizedCard type: object properties: brand: type: string type: type: string lastFourDigits: type: string tokenType: type: string token: type: string issuer: type: string pan: type: string tokenUserId: type: string registrationDate: type: string status: type: string com_mtn_aggregator_models_response_customerbill_AmountDueDetail: title: AmountDueDetail type: object properties: id: type: string validFor: title: TimePeriod type: object properties: startDate: type: string endDate: type: string dueDate: type: string description: type: string unpaidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' advanceAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxExcludedAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxIncludedAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' totalDueAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' com_mtn_madapi_connector_model_response_APIError: title: APIError type: object properties: sequenceNo: type: string transactionId: type: string path: type: string error: type: string status: type: string timestamp: 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_request_firs_AccountingCustomerParty: title: AccountingCustomerParty type: object properties: partyName: type: string tin: type: string email: type: string telephone: type: string businessDescription: type: string postalAddress: $ref: '#/components/schemas/com_mtn_aggregator_models_request_firs_PostalAddress' com_mtn_aggregator_models_request_firs_AllowanceCharge: title: AllowanceCharge type: object properties: chargeIndicator: type: boolean amount: type: number format: double com_mtn_aggregator_models_request_firs_AccountingSupplierParty: title: AccountingSupplierParty type: object properties: partyName: type: string tin: type: string email: type: string telephone: type: string businessDescription: type: string postalAddress: title: PostalAddress type: object properties: streetName: type: string cityName: type: string postalZone: type: string country: type: string com_mtn_aggregator_models_Payment: title: Payment type: object properties: id: type: string paymentRef: type: array items: title: PaymentRef type: object properties: referenceId: type: string referenceType: type: string referenceName: type: string billNumber: type: string transactionDate: type: string paidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' paymentMethod: title: PaymentMethod type: object properties: name: type: string description: type: string type: type: string details: title: Details type: object properties: bank: title: Bank type: object properties: bankName: type: string bankCode: type: string branchCode: type: string paymentMode: type: string cash: title: Cash type: object properties: centerName: type: string centerCode: type: string atm: title: Atm type: object properties: bankName: type: string branchCode: type: string atmCode: type: string cheque: title: Cheque type: object properties: chequeNumber: type: string issueDate: type: string expiryDate: type: string accountNumber: type: string bankCode: type: string bankCard: title: BankCard type: object properties: brand: type: string type: type: string cardNumber: type: string expirationDate: type: string cvv: type: string lastFourDigits: type: string nameOnCard: type: string bank: type: string issuer: type: string tokenizedCard: title: TokenizedCard type: object properties: brand: type: string type: type: string lastFourDigits: type: string tokenType: type: string token: type: string issuer: type: string pan: type: string tokenUserId: type: string registrationDate: type: string status: type: string com_mtn_aggregator_models_response_customerbill_TimePeriod: title: TimePeriod type: object properties: startDate: type: string endDate: type: string com_mtn_aggregator_models_response_financialresource_GeneratedAmount: title: GeneratedAmount type: object properties: type: type: string value: type: string unit: type: string com_mtn_madapi_connector_model_request_dto_OriginatorDocumentReference: title: OriginatorDocumentReference type: object properties: irn: type: string issueDate: type: string com_mtn_aggregator_models_response_updatebill_UpdateBillResponseData: title: UpdateBillResponseData type: object properties: idType: type: string id: type: string paymentRef: type: array items: $ref: '#/components/schemas/com_mtn_aggregator_models_response_PaymentRef' amountPaid: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' advancePayment: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' com_mtn_aggregator_models_response_customerbill_BillResponseData: title: BillResponseData type: object properties: id: type: string href: type: string billType: type: string billNo: type: string billDate: type: string category: type: string billRunType: type: string lastUpdate: type: string nextBillDate: type: string paymentDueDate: type: string state: type: string currentBalance: type: string amountDue: title: Amount type: object properties: amount: type: string unit: type: string remainingAmount: title: RemainingAmount type: object properties: amount: type: string unit: type: string type: type: string amountDueDetail: type: array items: title: AmountDueDetail type: object properties: id: type: string validFor: title: TimePeriod type: object properties: startDate: type: string endDate: type: string dueDate: type: string description: type: string unpaidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' advanceAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxExcludedAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxIncludedAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' totalDueAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' relatedParty: type: array items: title: RelatedParty type: object properties: id: type: string customerType: type: string customerName: type: string href: type: string role: type: string validFor: type: array items: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string '@referredType': type: string name: type: string contactMedium: type: array items: title: ContactMedium type: object properties: medium: title: Medium type: object properties: type: type: string verified: type: boolean number: type: string emailAddress: type: string type: type: string preferred: type: boolean location: type: string engagedParty: title: EngagedParty type: object properties: id: type: string '@referredType': type: string name: type: string billCycle: type: array items: title: BillCycle type: object properties: href: type: string billingCycleId: type: string billingName: type: string billingType: type: string startDate: type: string endDate: type: string creditLimit: type: array items: title: CreditLimit type: object properties: idType: type: string id: type: string creditLimitType: type: string creditLimitName: type: string creditLimit: type: string effectiveDate: type: string expiryDate: type: string appliedPayment: title: AppliedPayment type: object properties: idType: type: string id: type: string totalPaidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' payment: type: array items: title: Payment type: object properties: id: type: string paymentRef: type: array items: title: PaymentRef type: object properties: referenceId: type: string referenceType: type: string referenceName: type: string billNumber: type: string transactionDate: type: string paidAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' paymentMethod: title: PaymentMethod type: object properties: name: type: string description: type: string type: type: string details: title: Details type: object properties: bank: title: Bank type: object properties: bankName: type: string bankCode: type: string branchCode: type: string paymentMode: type: string cash: title: Cash type: object properties: centerName: type: string centerCode: type: string atm: title: Atm type: object properties: bankName: type: string branchCode: type: string atmCode: type: string cheque: title: Cheque type: object properties: chequeNumber: type: string issueDate: type: string expiryDate: type: string accountNumber: type: string bankCode: type: string bankCard: title: BankCard type: object properties: brand: type: string type: type: string cardNumber: type: string expirationDate: type: string cvv: type: string lastFourDigits: type: string nameOnCard: type: string bank: type: string issuer: type: string tokenizedCard: title: TokenizedCard type: object properties: brand: type: string type: type: string lastFourDigits: type: string tokenType: type: string token: type: string issuer: type: string pan: type: string tokenUserId: type: string registrationDate: type: string status: type: string invoiceDetails: type: array items: title: InvoiceDetails type: object properties: invoiceNumber: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' billDocument: type: array items: title: BillDocument type: object properties: id: type: string description: type: string href: type: string attachmentType: type: string content: type: string mimeType: type: string size: type: string validFor: type: string referredType: type: string billingAccount: type: array items: title: BillingAccount type: object properties: accountType: type: string accountId: type: string accountname: type: string href: type: string name: type: string id: type: string '@referredType': type: string '@baseType': type: string '@type': type: string customFields: title: CustomFields type: object properties: registrationType: type: string assignType: type: string vip: type: boolean moMoFlag: type: boolean isMNP: type: boolean financialAccount: type: array items: title: FinancialAccount type: object properties: name: type: string id: type: string href: type: string type: type: string accountBalance: type: array items: title: AccountBalance type: object properties: balanceType: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxItem: type: array items: title: TaxItem type: object properties: taxAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxCategory: type: string taxRate: type: string type: type: string originReferenceId: type: string statusCode: type: string com_mtn_aggregator_models_response_customerbill_PaymentMethod: title: PaymentMethod type: object properties: name: type: string description: type: string type: type: string details: title: Details type: object properties: bank: title: Bank type: object properties: bankName: type: string bankCode: type: string branchCode: type: string paymentMode: type: string cash: title: Cash type: object properties: centerName: type: string centerCode: type: string atm: title: Atm type: object properties: bankName: type: string branchCode: type: string atmCode: type: string cheque: title: Cheque type: object properties: chequeNumber: type: string issueDate: type: string expiryDate: type: string accountNumber: type: string bankCode: type: string bankCard: title: BankCard type: object properties: brand: type: string type: type: string cardNumber: type: string expirationDate: type: string cvv: type: string lastFourDigits: type: string nameOnCard: type: string bank: type: string issuer: type: string tokenizedCard: title: TokenizedCard type: object properties: brand: type: string type: type: string lastFourDigits: type: string tokenType: type: string token: type: string issuer: type: string pan: type: string tokenUserId: type: string registrationDate: type: string status: type: string com_mtn_aggregator_models_response_customerbill_TaxItem: title: TaxItem type: object properties: taxAmount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' taxCategory: type: string taxRate: type: string type: type: string com_mtn_madapi_connector_model_request_dto_DocumentReference: title: DocumentReference type: object properties: irn: type: string issueDate: type: string com_mtn_aggregator_models_request_firs_ContractDocumentReference: title: ContractDocumentReference type: object properties: irn: type: string issueDate: type: string com_mtn_aggregator_models_response_customerbill_Cheque: title: Cheque type: object properties: chequeNumber: type: string issueDate: type: string expiryDate: type: string accountNumber: type: string bankCode: type: string com_mtn_madapi_connector_model_request_dto_AccountingCustomerParty: title: AccountingCustomerParty type: object properties: partyName: type: string tin: type: string email: type: string telephone: type: string businessDescription: type: string postalAddress: $ref: '#/components/schemas/com_mtn_madapi_connector_model_request_dto_PostalAddress' com_mtn_madapi_connector_model_request_dto_InvoiceDeliveryPeriod: title: InvoiceDeliveryPeriod type: object properties: startDate: type: string endDate: type: string com_mtn_madapi_connector_models_dtos_response_queryactivationstatus_QueryActivationStatusResponse: title: QueryActivationStatusResponse type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string activationStatus: type: string apiError: title: APIError type: object properties: sequenceNo: type: string transactionId: type: string path: type: string error: type: string status: type: string timestamp: type: string com_mtn_madapi_connector_model_request_dto_Price: title: Price type: object properties: priceAmount: type: string baseQuantity: type: integer format: int32 priceUnit: type: string com_mtn_aggregator_models_request_firs_OriginatorDocumentReference: title: OriginatorDocumentReference type: object properties: irn: type: string issueDate: type: string com_mtn_aggregator_models_request_firs_InvoiceRequest: title: InvoiceRequest type: object properties: businessId: type: string irn: type: string system: type: string issueDate: type: string dueDate: type: string issueTime: type: string invoiceType: type: string invoiceTypeCode: type: string paymentStatus: type: string note: type: string taxPointDate: type: string documentCurrencyCode: type: string taxCurrencyCode: type: string accountingCost: type: string buyerReference: type: string invoiceDeliveryPeriod: title: InvoiceDeliveryPeriod type: object properties: startDate: type: string endDate: type: string orderReference: type: string billingReference: type: array items: title: BillingReference type: object properties: irn: type: string issueDate: type: string dispatchDocumentReference: title: DispatchDocumentReference type: object properties: irn: type: string issueDate: type: string receiptDocumentReference: title: ReceiptDocumentReference type: object properties: irn: type: string issueDate: type: string originatorDocumentReference: title: OriginatorDocumentReference type: object properties: irn: type: string issueDate: type: string contractDocumentReference: title: ContractDocumentReference type: object properties: irn: type: string issueDate: type: string documentReference: type: array items: title: DocumentReference type: object properties: irn: type: string issueDate: type: string accountingSupplierParty: title: AccountingSupplierParty type: object properties: partyName: type: string tin: type: string email: type: string telephone: type: string businessDescription: type: string postalAddress: title: PostalAddress type: object properties: streetName: type: string cityName: type: string postalZone: type: string country: type: string accountingCustomerParty: title: AccountingCustomerParty type: object properties: partyName: type: string tin: type: string email: type: string telephone: type: string businessDescription: type: string postalAddress: $ref: '#/components/schemas/com_mtn_aggregator_models_request_firs_PostalAddress' actualDeliveryDate: type: string paymentMeans: type: array items: title: PaymentMean type: object properties: paymentMeansCode: type: string paymentDueDate: type: string paymentTermsNote: type: string allowanceCharge: type: array items: title: AllowanceCharge type: object properties: chargeIndicator: type: boolean amount: type: number format: double taxTotal: type: array items: title: TaxTotal type: object properties: taxAmount: type: number format: double taxSubtotal: type: array items: title: TaxSubtotal type: object properties: taxableAmount: type: integer format: int32 taxAmount: type: integer format: int32 taxCategory: title: TaxCategory type: object properties: id: type: string percent: type: number format: double legalMonetaryTotal: title: LegalMonetaryTotal type: object properties: lineExtensionAmount: type: number format: double taxExclusiveAmount: type: integer format: int32 taxInclusiveAmount: type: integer format: int32 payableAmount: type: integer format: int32 invoiceLine: type: array items: title: InvoiceLine type: object properties: hsnCode: type: string productCategory: type: string discountRate: type: number format: double discountAmount: type: integer format: int32 feeRate: type: number format: double feeAmount: type: integer format: int32 invoicedQuantity: type: integer format: int32 lineExtensionAmount: type: integer format: int32 item: title: Item type: object properties: name: type: string description: type: string sellersItemIdentification: type: string price: title: Price type: object properties: priceAmount: type: integer format: int32 baseQuantity: type: integer format: int32 priceUnit: type: string com_mtn_aggregator_models_request_firs_TaxCategory: title: TaxCategory type: object properties: id: type: string percent: type: number format: double com_mtn_aggregator_models_response_customerbill_ValidFor: title: ValidFor type: object properties: startDateTime: type: string endDateTime: type: string com_mtn_aggregator_models_response_customerbill_BillingAccount: title: BillingAccount type: object properties: accountType: type: string accountId: type: string accountname: type: string href: type: string name: type: string id: type: string '@referredType': type: string '@baseType': type: string '@type': type: string customFields: title: CustomFields type: object properties: registrationType: type: string assignType: type: string vip: type: boolean moMoFlag: type: boolean isMNP: type: boolean com_mtn_aggregator_models_request_updatebill_ServiceRequestDetails: title: ServiceRequestDetails type: object properties: requestType: title: RequestType type: object requestLevel: type: string notes: type: string autoDebitType: title: AutoDebitType type: object validFor: title: ValidFor type: object properties: endDate: type: string startDate: type: string uppeLimit: type: integer format: int32 entityCode: type: string entityLevel: type: integer format: int32 orderStatus: type: string com_mtn_madapi_connector_model_request_dto_DispatchDocumentReference: title: DispatchDocumentReference type: object properties: irn: type: string issueDate: type: string com_mtn_aggregator_models_request_firs_DispatchDocumentReference: title: DispatchDocumentReference type: object properties: irn: type: string issueDate: type: string com_mtn_aggregator_models_response_financialresource_ConsumedAmount: title: ConsumedAmount type: object properties: type: type: string value: type: string unit: type: string com_mtn_aggregator_models_response_customerbill_ContactMedium: title: ContactMedium type: object properties: medium: title: Medium type: object properties: type: type: string verified: type: boolean number: type: string emailAddress: type: string type: type: string preferred: type: boolean com_mtn_aggregator_models_response_financialresource_LoyaltyInformation: title: LoyaltyInformation type: object properties: generatedAmount: title: GeneratedAmount type: object properties: type: type: string value: type: string unit: type: string consumedAmount: title: ConsumedAmount type: object properties: type: type: string value: type: string unit: type: string newBalance: title: NewBalance type: object properties: type: type: string value: type: string unit: type: string com_mtn_madapi_connector_model_request_dto_ReceiptDocumentReference: title: ReceiptDocumentReference type: object properties: irn: type: string issueDate: type: string com_mtn_aggregator_models_request_firs_Item: title: Item type: object properties: name: type: string description: type: string sellersItemIdentification: type: string com_mtn_madapi_connector_model_request_dto_Item: title: Item type: object properties: name: type: string description: type: string sellersItemIdentification: type: string com_mtn_aggregator_models_response_customerbill_AccountBalance: title: AccountBalance type: object properties: balanceType: type: string amount: $ref: '#/components/schemas/com_mtn_aggregator_models_Amount' com_mtn_madapi_connector_model_request_dto_AllowanceCharge: title: AllowanceCharge type: object properties: chargeIndicator: type: boolean amount: type: number format: double com_mtn_aggregator_models_response_customerbill_BillDocument: title: BillDocument type: object properties: id: type: string description: type: string href: type: string attachmentType: type: string content: type: string mimeType: type: string size: type: string validFor: type: string referredType: type: string com_mtn_aggregator_models_request_firs_TaxTotal: title: TaxTotal type: object properties: taxAmount: type: number format: double taxSubtotal: type: array items: title: TaxSubtotal type: object properties: taxableAmount: type: integer format: int32 taxAmount: type: integer format: int32 taxCategory: title: TaxCategory type: object properties: id: type: string percent: type: number format: double com_mtn_aggregator_models_request_firs_BillingReference: title: BillingReference type: object properties: irn: type: string issueDate: type: string com_mtn_aggregator_models_response_financialresource_NewBalance: title: NewBalance type: object properties: type: type: string value: type: string unit: type: string com_mtn_aggregator_models_response_Result: title: Result type: object properties: resultCode: type: string resultDescription: type: string transactionId: type: string sequenceNumber: type: string com_mtn_madapi_connector_model_request_dto_BillingReference: title: BillingReference type: object properties: irn: type: string issueDate: type: string com_mtn_aggregator_models_request_firs_PaymentMean: title: PaymentMean type: object properties: paymentMeansCode: type: string paymentDueDate: 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