The SubMan API reference includes SubMan API and MDC descriptions.
This section includes request and response APIs.
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.
The following information is an overview of the SubMan APIs and architecture.
The following sections introduce how the various in-memory objects are managed.
The application MDCs include information for each Rx application session in a response for device sessions.
This section includes balance-related MDCs.
This section describes the Barclay MDCs.
This section includes the bundle MDCs.
This section includes billing-related MDCs.
This section includes the Braintree-specific SubMan APIs.
The catalog APIs return information about pricing catalogs for specified devices, groups, and subscriptions.
The catalog item APIs return information about eligible catalog items for specified devices, groups, and subscriptions.
This section describes the charge-related MDCs for MATRIXX API calls.
Contract data is returned in the product offer API responses in the MtxPurchasedOfferInfo MDC.
The Datatrans MDCs include information for the Datatrans Payment Gateway.
Use the following MDCs to import data for users, subscriptions, groups, and devices and to import catalog item purchase information for a subscription.
This section lists the device-related MDCs.
This section includes the Diameter-related APIs.
This section describes the SubMan eligibility rules APIs.
This section includes the event-related APIs.
This section includes the Evertec-specific SubMan APIs.
External payment APIs query external payment requests and get a list of external payment request records in a wallet.
This section lists the group-related APIs.
This section includes the Mastercard-specific SubMan APIs.
This section describes the mPAY MDCs.
The multi-tenant APIs return tenant information for individual tenants and all tenants.
This section includes the notification MDCs.
This section includes the parameter MDCs.
The Pay Now payment SubMan APIs query payment information and add or remove payment method tokens for subscribers and groups.
This section lists the MATRIXX Policy application APIs.
This section describes the pricing-related APIs.
This section describes the product offer-related APIs.
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.
This section lists the purchased item APIs.
This section describes the recharge MDC fields.
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.
This section describes the common structures for related objects, related subscription objects, and related user objects.
Base container for all SubMan requests.
Process multiple enclosed sub-requests as one transaction.
Base MDC container for all operation responses.
Response to adding items with a resourceid
Response to creating a new DB object.
Response to return the list of cancelable one-time offer purchases.
Balance impacts of upcoming recurring processing for a subscriber or group.
Response to multiple requests.
Response to resuming a purchased item (offer or bundle).
Response to suspending a purchased item (offer or bundle).
Response to balance transfer request: MtxRequestSubscriberTransferBalance, MtxRequestGroupTransferBalance.
This section describes the roaming MDCs.
This section describes the Romcard V2 MDCs.
The ApiEventSecurityInfo MDC records client security information.
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.
This section lists the subscriber-related APIs.
The subscription APIs create, delete, modify, and query subscription objects.
This section describes the subscription/group membership MDC.
This section lists the tax APIs.
This section lists the tenant APIs.
This section describes the user object APIs.
MDC container for request/response handling.
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.
This part describes how to use the REST API bindings to interface with MATRIXX Engine.
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.
