Check user eligibility

curl --request POST \
  --url https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Client_API/1.1.0/v1/entitlement/checkeligibility \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bangoUserId": "1549053185",
  "customerId": "abc@email.co.uk",
  "resellerId": "XYZ_RESELLER",
  "productId": "BangoMusic"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bangoUserId: '1549053185',
    customerId: 'abc@email.co.uk',
    resellerId: 'XYZ_RESELLER',
    productId: 'BangoMusic'
  })
};

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

import requests

url = "https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Client_API/1.1.0/v1/entitlement/checkeligibility"

payload = {
    "bangoUserId": "1549053185",
    "customerId": "abc@email.co.uk",
    "resellerId": "XYZ_RESELLER",
    "productId": "BangoMusic"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "eligible": true,
  "reason": "User is eligible for this Entitlement"
}

{
  "responseCode": "BAD_REQUEST",
  "responseMessage": "Invalid request."
}

{
  "responseCode": "UNAUTHORIZED",
  "responseMessage": "Invalid access credentials."
}

{
  "responseCode": "TOO_MANY_REQUESTS",
  "responseMessage": "Request limit reached. Please try again later."
}

{
  "responseCode": "INTERNAL_ERROR",
  "responseMessage": "The server encountered an unexpected condition which prevented it from fulfilling the request."
}

{
  "responseCode": "SERVICE_UNAVAILABLE",
  "responseMessage": "The server is undergoing maintenance and is not available. Please, try again later."
}

POST

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

entitlement

checkeligibility

Check user eligibility

curl --request POST \
  --url https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Client_API/1.1.0/v1/entitlement/checkeligibility \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bangoUserId": "1549053185",
  "customerId": "abc@email.co.uk",
  "resellerId": "XYZ_RESELLER",
  "productId": "BangoMusic"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bangoUserId: '1549053185',
    customerId: 'abc@email.co.uk',
    resellerId: 'XYZ_RESELLER',
    productId: 'BangoMusic'
  })
};

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

import requests

url = "https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Client_API/1.1.0/v1/entitlement/checkeligibility"

payload = {
    "bangoUserId": "1549053185",
    "customerId": "abc@email.co.uk",
    "resellerId": "XYZ_RESELLER",
    "productId": "BangoMusic"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "eligible": true,
  "reason": "User is eligible for this Entitlement"
}

{
  "responseCode": "BAD_REQUEST",
  "responseMessage": "Invalid request."
}

{
  "responseCode": "UNAUTHORIZED",
  "responseMessage": "Invalid access credentials."
}

{
  "responseCode": "TOO_MANY_REQUESTS",
  "responseMessage": "Request limit reached. Please try again later."
}

{
  "responseCode": "INTERNAL_ERROR",
  "responseMessage": "The server encountered an unexpected condition which prevented it from fulfilling the request."
}

{
  "responseCode": "SERVICE_UNAVAILABLE",
  "responseMessage": "The server is undergoing maintenance and is not available. Please, try again later."
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

X-RequestIdentifier

string

Request unique identifier. This id should be used for idempotency.

Body

application/json

The check eligibility JSON sent to merchant to check is user is eligible for a subscription

bangoUserId

string

required

Unique identifier which Bango holds that representing a specific customer of the reseller.

Example:

"1549053185"

customerId

string

required

Unique identifier representing a specific customer of the reseller.

Example:

"abc@email.co.uk"

resellerId

string

required

Unique reseller identifier as agreed with the merchant

Example:

"XYZ_RESELLER"

productId

string

required

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

Example:

"BangoMusic"

offerId

string

Entitlement offer unique identifier. For example, "6_MONTHS_ON_US".

Example:

"6_MONTHS_ON_US"

merchantExtensionData

object

Show child attributes

Example:

{
  "merchantCustomData1": "merchantCustomDataValue1",
  "merchantCustomData2": "merchantCustomDataValue2",
  "merchantCustomData3": "merchantCustomDataValue3"
}

merchantBangoExtensionData

object

Show child attributes

Example:

{
  "merchantCustomData1": "merchantBangoCustomDataValue1",
  "merchantCustomData2": "merchantBangoCustomDataValue2",
  "merchantCustomData3": "merchantBangoCustomDataValue3"
}

Response

Valid User eligibility response

eligible

boolean

Eligibility status. Possible values are:

true: The user is eligible for the Entitlement
false: The user is not eligible for the Entitlement

Example:

true

reason

string

Reason for the eligibility response. This is not a mandatory value to be sent by the merchant. Examples:

"User has an existing subscription"

Example:

"User is eligible for this Entitlement"

DVM APIs

Products

Offers

Consumer Offers

Entitlements

Notifications

Eligibility

Charge

Testing

Check user eligibility

Authorizations

Headers

Body

Response