MarketONE APIs

Contents

Overview

There are four endpoints that MarketONE exposes to over-the-top providers (OTTs), and four that are exposed to communications service providers (CSPs), along with the following three common endpoints: Account, PartnerSubscription, and Notification. The Transaction endpoint is specifically for OTTs, and the Subscription endpoint is specifically for CSPs. The MarketONE APIs interact with these endpoints.

Note: MarketONE APIs are idempotent. This means that if MarketONE receives the same transaction multiple times, then MarketONE will return the same outcome.

Common Endpoints for OTTs and CSPs

Account: If a customer goes to Netflix, purchases a service, and then requests pay on bill, Netflix will then call the Account validate API to request to validate whether this account exists in the CSP's billing system. The Account validate API will then talk to the backend system and validate whether the account exists. If so, it will then indicate that a purchase can be made, and that the customer can be accepted as pay on bill.

PartnerSubscription: This is the correlation between an OTT and the subscription the customer paid for. This PartnerSubscription API will be called by the OTT to notify MarketONE when the customer completes the service purchase, or after the user activates the service.

Notification: The Notification API handles notifications to a customer for confirming a purchase, or for a successful order. MarketONE also supports an event based notification where a separate API is not required.

Specific Endpoints for OTTs

Transaction: Once the customer completes the purchase of an OTT's service, the Transaction API is called. MarketONE then injects the charge to the CSP's billing system.

Specific Endpoint for CSPs

Subscription: In cases where the customer purchases a product from the CSP's digital store, the Subscription API is used to create the user's account in MarketONE (which in turn uses the AddSubscription callback to inform the partner of the purchase).

Example Diagram

Consider the following diagram. It shows the MarketONE APIs for CSP Integration Guide and OTT Integration Guide and how they function in response to OTT initiated and CSP initiated purchases.

Revision History

Version Description
2019.08 Initial release.
2019.09 Added a note about idempotency.
2019.12 Added Contents and Revision History sections.
2020.01 Changed the title of this topic to MarketONE APIs, updated the endpoint descriptions, and moved it to the API Guides section.
2020.02 Updated the diagram in the Example Diagram section to account for OTT initiated and CSP initiated purchases.