- Deprecated APIs
The following APIs are deprecated in this release of MATRIXX and support for these APIs will be removed in a future release.
- Balance, Meter, and Wallet REST APIs
The balance management APIs include the messaging required to operate on a balance, meter, or wallet object. The primitives include the messaging and data elements required to create, modify, associate, and query objects directly related to a balance or meter, including their thresholds.
- Catalog REST APIs
The catalog APIs return information about pricing catalogs for specified devices, groups, and subscriptions. They return catalog items that the specified object is eligible to purchase.
- 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 REST APIs
The device management APIs include the methods and functions required to operate on the device primary object. They include the data elements required to create, modify, and query devices, to add and remove a device from a subscription, and to delete a device from the Subscriber database.
- Eligibility Rules REST APIs
This section describes the APIs for querying catalog items based on eligibility. The APIs return catalog items that the specified object is eligible to purchase.
- Event REST APIs
The event APIs include the messaging and elements to return events and notifications in the Event Repository and the event database for subscriptions, groups, and users.
- External Payment REST APIs
External payment APIs query external payment requests and get a list of external payment request records in a
wallet.
- Gateway REST APIs
- Group REST APIs
The group management APIs include the messaging required to operate on the group object. The APIs include the messaging and data elements required to create, modify, associate, and query objects directly related to the group.
- Multi-Tenant REST APIs
The multi-tenant APIs get tenant information for individual tenants and all tenants.
- My MATRIXX REST APIs
My MATRIXX supports GET, PUT, and POST REST bindings. The { } notation around text represents a URL parameter.
- Offer Life Cycle REST APIs
Use these APIs to query a list of status life cycles for an offer. You can query specific offer status life cycle using the profile ID.
- Pay Now REST APIs
The integration layer REST APIs manage payment authorization tokens for the payment gateway from the integration layer. These tokens are necessary for the client to communicate directly with the payment gateway to create a payment method in the payment gateway.
- Policy REST APIs
The policy APIs allow you to query the Sy policy counters for a specific device.
- Pricing REST APIs
The pricing management APIs return information about all aspects of pricing, including catalog items, balance templates, product offers, billing cycles, life cycles, notifications and so forth. You can also get status information for the currently-loaded pricing.
- Product Offer REST APIs
The product offer management APIs include the messaging to activate, purchase, cancel, and modify catalog items. You can identify a product offer by its object ID or the external ID assigned during pricing plan creation.
- Purchase Package REST APIs
Use the purchase package APIs 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.
- Recurring Charge
The MtxRequestSubscriberEstimateRecurringCharge SubMan API estimates balance impacts from recurring processing of currently failing recurring cycles and upcoming recurring cycles (active purchased items cycles, balance cycles and billing cycles).
- Rehoming REST APIs
The rehoming APIs move a subscription, group, device, or user from one customer sub-domain to a different sub-domain. For a description of the rehoming process, see the discussion about rehoming subscribers, groups, devices, and users in the object management overview.
- Service APIs
The extended REST service APIs are implemented only in the RS Gateway. These APIs include REST services that manage subscribers, groups, and devices, including rehoming operations. In addition, you can start and stop rating sessions using the service APIs. Unlike the APIs described in MATRIXX Subscriber Management API, these APIs do not have a Python or Java equivalent. For information about the service API default filters, see the discussion about REST filters.
- Status Life Cycle REST APIs
Use these APIs to query status life cycle information for devices, groups, subscriptions, and users from the engine.
- Status Modify APIs
The status modify APIs schedule status changes and delete scheduled status changes. They also suspend and resume purchased items (product offer or bundle) if the current offer status class permits the action.
- Subscriber REST APIs
The Subscriber REST APIs described here are deprecated and will be removed in a future release.
- Subscription REST APIs
The subscription management APIs include the messaging required to operate on the subscriber object, which is a primary object for MATRIXX interactions. The API bindings include the messaging and data elements required to create, modify, and query objects directly related to the subscription. A subscription must have a
wallet secondary object, which is created for the subscription at subscription creation time.
- System REST APIs
The system REST APIs query the MATRIXX Engine to check if recurring recharge is enabled, return domain and sub-domain information, return tenant IDs, and create Pay Now client tokens.
- Tax REST APIs
The tax APIs manage information in the US Tax database.
- User REST APIs
Use the User REST APIs to add, update, query, and delete users. You can also get and modify user authentication data, associate users with groups and subscriptions, and modify or remove those associations.
