Home
Subscriber Management (SubMan) API
SubMan API Reference
The SubMan API reference includes SubMan API and MDC descriptions.

Welcome
Release Notes
Architecture Overview
MATRIXX Cloud Native Installation and Configuration
MATRIXX Cloud Native Integration
Implementing MATRIXX in a Cloud
Installation and Configuration
MATRIXX Digital Commerce Upgrade
MATRIXX Security
MATRIXX Engine Administration
MATRIXX Web App Administration
MATRIXX Engine Integration
Call Control Framework Integration
MATRIXX Diameter Integration
MATRIXX 5G Integration
MATRIXX Monitoring and Logging
Pricing and Rating
MATRIXX Pay Now
MATRIXX Policy
MATRIXX Event Streaming
Subscriber Management
Subscriber Management (SubMan) API
- About Subscriber Management (SubMan) API
  Subscriber Management (SubMan) API provides information about the MATRIXX Engine APIs, including functions, syntax, and result codes, and the MATRIXX Engine REST and Java API implementations.
- SubMan API Overview
  The Subscriber Management (SubMan) API defines a set of programming interfaces to the MATRIXX in-memory database. In addition, the Event Repository REST APIs return events and notifications in the Event Repository and in the Activity database (in-progress aggregated events) and event database for subscriptions and groups. The SubMan API can be used to manage the various in-memory objects in a defined manner, allowing an exchange of subscriber and group data between external applications and MATRIXX Engine.
- Subscriber Data
  MATRIXX Engine maintains transactional subscriber data that enables you to act in real-time to subscriber needs and service usage. The MATRIXX subscriber model is flexible and supports any type of subscriber base, such as retail, wholesale, and mobile virtual network operator (MVNO).
- Object Management Overview
  The following sections introduce how the various in-memory objects are managed.
- Connecting RS Gateway to the Event Repository
  The Event Repository REST APIs return events and notifications in the Event Repository and in the Activity database (in-progress aggregated events) and Event database for subscribers and groups. The RS Gateway must be configured to connect to the Event Repository.
- Using the MATRIXX REST API
  This section explains how to use the REST API bindings to interface with MATRIXX Engine.
- REST API Reference
  This chapter describes the SubMan REST APIs.
- SubMan API Reference
  The SubMan API reference includes SubMan API and MDC descriptions.
  - Application APIs
    The application APIs return information for each Rx application session in a response for device sessions.
  - Balance, Meter, Wallet APIs
    This section includes balance-related APIs.
  - Barclay APIs
    This section describes the Barclay MDCs.
  - Bundle MDCs
    This section includes the bundle MDCs.
  - Billing APIs
    This section includes billing-related APIs.
  - Braintree APIs
    This section includes the Braintree-specific SubMan APIs.
  - Mastercard APIs
    This section includes the Mastercard-specific SubMan APIs.
  - Catalog APIs
    The catalog APIs return information about pricing catalogs for specified devices, groups, and subscriptions.
  - Catalog Item APIs
    The catalog item APIs return information about eligible catalog items for specified devices, groups, and subscriptions.
  - Charge-Related APIs
    This section describes the charge-related MDCs for MATRIXX API calls.
  - Contract APIs
    Contract data is returned in the product offer API responses in the MtxPurchasedOfferInfo MDC.
  - Device APIs
    This section lists the device-related APIs.
  - Diameter APIs
    This section includes the Diameter-related APIs.
  - Eligibility Rules APIs
    This section describes the SubMan eligibility rules APIs.
  - Event APIs
    This section includes the event-related APIs.
  - External Payments
    External payment APIs query external payment requests and get a list of external payment request records in a wallet.
  - Group APIs
    This section lists the group-related APIs.
  - Mastercard APIs
    This section includes the Mastercard-specific SubMan APIs.
  - mPAY MDCs
    This section describes the mPAY MDCs.
  - Notification MDCs
    This section includes the notification MDCs.
  - Parameter MDCs
    This section includes the parameter MDCs.
  - Pay Now Payment APIs
    The Pay Now payment SubMan APIs query payment information and add or remove payment method tokens for subscribers and groups.
  - Policy APIs
    This section lists the MATRIXX Policy application APIs.
  - Pricing APIs
    This section lists the pricing-related APIs.
  - Product Offer APIs
    This section lists the product offer-related APIs.
  - Purchased Item APIs
    This section lists the purchased item APIs.
  - Recharge MDCs
    This section describes the recharge MDC fields.
  - Rehoming APIs
    The rehoming APIs move a subscriber, group, or device from one customer sub-domain to a different sub-domain. For a description of the rehoming process, see the discussion about rehoming subscribers, groups, and devices in the object management overview.
  - Request/Response APIs
    This section includes request and response APIs.
  - Related Objects
    This section describes the common structures for related objects, related subscription objects, and related user objects.
  - Romcard V2 APIs
    This section describes the Romcard V2 APIs.
  - Stream Session APIs
    The stream session APIs create, delete, modify, and query stream sessions.
  - Subscriber APIs
    This section lists the subscriber-related APIs.
  - Subscription APIs
    The subscription APIs create, delete, modify, and query subscription objects.
  - User APIs
    This section describes the user object APIs.
  - MtxOpMsg
    MDC container for request/response handling.
- Using the MATRIXX Java API
  This section provides an overview of how to use the Java™ API binding for the SubMan v3 API as an interface to the MATRIXX Engine.
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
Third-Party Licenses
Glossary

SubMan API Reference

The SubMan API reference includes SubMan API and MDC descriptions.