Requesting activation of an entitlement when the activation URL has expired

Overview

Sometimes a user initiates the purchase of a third party product, but fails to use the provided activation URL before it expires.

When they try to complete the purchase process, if the status of the entitlement is still PENDING, the CRM system needs to:

Call OpenTV Platform to get a new Bango activation URL.
This request is explained below.
Use the activation URL to activate the entitlement.
If this is successful, Bango notifies OpenTV Platform asynchronously. OpenTV Platform then calls a specific endpoint on the CRM system to notify it. (See Handling third-party product entitlement changes.)

Request

To check the status of an entitlement, the CRM system sends a GET request to:

BASH

https://<host>:<port>/tpes/v1/operator/entitlements/{entitlementId}/activationinfo

Headers

x-correlation-id – identifier for logging, to correlate messages across a call flow
nv-tenant-id – tenant ID
Authorization – Keycloak access token (see Accessing operator APIs using Keycloak)

Mandatory arguments

entitlementId – the ID of the entitlement

Optional arguments

None

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

A forbidden request returns an HTTP 403 status.

If the specified entitlement does not exist, the request returns an HTTP 404 status.

See the CRM Gateway API documentation v1 for the specific error codes and their meanings.

Example

A successful request returns a response that looks like this:

JSON

{
  "entitlementId": "abc123",
  "responseCode": "200",
  "responseMessage": "OK",
  "parameters": {
    "action": "NAVIGATE_TO_URL",
    "url": "https://bango.com/activate/xyz456",
    "urlExpiry": "2025-08-15T09:32:51.690Z"
  }
}