Skip to main content
Here are some frequently asked questions about the Bango Resale API.
By default, Bango allows one entitlement per customer per merchant.If the merchant allows, Bango can increase this.
Scenario:
  1. You create an entitlement which requires the customer to activate the service with the merchant
  2. The Bango Resale API returns an entitlement in state PENDING and asks you to redirect the customer to a particular URL
  3. You redirect the customer to the URL, but a timeout has occurred and the activation URL is no longer valid
In this case, the customer sees an error message on the merchant page. The customer must restart the activation flow themselves.
The Bango Resale API does not require client certificates.See the full connectivity and security requirements.
The customerIdentifier field is your own unique, persistent identifier for the user accessing the service. The Bango Platform treats the value as opaque.The entitlementId field is the globally unique, opaque identifier for a single entitlement. The Bango Platform generates this identifier.
The echo API endpoint is completely optional.The purpose of the echo API endpoint is to allow you to check your connectivity to the Bango Platform and the Bango Resale API. It lets you:
  • Verify you’re using the correct root URL for the Bango Resale API
  • Validate your Basic authentication credentials
  • Confirm that the Bango Resale API is currently available
The Bango Resale API lets you update an entitlement at any time.A common reason to update an entitlement is to change the product key as a result of a user selection or a time-based event. For example, the user might move from a six-month promotion to a fully paid service.
There are two ways to end an entitlement and remove a customer’s access to a service:The cancellation API triggers a “soft ending”: the customer can continue to access the service until the end of the period for which they’ve already paid. The API requests the merchant to cancel the service at the end of the current billing cycle – normally the moment at which the customer would next make a payment to continue using the service.The revocation API triggers a “hard ending”: the customer loses access to the service immediately. For example, if a customer permanently deletes their account, you might want to revoke access to the service straight away.Both approaches are valid, depending on requirements.
When you create (recommended) or update an entitlement, you can provide a notificatioUrl parameter. The Bango Platform sends an asynchronous POST request to this URL whenever the entitlement changes for any reason.Bango recommends you always set a notification URL. For example, the Bango Platform sends a notification for these events:
  • To confirm that a customer has signed up with the merchant and the entitlement has activated (the customer has access to the service)
  • To notify the reseller that the merchant has canceled the customer’s subscription to the service
  • To notify the merchant that the customer has canceled the subscription through the reseller
For more information, see Bango Resale / For resellers / Reseller API reference / Notifications from Bango.
When you create (recommended) or update an entitlement, you can provide a notificatioUrl parameter. The Bango Platform sends an asynchronous POST request to this URL whenever the entitlement changes for any reason. For example, when an entitlement is activated after the customer signs up with the merchant, or when the entitlement is cancelled directly with the merchant.You can use the same URL for all entitlements, or use a distinct URL for each entitlement – it’s up to you. It doesn’t matter whether the entitlement requires customer activation at a merchant URL, or not. Bango recommends you always set a notification URL.For more information, see Bango Resale / For resellers / Reseller API reference / Notifications from Bango.
Scenario:
  • You use the Bango Resale API to create an entitlement for a customer, but they’ve already signed up with that merchant and aren’t eligible for your offer
In some cases, the merchant can notify Bango that the customer isn’t eligible. If so, Bango can pass this notification to you using the Notification URL provided as part of the API request to create the entitlement.
A customer may decide to cancel a service provided directly by a merchant because they want to move to the same service provided through a reseller.If they do so, whether they receive a refund depends on the merchant and the country.Bango Support can help you speak to the merchant to confirm the behavior.
Normally the merchant owns the customer experience flows, and is responsible for approving any reseller customer experience related to the merchant brand.
Scenario:
  1. You send a request to create an entitlement, and that entitlement is now in the PENDING state
  2. You send another request to create an entitlement, with exactly the same parameters as the first request
In this case, the Bango Resale API responds with a new activation URL. Redirect the customer to the new URL for signup.
Sometimes the Bango Resale API returns HTTP 400 BAD_REQUEST when you create a subscription. The responseMessage property in the response body can help you identify the reason for the response.
  • If the entitlement already exists and is in ACTIVE state, then the responseMessage property is Invalid request or the request contains invalid data. Maximum number of subscriptions for user reached
  • If the request is invalid, then the responseMessage is parameter is required or parameter is invalid, where parameter is the name of the parameter