APIs Implemented by the CSP: Version 1.0
Contents
Overview
The following table lists and describes the APIs that need to be implemented by the communications service provider (CSP).
API | Description |
---|---|
POST /account/validate | The API validates the account information on the BSS platform. This API is expected to be supported by CSP BSS. Note: The account entity is a reference to the billing account in the BSS system of the CSP. The CSP backend system will need to expose APIs for the MarketONE platform to retrieve the account (based on a phone number or an email address), and validate if it is in good standing to support the purchase of the over-the-top (OTT) provider service by the user on the OTT website. |
POST /notification | This API sends a notification to the customer. This API call needs to be supported by the CSP's backend system to send customer notifications. Note: MarketONE will send a notification to the customer at the time of purchase, or when a charge is applied to the customer's account. The notification message can be sent by the BSS system based on the customer's communication preferences. |
POST /transaction | This API creates a new payment transaction. This is the API call that the digital partner makes on MarketONE for an OTT initiated charge to be posted. This is a direct carrier billing API that connects the OTT providers to the CSP's BSS for charging and billing. CSPs will need to expose an API on the BSS to apply the charge initiated by an OTT against a specific user account and service. The payment charge event will also contain the description to be populated on the billing system to reflect the charge on the invoice. This API is built to provide high availability and high scale payment processing and will need to be supported by a similar backend API. Note: Part of the ongoing relationship between customers and CSPs consists in changes that are made to customer BSS accounts and subscriptions. Since MarketONE sends in transactions from OTTs that are posted on the customer's invoice, it is imperative that MarketONE be updated on the changes that are made to customer accounts and service profiles. |
MarketONE Developer Portal
Please refer to the MarketONE APIs - V1 section under the API Reference menu on the MarketONE Developer Portal for an OpenAPI instance of these APIs.
Revision History
Version | Description |
---|---|
2019.11 | Added this topic. |
2019.12 | Added Contents and Revision History sections. |
2020.05 | Added the MarketONE Developer Portal section. |