The SubMan API reference includes SubMan API and MDC descriptions.
This section lists the group-related APIs.
Manage group balances.
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.
Request to add a custom credit limit or threshold value to a balance in the group wallet. The balance credit limit / threshold must have been defined in My MATRIXX. Any existing customization will be overwritten.
Adjust the balance owned by a group.
Adjust the rollover balance owned by a group.
Topup a balance owned by a group.
Request a balance transfer from the source group to the target subscriber or group. The source and target balance must be prepaid G/L balance instances of the same balance unit, for example, minutes or megabytes. The amount being transferred must be specified either as a positive absolute value or as a percentage of the available amount in the source balance.
Use the following APIs to manage group events.
Use the following APIs to manage group membership.
Subscriber, group, and device event queries query the in-memory event database.
These calls manage users associated with groups.
Base MDC for user defined extensions to group object
This section describes the MtxGroupIdInfo fields.
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.
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.
Request to pay contract debt.
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.
Delete the specified group from the system. It must be in a state that allows deletion.
Estimate the balance impacts of upcoming recurring processing for a group.
Request used to to pay additional principal payments or completely pay-off the principal for a finance contract
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.
Request to modify the recharge schedule associated with the specified group. If there is no existing recharge schedule, it will return an error.
Request that a payment be made on the group's main balance
Group request to recharge to prepaid main balance.
Request to remove the recharge schedule associated with the specified group.
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.
Request to resume an existing purchased item (offer or bundle) owned by a group.
Request to settle a group payment.
Request to suspend an existing purchased item (offer or bundle) owned by a group.
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.
This section includes request and response APIs.
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.
