Home
MATRIXX Subscriber Management API
SubMan API Reference
The SubMan API reference includes SubMan API and MDC descriptions.
Group MDCs
This section lists the group-related APIs.
MtxGroupIdInfo
This section describes the MtxGroupIdInfo fields.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
MATRIXX Diameter Integration
MATRIXX Call Control Framework Integration
MATRIXX TM Forum Integration
MATRIXX 5G Integration
MATRIXX 5G Event Streaming
MATRIXX Event Streaming
MATRIXX Administration
MATRIXX Web App Administration
MATRIXX Monitoring and Logging
MATRIXX Policy
MATRIXX Kafka CDR Consumer
MATRIXX Pricing and Rating
MATRIXX Pay Now
MATRIXX Subscriber Management
MATRIXX Subscriber Management API
- About Subscriber Management API
  MATRIXX Subscriber Management API provides information about the MATRIXX Engine APIs, including functions, syntax, and result codes, and the MATRIXX Engine REST and Java API implementations.
- Subscriber Management
  The following information is an overview of the SubMan APIs and architecture.
- Object Management
  The following sections introduce how the various in-memory objects are managed.
- SubMan API Reference
  The SubMan API reference includes SubMan API and MDC descriptions.
  - Application MDCs
    The application MDCs include information for each Rx application session in a response for device sessions.
  - Balance, Meter, Wallet MDCs
    This section includes balance-related MDCs.
  - Barclay MDCs
    This section describes the Barclay MDCs.
  - Bundle MDCs
    This section includes the bundle MDCs.
  - Billing MDCs
    This section includes billing-related MDCs.
  - Braintree MDCs
    This section includes the Braintree-specific SubMan APIs.
  - Catalog MDCs
    The catalog APIs return information about pricing catalogs for specified devices, groups, and subscriptions.
  - Catalog Item MDCs
    The catalog item APIs return information about eligible catalog items for specified devices, groups, and subscriptions.
  - Charge-Related MDCs
    This section describes the charge-related MDCs for MATRIXX API calls.
  - Contract MDCs
    Contract data is returned in the product offer API responses in the MtxPurchasedOfferInfo MDC.
  - Datatrans MDCs
    The Datatrans MDCs include information for the Datatrans Payment Gateway.
  - Data Migration MDCs
    Use the following MDCs to import data for users, subscriptions, groups, and devices and to import catalog item purchase information for a subscription.
  - Device MDCs
    This section lists the device-related MDCs.
  - Diameter MDCs
    This section includes the Diameter-related APIs.
  - Eligibility Rules MDCs
    This section describes the SubMan eligibility rules APIs.
  - Event MDCs
    This section includes the event-related APIs.
  - Evertec MDCs
    This section includes the Evertec-specific SubMan APIs.
  - External Payment MDCs
    External payment APIs query external payment requests and get a list of external payment request records in a wallet.
  - Group MDCs
    This section lists the group-related APIs.
    - GroupBalance
      Manage group balances.
    - GroupEvent
      Use the following APIs to manage group events.
    - GroupMembership
      Use the following APIs to manage group membership.
    - GroupOffer
    - GroupQuery
      Subscriber, group, and device event queries query the in-memory event database.
    - GroupUser
      These calls manage users associated with groups.
    - MtxGroupExtension
      Base MDC for user defined extensions to group object
    - MtxGroupIdInfo
      This section describes the MtxGroupIdInfo fields.
    - MtxGroupSearchData
      Common structure for operations that need to lookup a group by one of the supported lookup methods. Only one of these keys will actually be used.
    - MtxRequestGroupAddRechargeSchedule
      Request to associate a recharge schedule with the specified group. There is only one recharge schedule per group. If there is an existing recharge schedule, it will be replaced.
    - MtxRequestGroupContractDebtPayment
      Request to pay contract debt.
    - MtxRequestGroupCreate
      Request that a new group is created in the subscriber DB and is initialized with the information provided. A unique OID will be created and returned. If supplied, the ExternalId must be unique within the subscriber database. The actual type of group instance created depends on the type of the group extension in the Attr field. If not supplied, the system default group is created.
    - MtxRequestGroupDelete
      Delete the specified group from the system. It must be in a state that allows deletion.
    - MtxRequestGroupEstimateRecurringCharge
      Estimate the balance impacts of upcoming recurring processing for a group.
    - MtxRequestGroupFinanceContractPrincipalPayment
      Request used to to pay additional principal payments or completely pay-off the principal for a finance contract
    - MtxRequestGroupModify
      Request that information on an existing group is modified. Only those values that are present in the request will be modified in the group - all other group values will be unchanged. If supplied, the Attr extension object must be of the same type as that used to create the group.
    - MtxRequestGroupModifyRechargeSchedule
      Request to modify the recharge schedule associated with the specified group. If there is no existing recharge schedule, it will return an error.
    - MtxRequestGroupPayment
      Request that a payment be made on the group's main balance
    - MtxRequestGroupRecharge
      Group request to recharge to prepaid main balance.
    - MtxRequestGroupRemoveRechargeSchedule
      Request to remove the recharge schedule associated with the specified group.
    - MtxRequestGroupRemoveThreshold
      Request to remove a custom credit limit or threshold value from a balance in the group wallet. The balance threshold must have already been customized and the default credit limit / threshold defined in pricing will become active on successful removal of the custom value.
    - MtxRequestGroupResumeOffer
      Request to resume an existing purchased item (offer or bundle) owned by a group.
    - MtxRequestGroupSettlePayment
      Request to settle a group payment.
    - MtxRequestGroupSuspendOffer
      Request to suspend an existing purchased item (offer or bundle) owned by a group.
  - Mastercard MDCs
    This section includes the Mastercard-specific SubMan APIs.
  - mPAY MDCs
    This section describes the mPAY MDCs.
  - Multi-Tenant MDCs
    The multi-tenant APIs return tenant information for individual tenants and all tenants.
  - Notification MDCs
    This section includes the notification MDCs.
  - Parameter MDCs
    This section includes the parameter MDCs.
  - Pay Now Payment MDCs
    The Pay Now payment SubMan APIs query payment information and add or remove payment method tokens for subscribers and groups.
  - Policy MDCs
    This section lists the MATRIXX Policy application APIs.
  - Pricing MDCs
    This section describes the pricing-related APIs.
  - Product Offer MDCs
    This section describes the product offer-related APIs.
  - Purchase Package MDCs
    Use the purchase package MDCs to manage catalog items in a purchase package, including adding and removing catalog items for subscriptions, groups, and devices, and suspending, resuming, and canceling purchase packages.
  - Purchased Item MDCs
    This section lists the purchased item APIs.
  - Recharge MDCs
    This section describes the recharge MDC fields.
  - Rehoming MDCs
    The rehoming APIs move a _glossary/subscription.html, 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.
  - Related Objects
    This section describes the common structures for related objects, related subscription objects, and related user objects.
  - Request/Response MDCs
    This section includes request and response APIs.
  - Roaming MDCs
    This section describes the roaming MDCs.
  - Romcard V2 MDCs
    This section describes the Romcard V2 MDCs.
  - Security MDCs
    The ApiEventSecurityInfo MDC records client security information.
  - Status MDCs
    The status APIs change the status of existing subscriptions, groups, and devices. They cancel any scheduled status change for a purchased item (offer or bundle) from subscriptions, groups, and devices. They cancel any scheduled status change for subscriptions, groups, and devices.
  - Subscriber MDCs
    This section lists the subscriber-related APIs.
  - Subscription MDCs
    The subscription APIs create, delete, modify, and query subscription objects.
  - Subscription/Group Membership MDCs
    This section describes the subscription/group membership MDC.
  - Tax MDCs
    This section lists the tax APIs.
  - Tenant MDCs
    This section lists the tenant APIs.
  - User MDCs
    This section describes the user object APIs.
  - MtxOpMsg
    MDC container for request/response handling.
- REST API Management
  RS Gateway supports the REST API bindings for accessing subscriber data in MATRIXX Engine. RS Gateway consists of an rsgateway application and a set of REST APIs.
- REST API Reference
  This part describes how to use the REST API bindings to interface with MATRIXX Engine.
- Java API
  This part 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
MATRIXX Third-Party Licenses
Glossary

MtxGroupIdInfo

This section describes the MtxGroupIdInfo fields.

MtxGroupIdInfo Fields describes the MtxGroupIdInfo fields.

Table 1. MtxGroupIdInfo Fields
Name	Type	Flags	Description
ObjectId	object id	Optional	ObjectID of group.
ExternalId	string	Optional	ExternalID of group, if one is set.