Terms and definitins
-
GPA - GP Analytics value-added service
-
IdP - identity provider
-
JWT - JSON web token
-
MPL - (Erste JV) Marketplace
Use cases
Note: data structures in the API operations were designed to support use cases
for subscriptions activated at company and at MID level. For that reason the data
elements are frequently designed to carry an array of items. For services activated
at company level, the array will always carry or provide at most one item. For
services activated at MID level, the array will carry or provide zero, one or more
items.
Display VAS subscription information
Context: merchant is logged in to the web application and navigates to the page for specific VAS (e.g. GPA).
Note: the data list will be populated only when there are some (at least one)
active service subscription(s). An empty data list indicates that there aren’t
any active subscriptions. For services activated at company level, at most one item
will be reported. For services activated at MID level, an item will be reported for
every MID that has the service activated.
Request VAS activation
Context: merchant is logged in to the web application and has navigated to the page for specific VAS (e.g. GPA). Merchant does not have active subscription for VAS and can submit request for activation (e.g. by clicking on a button).
Note: VAS subscription activation is a - potentially - long-running process. Once the request for activation was successfully submitted to the MPL server, the UI should monitor the status of the order and limit options available to the user in the UI accordingly.
Select VAS subscription for deactivation
Context: merchant is logged in to the web application and has navigated to the page for specific VAS (e.g. GPA). Merchant has active subscription for VAS and want’s to request its deactivation at the end of the subscription cycle.
Select VAS subscription for renewal
Context: merchant is logged in to the web application and has navigated to the page for specific VAS (e.g. GPA). Merchant has active subscription for VAS and has previously requested its deactivation at the end of the current subscription cycle and now wants to revers this action and keep the subscription.
