MTN Customer Billing Token V1 is one of 119 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Customers and South Africa. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.
This API exposes
8 operations
across 8 paths,
organized into 7 resource areas,
and defines 112 schemas.
It is described by OpenAPI 2.0, at version v1.0.
Requests are made against the base URL https://api.mtn.com/v1/customer.
The identity and technical contract details declared by the specification.
RegisterTokenRequest
object
2 properties
ActivateTokenRequest
object
2 properties
DeactivateTokenRequest
object
10 properties
4 required
DeactivateTokenResponse
object
6 properties
AgreementItemRef
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
8 properties
1 required
AgreementItemRef2
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
1 property
AgreementRef
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
1 property
1 required
AppointmentRef
object
Refers an appointment, such as a Customer presentation or internal meeting or site visit
7 properties
1 required
BillingAccountRef
object
BillingAccount reference. A BillingAccount is a detailed description of a bill structure.
7 properties
1 required
CancelOrder
object
A Order cancel is a type of task which can be used to place a request to cancel an order
9 properties
CancelProductOrder
object
Request for cancellation an existing product order
9 properties
1 required
CancelProductOrder_Create
object
Request for cancellation an existing product order Skipped properties: id,href,state,effectiveCancellationDate
6 properties
1 required
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
6 properties
2 required
EntityRef
object
Entity reference schema to be use for all entityRef class.
7 properties
1 required
Money
object
A base / value business entity used to represent money
2 properties
Note
object
Extra information about a given entity
7 properties
1 required
OrderItemActionType
string
action to be performed on the product
OrderItemRelationship
object
5 properties
OrderPrice
object
An amount, usually of money, that represents the actual price paid by the Customer for this item or this order
3 properties
Price
object
Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
1 property
product2
object
A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).
12 properties
Product
object
A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).
26 properties
ProductOfferingPriceRef
object
ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased
7 properties
1 required
ProductOfferingQualificationItemRef
object
It's a productOfferingQualification item that has been executed previously.
10 properties
2 required
ProductOfferingQualificationRef
object
It's a productOfferingQualification that has been executed previously
7 properties
1 required
ProductOfferingRef
object
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing informati…
2 properties
ProductOrder2
object
A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner an…
8 properties
1 required
ProductOrder_UpdateChannel
object
2 properties
productCharacteristicName
object
1 property
ProductOrder
object
A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner an…
23 properties
1 required
ProductOrder_Create2
object
A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner an…
7 properties
1 required
productOrderDelete
object
A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner an…
5 properties
1 required
ProductOrderItem_Delete
object
An identified part of the order to be deleted. A product order is decomposed into one or more order items.
3 properties
ProductRefOrValueDelete
object
A product to be deleted defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the…
1 property
ProductOrder_Create
object
A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner an…
21 properties
1 required
ProductOrder_Update
object
A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner an…
23 properties
1 required
ProductOrderItem
object
An identified part of the order. A product order is decomposed into one or more order items.
2 properties
ProductOrderItem2
object
An identified part of the order. A product order is decomposed into one or more order items.
1 property
removeProductOrder
object
An identified part of the order. A product order is decomposed into one or more order items.
5 properties
ProductOrderItemStateType
string
Possible values for the state of the product order item
ProductOrderRef
object
ProductOrder (ProductOrder) .The product order which the recommendation is related with.
7 properties
1 required
ProductOrderStateType
string
Possible values for the state of the order
ProductPrice
object
An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defin…
10 properties
2 required
ProductRef
object
7 properties
1 required
ProductRefOrValue
object
A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the…
8 properties
productCharacteristic
object
2 properties
productCharacteristic2
object
1 property
ProductRefOrValue2
object
A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the…
1 property
ProductSpecificationRef
object
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a…
9 properties
1 required
ProductStatusType
string
Possible values for the status of the product
ProductTerm
object
Description of a productTerm linked to this product. This represent a commitment with a duration
3 properties
Quantity
object
An amount in a given unit
2 properties
QuoteItemRef
object
It's a Quote item that has been executed previously.
10 properties
2 required
QuoteRef
object
It's a Quote that has been executed previously
7 properties
1 required
RelatedChannel
object
Related channel to another entity. May be online web, mobile app, social ,etc.
3 properties
1 required
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
3 properties
2 required
RelatedPlaceRefOrValue
object
Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @sc…
8 properties
1 required
RelatedProductOrderItem
object
RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination.
9 properties
2 required
ResourceRef
object
8 properties
1 required
ServiceRef
object
Service reference, for when Service is used by other entities
7 properties
1 required
TargetProductSchema
object
The reference object to the schema and type of target product which is described by product specification
3 properties
2 required
TaskStateType
string
Possible values for the state of a task
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
EventSubscription
object
Sets the communication endpoint address the service instance must use to deliver notification information
3 properties
2 required
EventSubscriptionInput
object
Sets the communication endpoint address the service instance must use to deliver notification information
2 properties
1 required
ProductOrderCreateEvent
object
The notification data structure
12 properties
ProductOrderCreateEventPayload
object
The event data structure
1 property
ProductOrderAttributeValueChangeEvent
object
The notification data structure
11 properties
ProductOrderAttributeValueChangeEventPayload
object
The event data structure
1 property
ProductOrderDeleteEvent
object
The notification data structure
12 properties
ProductOrderDeleteEventPayload
object
The event data structure
1 property
ProductOrderStateChangeEvent
object
The notification data structure
12 properties
ProductOrderStateChangeEventPayload
object
The event data structure
1 property
ProductOrderInformationRequiredEvent
object
The notification data structure
11 properties
ProductOrderInformationRequiredEventPayload
object
The event data structure
1 property
CancelProductOrderCreateEvent
object
The notification data structure
12 properties
CancelProductOrderResponse
object
4 properties
3 required
CreateOrderResponse
object
4 properties
3 required
CreateOrderResponse2
object
4 properties
3 required
ViewActiveVAS
object
4 properties
3 required
CancelProductOrderCreateEventPayload
object
The event data structure
1 property
CancelProductOrderStateChangeEvent
object
The notification data structure
12 properties
CancelProductOrderStateChangeEventPayload
object
The event data structure
1 property
CancelProductOrderInformationRequiredEvent
object
The notification data structure
11 properties
CancelProductOrderInformationRequiredEventPayload
object
The event data structure
1 property
createUrlRequest
object
3 properties
1 required
createUrlResponse
object
4 properties
3 required
Error
object
6 properties
2 required
ErrorSubChanNotFound
object
6 properties
2 required
ErrorSubNotFound
object
6 properties
2 required
ErrorSvcNotFound
object
6 properties
2 required
ErrorActSubsEx
object
6 properties
2 required
ErrorSvcNotLinked
object
6 properties
2 required
ErrorSvcIdSvcRefNotFound
object
6 properties
2 required
ErrorPendingSubEx
object
6 properties
2 required
ErrorSubNotActive
object
6 properties
2 required
ErrorInvAPIVersion
object
6 properties
2 required
ErrorMsisdnNotProvided
object
6 properties
2 required
ErrorInvMsisdn
object
6 properties
2 required
ErrorInvBillRate
object
6 properties
2 required
debitRequest
object
11 properties
VATDetails
object
3 properties
offerDetails
object
2 properties
debitResponse
object
5 properties
3 required
transStatRequest
object
6 properties
transStatResponse
object
5 properties
3 required
tokenStatRequest
object
4 properties
tokenStatResponse
object
5 properties
refundRequest
object
9 properties
refundResponse
object
5 properties
ErrorBadReq
object
6 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MTN Group publishes across the network.
