Create Entitlement

Create Entitlement

curl --request POST \
  --url https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Client_API/1.1.0/v1/entitlement \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f",
  "bangoUserId": "1549053185",
  "resellerId": "XYZ_RESELLER",
  "productId": "BangoMusic"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    requestId: 'a25100b8-4e0c-4e37-b921-cac9cb1e930f',
    bangoUserId: '1549053185',
    resellerId: 'XYZ_RESELLER',
    productId: 'BangoMusic'
  })
};

fetch('https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Client_API/1.1.0/v1/entitlement', 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"

payload = {
    "requestId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f",
    "bangoUserId": "1549053185",
    "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)

{
  "merchantEntitlementId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f"
}

{
  "merchantEntitlementId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f"
}

{
  "merchantEntitlementId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f",
  "activationUrl": "https://merchant-website.com/new-entitlement/activation-url",
  "expiryTime": "2020-01-28T14:15:03Z"
}

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

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

{
  "responseCode": "ALREADY_EXISTS",
  "responseMessage": "Entitlement already exists."
}

{
  "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

Create Entitlement

curl --request POST \
  --url https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Client_API/1.1.0/v1/entitlement \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f",
  "bangoUserId": "1549053185",
  "resellerId": "XYZ_RESELLER",
  "productId": "BangoMusic"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    requestId: 'a25100b8-4e0c-4e37-b921-cac9cb1e930f',
    bangoUserId: '1549053185',
    resellerId: 'XYZ_RESELLER',
    productId: 'BangoMusic'
  })
};

fetch('https://virtserver.swaggerhub.com/BangoProducts/MerchantInterface_Client_API/1.1.0/v1/entitlement', 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"

payload = {
    "requestId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f",
    "bangoUserId": "1549053185",
    "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)

{
  "merchantEntitlementId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f"
}

{
  "merchantEntitlementId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f"
}

{
  "merchantEntitlementId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f",
  "activationUrl": "https://merchant-website.com/new-entitlement/activation-url",
  "expiryTime": "2020-01-28T14:15:03Z"
}

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

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

{
  "responseCode": "ALREADY_EXISTS",
  "responseMessage": "Entitlement already exists."
}

{
  "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 entitlement JSON sent to merchant to create a subscription

requestId

string

required

Unique identifier representing a specific entitlement.

Example:

"a25100b8-4e0c-4e37-b921-cac9cb1e930f"

bangoUserId

string

required

Unique identifier representing a specific customer of the reseller as a Bango anonymised value.

Example:

"1549053185"

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"

sharedCustomerId

string<uuid>

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

Example:

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

offerId

string

The offer given to the user for the merchant service. For example, "FREE_FOR_6_MONTHS".

Example:

"FREE_FOR_6_MONTHS"

customerId

string

Unique identifier representing a specific customer of the reseller not anonymised. This value will only be sent by Bango if the Merchant and Reseller both approve the sharing of this data

status

enum<string>

Entitlement status. Possible values are:

"ACTIVE": The entitlement has been successfully activated
"SUSPENDED": The entitlement has been suspended.
"PENDING": The entitlement has been initiated, but the user has not yet finalized the activation process.
"ACTIVE-ENDING": The entitlement is ending at the end of the current period.

Available options:

ACTIVE,

SUSPENDED,

PENDING,

ACTIVE-ENDING

Example:

"PENDING"

merchantExtensionData

object

Show child attributes

Example:

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

extraInformation

object

Show child attributes

financeData

object

Show child attributes

merchantBangoExtensionData

object

Show child attributes

Example:

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

Response

Entitlement created and activated successfully.

merchantEntitlementId

string

required

Unique identifier representing the entitlement as identified by the merchant. Value must be URL friendly.

Example:

"a25100b8-4e0c-4e37-b921-cac9cb1e930f"

DVM APIs

Products

Offers

Consumer Offers

Entitlements

Notifications

Eligibility

Charge

Testing

Authorizations

Headers

Body

Response