Get a list of entitlements for a bangoUserId or sharedCustomerId, matching specific criteria

curl --request POST \
  --url https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Server_API/1.1.0/v1/merchant/entitlement/report \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resellerId": "XYZ_RESELLER"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({resellerId: 'XYZ_RESELLER'})
};

fetch('https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Server_API/1.1.0/v1/merchant/entitlement/report', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Server_API/1.1.0/v1/merchant/entitlement/report"

payload = { "resellerId": "XYZ_RESELLER" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "responseCode": "OK",
  "responseMessage": "Success",
  "entitlements": [
    {
      "merchantEntitlementId": "6673b39e-8302-412d-bbdb-446c96c34871",
      "requestId": "981a55a5-b3a4-46dc-9fac-a86227b26344",
      "bangoUserId": "1549053185",
      "sharedCustomerId": "414b3019-0c28-4d14-9c5f-6217b8bd1e3e",
      "productId": "30_DAYS_MUSIC",
      "offerId": "FREE_FOR_6_MONTHS",
      "resellerId": "XYZ_RESELLER",
      "status": "ACTIVE",
      "customerId": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateActivated": "2023-11-07T05:31:56Z",
      "dateExpiry": null,
      "dateEnded": null,
      "dateSuspended": null,
      "dateResumed": null,
      "dateAutoSuspend": null,
      "merchantExtensionData": {
        "merchantCustomData1": "merchantCustomDataValue1",
        "merchantCustomData2": "merchantCustomDataValue2",
        "merchantCustomData3": "merchantCustomDataValue3"
      },
      "extraInformation": {
        "clientDevice": {
          "type": "STB",
          "id": "bc449c9e-406f-4399-a3ff-8671a27ac410",
          "typeId": "P49AJFND8NFN23NANGAJG",
          "modelName": "STB Model X7",
          "modelNumber": "IAH45IAOF/5",
          "serialNumber": "JHFJHA43JNFA9393GFD",
          "osType": "Linux",
          "osVersion": "10.3.8",
          "macAddress": "4A-0F-99-F2-D3-DD",
          "browser": "Firefox"
        },
        "communicationInformation": {
          "emailAddress": "123@abc.co.uk",
          "msisdn": "441234567890"
        },
        "source": {
          "channelType": "WEB_PROMOTION",
          "campaignRef": "SUMMER_PROMO",
          "referrer": "SEARCH_ENGINE",
          "bundleId": "BundleABC123",
          "country": "United Kingdom",
          "region": "East Anglia",
          "brand": "BrandABC",
          "serviceFlow": "Creation"
        }
      },
      "financeData": {
        "source": "Merchant",
        "type": "order",
        "timestamp": "2023-11-07T05:31:56Z",
        "retailCurrency": "<string>",
        "retailPrice": 123,
        "retailPriceTax": 123,
        "offerPrice": 123,
        "offerPriceTax": 123,
        "notes": "<string>"
      },
      "merchantBangoExtensionData": {
        "merchantCustomData1": "merchantBangoCustomDataValue1",
        "merchantCustomData2": "merchantBangoCustomDataValue2",
        "merchantCustomData3": "merchantBangoCustomDataValue3"
      }
    }
  ]
}

POST

https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Server_API/1.1.0

merchant

entitlement

report

Get a list of entitlements for a bangoUserId or sharedCustomerId, matching specific criteria

curl --request POST \
  --url https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Server_API/1.1.0/v1/merchant/entitlement/report \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resellerId": "XYZ_RESELLER"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({resellerId: 'XYZ_RESELLER'})
};

