OTT APIs: Version 1.0

Overview
OTT APIs
MarketONE Developer Portal
Revision History

Overview

This section contains details on the Version 1.0 over-the-top (OTT) provider APIs.

Note: The following guiding principles are applicable across all of the entities:

Mobile or phone numbers sent by the BSS either in the response or request payload should follow the E.164 format.
The email address when exchanged from the BSS should follow the RFC 5322 format.
The currency code will follow the ISO4217 format.

OTT APIs

Account

The following table lists and describes the API concerned with operations that validate accounts.

API	Description
POST /account/validate	This API validates the account information. The API call is expected to be made by the OTT. Note: The account entity is a reference to the end customer's billing account in the BSS of the service provider. The OTT makes the API call to MarketONE to retrieve the account based on a phone number or an email address. In turn, this is validated by MarketONE by contacting the communications service provider (CSP) as needed (for example: to verify if the customer account is in good standing to support the purchase of the OTT service).

API

Description

POST /account/validate

This API validates the account information. The API call is expected to be made by the OTT.
Note: The account entity is a reference to the end customer's billing account in the BSS of the service provider. The OTT makes the API call to MarketONE to retrieve the account based on a phone number or an email address. In turn, this is validated by MarketONE by contacting the communications service provider (CSP) as needed (for example: to verify if the customer account is in good standing to support the purchase of the OTT service).

Transaction

The following table lists and describes the APIs concerned with operations that create and retrieve transactions.

API	Descriptions
GET /transaction/{extTransactionID}	This API retrieves the status of a transaction from MarketONE. Note: The OTT requesting the transaction status should have initiated the transaction. The extTransactionID exists in MarketONE.
POST /transaction	This API creates a new payment transations. This is the API call that the OTT makes on MarketONE for an OTT-initiated charge to be posted. Note: This API is a direct carrier billing API that connects the OTTs to the CSP's backend for charging and billing. For carrier billing transactions initiated and billed by the OTTs, the payment transaction will be sent to MarketONE using the transaction endpoint. MarketONE will then charge the associated customer’s billing account with integration to the CSP's BSS, and will also use the transaction to run the settlements process.

API

Descriptions

GET /transaction/{extTransactionID}

This API retrieves the status of a transaction from MarketONE.
Note: The OTT requesting the transaction status should have initiated the transaction. The extTransactionID exists in MarketONE.

POST /transaction

This API creates a new payment transations. This is the API call that the OTT makes on MarketONE for an OTT-initiated charge to be posted.
Note: This API is a direct carrier billing API that connects the OTTs to the CSP's backend for charging and billing. For carrier billing transactions initiated and billed by the OTTs, the payment transaction will be sent to MarketONE using the transaction endpoint. MarketONE will then charge the associated customer’s billing account with integration to the CSP's BSS, and will also use the transaction to run the settlements process.

The following table lists and describes the APIs concerned with PIN integration operations.

API	Description
POST /pin	This API generates a one-time PIN required for customer validation. Note: This API call is used by OTTs to request MarketONE to generate the PIN. It should be used to resend the PIN as well.
POST /pin/validate	This API validates the one-time PIN generated by the POST /pin API call.

Notification

The following table lists and describes the API concerned with notification integration operations.

API	Description
POST /notification	This API sends a notification to the customer. Note: This API is used by an OTT to request MarketONE to send the requisite customer information.

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.08	Initial release.
2019.12	Added Contents and Revision History sections.
2020.01	Updated the Overview section by listing the endpoints for each API.
2020.05	Added the MarketONE Developer Portal section.