Patch Entitlement

Patch Entitlement

curl --request PATCH \
  --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 '
{
  "merchantEntitlementId": "6e37a4b5-8cb9-465b-88a9-ad5eb02596be",
  "bangoUserId": "1549053185",
  "productId": "30_DAYS_MUSIC",
  "resellerId": "XYZ_RESELLER"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    merchantEntitlementId: '6e37a4b5-8cb9-465b-88a9-ad5eb02596be',
    bangoUserId: '1549053185',
    productId: '30_DAYS_MUSIC',
    resellerId: 'XYZ_RESELLER'
  })
};

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 = {
    "merchantEntitlementId": "6e37a4b5-8cb9-465b-88a9-ad5eb02596be",
    "bangoUserId": "1549053185",
    "productId": "30_DAYS_MUSIC",
    "resellerId": "XYZ_RESELLER"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "responseCode": "OK",
  "responseMessage": "Success"
}

{
  "responseCode": "CLIENT_ACTION_REQUIRED",
  "responseMessage": "Request created and queued."
}

{
  "responseCode": "ACCEPTED",
  "responseMessage": "Request accepted"
}

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

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

{
  "responseCode": "NOT_FOUND",
  "responseMessage": "Entitlement not found."
}

{
  "responseCode": "INVALID_STATE",
  "responseMessage": "Operation invalid for the current state of the entitlement."
}

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

PATCH

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

entitlement

Patch Entitlement

curl --request PATCH \
  --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 '
{
  "merchantEntitlementId": "6e37a4b5-8cb9-465b-88a9-ad5eb02596be",
  "bangoUserId": "1549053185",
  "productId": "30_DAYS_MUSIC",
  "resellerId": "XYZ_RESELLER"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    merchantEntitlementId: '6e37a4b5-8cb9-465b-88a9-ad5eb02596be',
    bangoUserId: '1549053185',
    productId: '30_DAYS_MUSIC',
    resellerId: 'XYZ_RESELLER'
  })
};

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 = {
    "merchantEntitlementId": "6e37a4b5-8cb9-465b-88a9-ad5eb02596be",
    "bangoUserId": "1549053185",
    "productId": "30_DAYS_MUSIC",
    "resellerId": "XYZ_RESELLER"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "responseCode": "OK",
  "responseMessage": "Success"
}

{
  "responseCode": "CLIENT_ACTION_REQUIRED",
  "responseMessage": "Request created and queued."
}

{
  "responseCode": "ACCEPTED",
  "responseMessage": "Request accepted"
}

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

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

{
  "responseCode": "NOT_FOUND",
  "responseMessage": "Entitlement not found."
}

{
  "responseCode": "INVALID_STATE",
  "responseMessage": "Operation invalid for the current state of the entitlement."
}

{
  "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 you want to update

merchantEntitlementId

string<uuid>

required

Unique identifier used on activation

Example:

"6e37a4b5-8cb9-465b-88a9-ad5eb02596be"

bangoUserId

string

required

Unique user identifier, as identified by Bango

Example:

"1549053185"

productId

string

required

Entitlement product unique identifier. For example, "30_DAYS_MUSIC".

Example:

"30_DAYS_MUSIC"

resellerId

string

required

Unique reseller identifier

Example:

"XYZ_RESELLER"

sharedCustomerId

string<uuid>

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

Example:

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

entitlementBenefits

enum<string>

ENUM parameter to instruct the type of benefits action needed as part of the update request only if a change is required. This enum is used to suspend and resume entitlements using the update method.

Available options:

SUSPENDED,

NORMAL

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

offerId

string

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

Example:

"FREE_FOR_6_MONTHS"

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:

"ACTIVE"

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 updated successfully.

responseCode

string

Example:

"OK"

responseMessage

string

Example:

"Success"

DVM APIs

Products

Offers

Consumer Offers

Entitlements

Notifications

Eligibility

Charge

Testing

Authorizations

Headers

Body

Response