fetch('https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Server_API/1.1.0/v1/merchant/entitlement/report', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Server_API/1.1.0/v1/merchant/entitlement/report"

payload = { "resellerId": "XYZ_RESELLER" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "responseCode": "OK",
  "responseMessage": "Success",
  "entitlements": [
    {
      "merchantEntitlementId": "6673b39e-8302-412d-bbdb-446c96c34871",
      "requestId": "981a55a5-b3a4-46dc-9fac-a86227b26344",
      "bangoUserId": "1549053185",
      "sharedCustomerId": "414b3019-0c28-4d14-9c5f-6217b8bd1e3e",
      "productId": "30_DAYS_MUSIC",
      "offerId": "FREE_FOR_6_MONTHS",
      "resellerId": "XYZ_RESELLER",
      "status": "ACTIVE",
      "customerId": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateActivated": "2023-11-07T05:31:56Z",
      "dateExpiry": null,
      "dateEnded": null,
      "dateSuspended": null,
      "dateResumed": null,
      "dateAutoSuspend": null,
      "merchantExtensionData": {
        "merchantCustomData1": "merchantCustomDataValue1",
        "merchantCustomData2": "merchantCustomDataValue2",
        "merchantCustomData3": "merchantCustomDataValue3"
      },
      "extraInformation": {
        "clientDevice": {
          "type": "STB",
          "id": "bc449c9e-406f-4399-a3ff-8671a27ac410",
          "typeId": "P49AJFND8NFN23NANGAJG",
          "modelName": "STB Model X7",
          "modelNumber": "IAH45IAOF/5",
          "serialNumber": "JHFJHA43JNFA9393GFD",
          "osType": "Linux",
          "osVersion": "10.3.8",
          "macAddress": "4A-0F-99-F2-D3-DD",
          "browser": "Firefox"
        },
        "communicationInformation": {
          "emailAddress": "123@abc.co.uk",
          "msisdn": "441234567890"
        },
        "source": {
          "channelType": "WEB_PROMOTION",
          "campaignRef": "SUMMER_PROMO",
          "referrer": "SEARCH_ENGINE",
          "bundleId": "BundleABC123",
          "country": "United Kingdom",
          "region": "East Anglia",
          "brand": "BrandABC",
          "serviceFlow": "Creation"
        }
      },
      "financeData": {
        "source": "Merchant",
        "type": "order",
        "timestamp": "2023-11-07T05:31:56Z",
        "retailCurrency": "<string>",
        "retailPrice": 123,
        "retailPriceTax": 123,
        "offerPrice": 123,
        "offerPriceTax": 123,
        "notes": "<string>"
      },
      "merchantBangoExtensionData": {
        "merchantCustomData1": "merchantBangoCustomDataValue1",
        "merchantCustomData2": "merchantBangoCustomDataValue2",
        "merchantCustomData3": "merchantBangoCustomDataValue3"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication

Headers

X-RequestIdentifier

string

Request unique identifier. If present, this id will be used for idempotency.

Body

application/json

The report filters JSON.

List of filters applied to retrieve a list of existing entitlements

resellerId

string

required

Unique reseller identifier

Example:

"XYZ_RESELLER"

bangoUserId

string

User unique identifier. Include this OR the sharedCustomerId

Example:

"1549053185"

sharedCustomerId

string<uuid>

Bango generated id shared between reseller and merchant for this customer (contact support for setup). Include this OR bangoUserId

Example:

"414b3019-0c28-4d14-9c5f-6217b8bd1e3e"

productId

string

Entitlement product unique identifier. For example, "BangoMusic".

Example:

"BangoMusic"

status

enum<string>

Entitlement status. Possible values are:

"ACTIVE": The entitlement has been successfully activated
"CANCELLED": The entitlement has been cancelled.
"REVOKED": The entitlement has been revoked. This usually happens on fraud and user contract termination cases.
"SUSPENDED": The entitlement has been suspended.
"PENDING": The entitlement has been initiated, but the user has not yet finalized the activation process.
"FAILED": The entitlement failed
"ACTIVE-ENDING": The entitlement is ending at the end of the current period.

Available options:

ACTIVE,

CANCELLED,

REVOKED,

SUSPENDED,

PENDING,

FAILED,

ACTIVE-ENDING

Response

Retrieval successful

responseCode

string

Example:

"OK"

responseMessage

string

Example:

"Success"

entitlements

object[]

Show child attributes

DVM APIs

Products

Offers

Consumer Offers

Entitlements

Notifications

Eligibility

Charge

Testing

Get a list of entitlements for a bangoUserId or sharedCustomerId, matching specific criteria

Authorizations

Headers

Body

Response