# Bango product documentation

> Product and API documentation for Bango Digital Vending Machine® (DVM™) and Direct Carrier Billing (DCB), including integration and operations guides.

- [Digital Vending Machine®](https://docs.bango.com/welcome.md): Use Digital Vending Machine® (DVM™) to provide subscriptions in indirect channels.
- [DVM onboarding](https://docs.bango.com/getting-started/dvm-onboarding.md): Set up your Partner, Sandbox access, authentication, and testing before progressing toward launch.
- [Quick start bundle](https://docs.bango.com/getting-started/quick-start-bundle.md): Use the DVM Sandbox with Bango Music to get started with subscription bundling.
- [Overview](https://docs.bango.com/partner-management/overview.md): Understand the Partner model, partnership journey, roles, Regional Entities, and user access in DVM.
- [Partners and hierarchy](https://docs.bango.com/partner-management/partners-and-hierarchy.md): Understand how businesses, brands, and operating companies are represented as Partners in DVM.
- [Partner roles](https://docs.bango.com/partner-management/partner-roles.md): Understand how Reseller and Content Provider roles describe how a Partner participates in DVM.
- [Discover partners](https://docs.bango.com/partner-management/partner-discovery.md): Find Partners, review Products and pricing, and progress partnership opportunities through DVM.
- [Regional Entities](https://docs.bango.com/partner-management/regional-entities.md): Understand how a Partner is represented technically in a region and environment.
- [Sandbox](https://docs.bango.com/partner-management/sandbox.md): Test DVM capabilities and subscription flows in the Sandbox environment.
- [Manage users and roles](https://docs.bango.com/partner-management/managing-users-and-roles.md): Manage Partner access, environments, user roles, and permissions in DVM.
- [Set up authentication](https://docs.bango.com/partner-management/setup-authentication.md): Configure user and API authentication for DVM.
- [Migration overview](https://docs.bango.com/migrations/migrations-overview.md): Overview of migrating existing subscriptions and entitlements to DVM.
- [Migrating to DVM](https://docs.bango.com/migrations/migration.md): Instructions for migrating existing subscriptions and entitlements to DVM.
- [Overview](https://docs.bango.com/offer-management/overview.md): Overview of offer management and the product catalog in DVM.
- [View products](https://docs.bango.com/offer-management/view-products.md): Discover products in your catalog in DVM.
- [Create an offer](https://docs.bango.com/offer-management/create-offer.md): Learn the building blocks of an Offer within the DVM
- [Configure free trials](https://docs.bango.com/offer-management/free-trials.md): Configure and manage free trials for your offers.
- [Localize an offer](https://docs.bango.com/offer-management/localization.md): Localize offers and pricing for different markets.
- [Offer model](https://docs.bango.com/offer-management/model.md): Understand how the DVM Offer Model combines a plan and products to define lifecycle, billing, and access.
- [Multi-party bundles](https://docs.bango.com/offer-management/multi-party-bundles.md): Combine multiple content provider products in a single offer.
- [Set up offers with multiple phases](https://docs.bango.com/offer-management/multi-phase-offers.md): Structure Offers where a consumer's price automatically transitions after an introductory, trial, or discounted period.
- [Plan types](https://docs.bango.com/offer-management/offer-plan-types.md): Understand the ways a reseller can configure an offer plan in the Digital Vending Machine® (DVM™).
- [Configure offer plans](https://docs.bango.com/offer-management/plan-configuration.md): Configure plans and billing for your offers.
- [Products and product tiers](https://docs.bango.com/offer-management/products-and-tiers.md): Understand how Products and Product Tiers fit into the DVM™ Offer Model, and how to configure upgrade and downgrade options for consumers.
- [Provision an offer for a consumer](https://docs.bango.com/entitlement-management/provision-an-offer.md)
- [Cancel an offer](https://docs.bango.com/entitlement-management/cancel-an-offer.md)
- [Check an offer status](https://docs.bango.com/entitlement-management/check-offer-status.md): Guide for Resellers who want to check the status of a Consumer Offer in the Digital Vending Machine® (DVM™).
- [Upgrade or downgrade an offer](https://docs.bango.com/entitlement-management/upgrade-an-entitlement.md): Upgrade your consumer's product or subscription in the DVM.
- [Retrieve product activation URL](https://docs.bango.com/entitlement-management/retrieve-product-activation-url.md)
- [Recover account for product](https://docs.bango.com/entitlement-management/recover-account-for-product.md)
- [Notifications](https://docs.bango.com/entitlement-management/notifications.md): Consumer Offer and Entitlement lifecycle notifications sent by the DVM™ to keep Resellers informed of key subscription events.
- [View a consumer's offer lifecycle](https://docs.bango.com/entitlement-management/consumer-offer-lifecycle.md)
- [Billing & charging overview](https://docs.bango.com/billing-and-charging/overview.md): Overview of billing and charging in the DVM.
- [Renewal charges](https://docs.bango.com/billing-and-charging/recurring-charges.md): How the DVM processes recurring subscription charges.
- [One-off charges](https://docs.bango.com/billing-and-charging/one-off-charges.md): One-off and non-recurring charges in the DVM.
- [Asynchronous charging model](https://docs.bango.com/billing-and-charging/asynchronous-charging.md)
- [Charge to payment gateway](https://docs.bango.com/billing-and-charging/charge-to-payment-gateway.md)
- [Refunds](https://docs.bango.com/billing-and-charging/refunds.md): Process refunds in the DVM.
- [Pro-ration](https://docs.bango.com/billing-and-charging/pro-ration.md)
- [Retrying failed charges or refunds](https://docs.bango.com/billing-and-charging/billing-retry-schedule.md): Understand how the DVM automatically retries failed charge attempts, and what happens if a payment remains unsuccessful.
- [Overview](https://docs.bango.com/notifications/overview.md): Overview of lifecycle notifications in the DVM.
- [Provisioning](https://docs.bango.com/notifications/provisioning.md): Notifications for provisioning events.
- [Activation](https://docs.bango.com/notifications/activation.md): Notifications for entitlement activation events.
- [Cancellation](https://docs.bango.com/notifications/cancellation.md): Notifications for entitlement cancellation events.
- [Billing lifecycle notifications](https://docs.bango.com/billing-and-charging/notifications.md): Billing lifecycle notifications sent by the DVM to help Resellers keep consumers informed about key subscription events.
- [Overview](https://docs.bango.com/reconciliation/overview.md): Understand the difference between correlation and reconciliation, and how to use each process.
- [Correlation reports](https://docs.bango.com/reconciliation/correlation-reports.md): Use correlation reports to compare entitlement data held by you and DVM.
- [Reseller correlation file format](https://docs.bango.com/reconciliation/reseller-correlation-input-file-format.md): Input and output CSV formats for reseller entitlement correlation.
- [Content provider correlation file format](https://docs.bango.com/reconciliation/content-provider-correlation-file-format.md): Input and output CSV formats for content provider entitlement correlation.
- [Charge correlation reports](https://docs.bango.com/reconciliation/charge-correlation-reports.md): Compare reseller charge and refund data with the corresponding records held by DVM.
- [Reconciliation](https://docs.bango.com/reconciliation/reconciliation.md): Investigate correlation differences and correct data so partner and DVM systems agree.
- [Dashboard](https://docs.bango.com/DVM-dashboard.md): Monitor entitlement performance, lifecycle events, and product activity for the selected Partner and environment.
- [Active change event reports](https://docs.bango.com/dashboard-and-reporting/active-change-event-reports.md): Column format for active entitlement, status change, and entitlement update event reports.
- [Billing forecast report](https://docs.bango.com/dashboard-and-reporting/billing-forecast-report.md): Report format for future invoices due in the next month.
- [Billing plan report](https://docs.bango.com/dashboard-and-reporting/billing-plan-report.md): Report format for billing plans managed during a reporting period.
- [Charge reports](https://docs.bango.com/dashboard-and-reporting/billing-charging-report.md)
- [Summary report format](https://docs.bango.com/dashboard-and-reporting/summary-report-format.md): Column format for the entitlement summary report.
- [Entitlement reports](https://docs.bango.com/dashboard-and-reporting/entitlement-reports.md): Understand the entitlement reports Bango provides for reconciliation and data analysis.
- [Partner Care](https://docs.bango.com/partner-care/care.md): Search entitlement records for the selected Partner and environment to investigate consumer queries.
- [DVM API overview](https://docs.bango.com/API/dvm-api-overview.md): High-level tour of the DVM APIs, core concepts, and lifecycles
- [API changelog](https://docs.bango.com/API/changelog.md): Release history for the DVM APIs.
- [API resources](https://docs.bango.com/API/api-objects.md): Key resources and their relationships in the DVM APIs
- [Manage API keys](https://docs.bango.com/API/manage-api-keys.md): Create and manage API keys for DVM technical integrations.
- [Product](https://docs.bango.com/api-reference/products/the-product-object.md): Schema and fields for the Product resource
- [Get products](https://docs.bango.com/api-reference/product-catalog/get-products.md): Get a list of products from your product catalog.
- [Get a product](https://docs.bango.com/api-reference/product-catalog/get-a-product.md): Get a product from your product catalog.
- [Offer](https://docs.bango.com/api-reference/offers/the-offer-object.md): Schema and fields for the Offer resource
- [Get offers](https://docs.bango.com/api-reference/offer-management/get-offers.md): Get a list of offers
- [Get an offer](https://docs.bango.com/api-reference/offer-management/get-an-offer.md): Get an offer from your catalog
- [Consumer Offer](https://docs.bango.com/api-reference/consumer-offers/the-consumer-offer-object.md): Schema and fields for the Consumer Offer resource
- [Get Consumer Offer By Id](https://docs.bango.com/api-reference/consumer-offers/get-consumer-offer-by-id.md): Get Consumer Offer by ID.
- [Create Consumer Offer](https://docs.bango.com/api-reference/consumer-offers/create-consumer-offer.md): Create a consumer offer.
- [Cancel Consumer Offer](https://docs.bango.com/api-reference/consumer-offers/cancel-consumer-offer.md): Cancel a consumer offer and all underlying entitlements.
- [Search Consumer Offer](https://docs.bango.com/api-reference/consumer-offers/search-consumer-offer.md): Search consumer offers.
- [Immedately Cancel A Consumer Offer](https://docs.bango.com/api-reference/consumer-offers/immedately-cancel-a-consumer-offer.md): Immediately cancel a consumer offer and all underlying entitlements.
- [Entitlement](https://docs.bango.com/api-reference/entitlements/the-entitlement-object.md): Schema and fields for the Entitlement resource
- [Check connection](https://docs.bango.com/api-reference/echo/check-connection.md): The echo endpoint allows you to check your connection to the Bango resale API. Use it to check the following: - You're using the correct base URL - You're using the correct credentials - The Bango resale API is currently available
- [Get an entitlement using externalEntitlementId](https://docs.bango.com/api-reference/entitlement/get-an-entitlement-using-externalentitlementid.md): Get information about an entitlement using external entitlement id.
- [Create an entitlement](https://docs.bango.com/api-reference/entitlement/create-an-entitlement.md)
- [Update an entitlement](https://docs.bango.com/api-reference/entitlement/update-an-entitlement.md): Update an entitlement
- [Get an entitlement](https://docs.bango.com/api-reference/entitlement/get-an-entitlement.md): Get information about an entitlement.
- [Request activation info](https://docs.bango.com/api-reference/entitlement/request-activation-info.md): This endpoint is used to request activation information for entitlements in a `PENDING` status.  This endpoint is used for new requests as well as refresh requests for expired activation information.
- [Account recovery](https://docs.bango.com/api-reference/entitlement/account-recovery.md): Use this to recover the customer's account for a given entitlement.
- [Search for entitlements](https://docs.bango.com/api-reference/entitlement/search-for-entitlements.md): Get a list of entitlements for a customerIdentifier, matching specific criteria
- [Suspend an entitlement](https://docs.bango.com/api-reference/entitlement/suspend-an-entitlement.md): This operation can only be performed on entitlements that are in ACTIVE status.
- [Resume an entitlement](https://docs.bango.com/api-reference/entitlement/resume-an-entitlement.md): This operation can only be performed on entitlements that are in SUSPENDED status. The entitlement will be returned to the status it was in prior to being suspended.
- [Cancel an entitlement](https://docs.bango.com/api-reference/entitlement/cancel-an-entitlement.md): Cancel an entitlement
- [Revoke an entitlement](https://docs.bango.com/api-reference/entitlement/revoke-an-entitlement.md): Revoke an entitlement
- [Get recent top ups](https://docs.bango.com/api-reference/top-ups/get-recent-top-ups.md): Both resellers and merchants can get top up information associated to the Bango `entitlementId`. The response only returns top ups created in the last 90 days.
- [Create top ups](https://docs.bango.com/api-reference/top-ups/create-top-ups.md): Only resellers are permitted to create top ups.
- [Service echo](https://docs.bango.com/api-reference/echo/service-echo.md)
- [Retrieve entitlement by merchant entitlement id](https://docs.bango.com/api-reference/entitlement/retrieve-entitlement-by-merchant-entitlement-id.md): Entitlement information for the requested unique Entitlement Identifier would be returned to be Merchant.
- [Update an entitlement](https://docs.bango.com/api-reference/entitlement/update-an-entitlement.md): Update an entitlement
- [Get a list of entitlements for a bangoUserId or sharedCustomerId, matching specific criteria](https://docs.bango.com/api-reference/entitlement/get-a-list-of-entitlements-for-a-bangouserid-or-sharedcustomerid-matching-specific-criteria.md): Get a list of entitlements for a bangoUserId or sharedCustomerId, matching specific criteria
- [Activate an entitlement](https://docs.bango.com/api-reference/entitlement/activate-an-entitlement.md): Activate an entitlement
- [Terminate an entitlement](https://docs.bango.com/api-reference/entitlement/terminate-an-entitlement.md): The body contains a flag called "IMMEDIATE" that marks if the request is for a HARD / SOFT termination.   - Immediate = true is an instruction for the merchant to terminate the entitlement effective immediately.   - Immediate = false is an instruction for the merchant to terminate the entitlement at…
- [Create Entitlement](https://docs.bango.com/api-reference/entitlement/create-entitlement.md): Request that is sent to the merchant to create a new Entitlement and return Activation URL and related parameters to be sent to the user. Expected responses as defined below.
- [Patch Entitlement](https://docs.bango.com/api-reference/entitlement/patch-entitlement.md): Request sent to the merchant to update entitlement information like Product detail. Expected responses as defined below.
- [Terminate Entitlement](https://docs.bango.com/api-reference/entitlement/terminate-entitlement.md): Request sent to merchant to end an entitlement. The body contains a flag called "IMMEDIATE" that marks if the request is for a HARD / SOFT termination.   - Immediate = true is an instruction for the merchant to terminate the entitlement effective immediately.   - Immediate = false is an instruction…
- [Check user eligibility](https://docs.bango.com/api-reference/eligibility/check-user-eligibility.md): Request that is sent to the merchant to check if the user is eligible to create an entitlement for the product provided in the request.
- [Notification](https://docs.bango.com/api-reference/notification/notification.md): Used to notify partners of changes to their subscriptions. You must provide Bango with a notificationUrl as part of your onboarding
- [Send an eligibility request to a partner](https://docs.bango.com/api-reference/send-an-eligibility-request-to-a-partner.md): The Bango Platform uses this endpoint to send an eligibility request to a partner.
- [Charge](https://docs.bango.com/api-reference/charge-and-refund/charge.md): Execute a charge .
- [Refund](https://docs.bango.com/api-reference/charge-and-refund/refund.md): Execute a refund.
- [Testing overview](https://docs.bango.com/testing/testing-overview.md): Test DVM use cases across API integrations and subscription flows in Sandbox before progressing toward production.
- [Bango Music](https://docs.bango.com/testing/bango-music.md): Use the Bango Music test Content Provider to validate Reseller subscription flows in DVM Sandbox.
- [Bango Payments](https://docs.bango.com/payments/index.md): Connect merchants and payment providers through Bango Payments.
- [For payment providers](https://docs.bango.com/payments/payment-providers/index.md): Payment-provider entry point for Bango Payments documentation.
- [Payment provider overview](https://docs.bango.com/payments/payment-providers/overview.md): Overview of the inbound and outbound APIs used for payment-provider integration.
- [Consumer identity](https://docs.bango.com/payments/payment-providers/consumer-identity.md): How payment-provider partners participate in consumer identity verification.
- [Payment processing](https://docs.bango.com/payments/payment-providers/payment-processing.md): How Bango Payments handles charge, authorization, capture, and refund flows.
- [Payments back office](https://docs.bango.com/payments/payment-providers/back-office.md): Back-office surfaces for support and reporting in Bango Payments.
- [DCB dashboard - Basic](https://docs.bango.com/payments/payment-providers/dcb-dashboard-basic.md)
- [DCB dashboard - Advanced](https://docs.bango.com/payments/payment-providers/dcb-dashboard-advanced.md)
- [DCB care tool](https://docs.bango.com/payments/payment-providers/dcb-care.md)
- [Send an action to the payment provider [adapter]](https://docs.bango.com/api-reference/send-an-action-to-the-payment-provider-[adapter].md): The Bango Platform uses this endpoint to send an action to a payment provider, or an adapter for a payment provider.
- [Send an action to the Bango Platform](https://docs.bango.com/api-reference/send-an-action-to-the-bango-platform.md)
- [Bango Payments for merchants](https://docs.bango.com/dcb-current/merchants/index.md)
- [Payment processing](https://docs.bango.com/dcb-current/merchants/payment-processing.md)
- [Retrieve information about an identity token](https://docs.bango.com/api-reference/env-production/retrieve-information-about-an-identity-token.md): Use this endpoint to retrieve information about an identity token.
- [Perform a business operation related to an identity token](https://docs.bango.com/api-reference/env-production/perform-a-business-operation-related-to-an-identity-token.md): Use this endpoint to ask the Bango Platform to perform a business operation related to an identity token. A business operation might be an update to the token, or a task associated with the token.
- [Create an identity verification session](https://docs.bango.com/api-reference/env-production/create-an-identity-verification-session.md): Use this endpoint to create an identity verification session. API consumers use this session to authenticate/verify the end user and obtain a Payment Instrument Token for them.
- [Retrieve an identity verification session](https://docs.bango.com/api-reference/env-production/retrieve-an-identity-verification-session.md): Use this endpoint to retrieve an identity verification session. The `flow` property of the session describes the selected identity verification flow, if any. The `state` property describes the current state of the session, and this may change over time. Partners can poll a session regularly to track…
- [Update an identity verification session](https://docs.bango.com/api-reference/env-production/update-an-identity-verification-session.md): Use this endpoint to update an identity verification session and/or to trigger tasks related to an identity verification session.
- [Integration steps](https://docs.bango.com/legacy/platform/getting-started/index.md): How to integrate the Bango Platform
- [What Bango needs from you](https://docs.bango.com/legacy/platform/getting-started/signup-data.md): Authorizing access to the Bango Platform
- [Bango Platform architecture](https://docs.bango.com/legacy/platform/architecture/index.md): A high-level view
- [Terminology](https://docs.bango.com/legacy/platform/architecture/terminology.md): Bango terms you should know
- [Connectivity overview](https://docs.bango.com/legacy/platform/connectivity/index.md): Securing and enabling access to the Bango Platform and Bango APIs
- [Bango API endpoint URLs](https://docs.bango.com/legacy/platform/connectivity/endpoints.md): Base URLs for Bango APIs
- [Basic authentication](https://docs.bango.com/legacy/platform/connectivity/basic-auth.md)
- [IP whitelisting](https://docs.bango.com/legacy/platform/connectivity/ip-whitelist.md): Limiting which of your hosts may access the Bango Platform
- [TLS/SSL with X.509 server certificate](https://docs.bango.com/legacy/platform/connectivity/ssl-cert.md): Connections are private, authenticated and tamper-proof
- [Signing HTTP messages](https://docs.bango.com/legacy/platform/connectivity/signing-http-messages.md): signing messages for authorized access
- [Troubleshooting](https://docs.bango.com/legacy/platform/architecture/index-1.md)
- [What's new on this site?](https://docs.bango.com/legacy/platform/architecture/updates.md): All recent new documentation and significant changes
- [Support contact details](https://docs.bango.com/legacy/platform/architecture/support.md): How to contact Bango with questions or comments
- [About Bango Resale](https://docs.bango.com/legacy/resale/index.md)
- [Bango Dashboard](https://docs.bango.com/legacy/resale/dashboard.md): View data showing the performance of your Bango Resale routes
- [Developer tools](https://docs.bango.com/legacy/resale/developer-tools.md): See the developer tools available for customer usage
- [About Bango Resale for resellers ](https://docs.bango.com/legacy/resale/reseller/index.md): Using the Bango Platform to resell items from third-party merchants to your own customers
- [Bundling and reselling with Bango Resale ](https://docs.bango.com/legacy/resale/reseller/getting-started.md): Follow these steps to sell products and services from third-party merchants to your own customers
- [Bango Reseller API architecture](https://docs.bango.com/legacy/resale/reseller/architecture.md): An abstraction layer between resellers and merchants
- [Entitlements overview ](https://docs.bango.com/legacy/resale/reseller/entitlements/index.md): About entitlements and the entitlement lifecycle
- [Creating an entitlement](https://docs.bango.com/legacy/resale/reseller/entitlements/create.md): Asking a merchant to activate a service for a user
- [Retrieving a single entitlement](https://docs.bango.com/legacy/resale/reseller/entitlements/read.md): Fetching the current details for an existing entitlement
- [Retrieving multiple entitlements](https://docs.bango.com/legacy/resale/reseller/entitlements/retrieve.md): Fetching entitlements that match filter criteria
- [Updating an entitlement](https://docs.bango.com/legacy/resale/reseller/entitlements/update.md): Making sparse updates to an existing entitlement
- [Suspending an entitlement](https://docs.bango.com/legacy/resale/reseller/entitlements/suspend.md): Temporarily withdrawing service access for a user
- [Resuming an entitlement](https://docs.bango.com/legacy/resale/reseller/entitlements/resume.md): Restoring service access for a user after a period of suspension
- [Canceling an entitlement](https://docs.bango.com/legacy/resale/reseller/entitlements/cancel.md): Withdrawing service access at the end of the period for which the user has already paid
- [Revoking an entitlement](https://docs.bango.com/legacy/resale/reseller/entitlements/revoke.md): Withdrawing service access immediately
- [Testing overview](https://docs.bango.com/legacy/resale/reseller/testing.md): What you need to test to go live with the Bango Reseller API
- [Reseller API reference overview](https://docs.bango.com/legacy/resale/reseller/api-ref/index.md): Full details of the Bango Reseller API
- [Standard reasons for suspend, cancel, revoke, and terminate](https://docs.bango.com/legacy/resale/reseller/api-ref/reason-codes.md)
- [Sending requests to Bango ](https://docs.bango.com/legacy/resale/reseller/api-ref/requests.md): Updates sent by the reseller to the Bango Platform
- [Service echo. Used to check Bango Resale API availability.](https://docs.bango.com/api-reference/echo/service-echo-used-to-check-bango-resale-api-availability.md)
- [Get entitlement from ExternalEntitlementId](https://docs.bango.com/api-reference/get-entitlement/get-entitlement-from-externalentitlementid.md): Get information about an entitlement using external entitlement id.
- [Get entitlement from BangoEntitlementId](https://docs.bango.com/api-reference/get-entitlement/get-entitlement-from-bangoentitlementid.md): Get information about an entitlement.
- [Create a new entitlement](https://docs.bango.com/api-reference/create-entitlement/create-a-new-entitlement.md)
- [Update an existing entitlement](https://docs.bango.com/api-reference/update-entitlement/update-an-existing-entitlement.md): Update an entitlement. This operation cannot be performed on entitlements that are in SUSPENDED status.
- [Get a list of entitlements for a customerIdentifier, matching specific criteria](https://docs.bango.com/api-reference/entitlement-report/get-a-list-of-entitlements-for-a-customeridentifier-matching-specific-criteria.md): Get a list of entitlements for a customerIdentifier, matching specific criteria
- [Suspend an entitlement](https://docs.bango.com/api-reference/suspend-entitlement/suspend-an-entitlement.md): Suspend an entitlement. This operation can only be performed on entitlements that are in ACTIVE status.
- [Resume an entitlement](https://docs.bango.com/api-reference/resume-entitlement/resume-an-entitlement.md): Resume an entitlement. This operation can only be performed on entitlements that are in SUSPENDED status
- [Cancel an entitlement](https://docs.bango.com/api-reference/cancel-entitlement/cancel-an-entitlement.md): Cancel an entitlement
- [Revoke an entitlement](https://docs.bango.com/api-reference/revoke-entitlement/revoke-an-entitlement.md): Revoke an entitlement
- [Send a notification](https://docs.bango.com/api-reference/send-a-notification/send-a-notification.md): Send a notification
- [Notifications from Bango](https://docs.bango.com/legacy/resale/reseller/api-ref/notifications.md): Updates sent by the Bango Platform
- [Notification](https://docs.bango.com/api-reference/notification/notification.md): Used to notify partners of changes to their subscriptions. You must provide Bango with a notificationUrl as part of your onboarding
- [Reporting overview](https://docs.bango.com/legacy/resale/reseller/reporting/index.md): How to receive regular reports of different types
- [Reseller entitlement reports v2](https://docs.bango.com/legacy/resale/reseller/reporting/entitlement-reports-v2.md): Receiving reports about your entitlements
- [Reseller Record Correlation Reports](https://docs.bango.com/legacy/resale/reseller/reporting/record-correlation-reports.md): Reports to verify you hold the same entitlement data as Bango
- [Batch processing](https://docs.bango.com/legacy/resale/reseller/batch-processing.md): Processing of multiple requests as part of a batch
- [Bango Care](https://docs.bango.com/legacy/resale/reseller/bangocare.md): Search functionality to find entitlement records held by Bango Resale for your customers
- [Frequently asked questions (FAQ)](https://docs.bango.com/legacy/resale/reseller/faq/index.md): Contact Support if you have a question not answered here
- [About Bango Resale for merchants](https://docs.bango.com/legacy/resale/merchant/index.md)
- [Bundling OTT services with Bango Resale](https://docs.bango.com/legacy/resale/merchant/getting-started.md): Follow these steps to sell products and services via third-party resellers to their customers
- [Bango Merchant Interface API architecture](https://docs.bango.com/legacy/resale/merchant/architecture.md): An abstraction layer between resellers and merchants
- [Testing overview](https://docs.bango.com/legacy/resale/merchant/testing.md): What you need to test to go live with the Bango Merchant Interface API
- [Merchant Interface Overview](https://docs.bango.com/legacy/resale/merchant-interface/index.md): Full details of the Bango Merchant Interface
- [Create Entitlement](https://docs.bango.com/api-reference/entitlement/create-entitlement.md): Request that is sent to the merchant to create a new Entitlement and return Activation URL and related parameters to be sent to the user. Expected responses as defined below.
- [Patch Entitlement](https://docs.bango.com/api-reference/entitlement/patch-entitlement.md): Request sent to the merchant to update entitlement information like Product detail. Expected responses as defined below.
- [Terminate Entitlement](https://docs.bango.com/api-reference/entitlement/terminate-entitlement.md): Request sent to merchant to end an entitlement. The body contains a flag called "IMMEDIATE" that marks if the request is for a HARD / SOFT termination.   - Immediate = true is an instruction for the merchant to terminate the entitlement effective immediately.   - Immediate = false is an instruction…
- [Check user eligibility](https://docs.bango.com/api-reference/eligibility/check-user-eligibility.md): Request that is sent to the merchant to check if the user is eligible to create an entitlement for the product provided in the request.
- [Service echo](https://docs.bango.com/api-reference/echo/service-echo.md)
- [Retrieve entitlement by merchant entitlement id](https://docs.bango.com/api-reference/entitlement/retrieve-entitlement-by-merchant-entitlement-id.md): Entitlement information for the requested unique Entitlement Identifier would be returned to be Merchant.
- [Update an entitlement](https://docs.bango.com/api-reference/entitlement/update-an-entitlement.md): Update an entitlement
- [Get a list of entitlements for a bangoUserId or sharedCustomerId, matching specific criteria](https://docs.bango.com/api-reference/entitlement/get-a-list-of-entitlements-for-a-bangouserid-or-sharedcustomerid-matching-specific-criteria.md): Get a list of entitlements for a bangoUserId or sharedCustomerId, matching specific criteria
- [Activate an entitlement](https://docs.bango.com/api-reference/entitlement/activate-an-entitlement.md): Activate an entitlement
- [Terminate an entitlement](https://docs.bango.com/api-reference/entitlement/terminate-an-entitlement.md): The body contains a flag called "IMMEDIATE" that marks if the request is for a HARD / SOFT termination.   - Immediate = true is an instruction for the merchant to terminate the entitlement effective immediately.   - Immediate = false is an instruction for the merchant to terminate the entitlement at…
- [Reporting Overview](https://docs.bango.com/legacy/resale/merchant/reporting/index.md): How to receive regular reports of different types
- [Merchant Entitlement Reports](https://docs.bango.com/legacy/resale/merchant/reporting/merchant-entitlement-reports.md): Receiving reports about your entitlements
- [Merchant Record Correlation Reports](https://docs.bango.com/legacy/resale/merchant/reporting/merchant-record-correlation-reports.md): Reports to verify you hold the same entitlement data as Bango
- [Bango Care](https://docs.bango.com/legacy/resale/merchant/bangocare.md): Search functionality to find entitlement records held by Bango Resale for your customers
- [End of life](https://docs.bango.com/legacy/resale/eol/index.md): The Bango Resale product is constantly updated to meet the needs of the market. As new features and versions are released, previous versions are supported and maintained for a certain amount of time, then retired.
- [Reactivating an entitlement](https://docs.bango.com/legacy/resale/eol/reactivating-entitlement.md): (EOL 1st June 2019) - Reinstating a user's access to a service where possible
- [Entitlement reactivation API](https://docs.bango.com/legacy/resale/eol/entitlement-reactivation-api.md): (EOL 1st June 2019) - Details of the API for reactivating service access where possible
- [Entitlement reports](https://docs.bango.com/legacy/resale/eol/entitlement-reports.md): (EOL 31st December 2019) - Receiving reports about your entitlements
- [Reconciliation reports](https://docs.bango.com/legacy/resale/eol/reconciliation-reports.md): (EOL 30th September 2020) - Optional reports to verify you hold the same entitlement data as Bango
- [Bango Subscriptions API](https://docs.bango.com/legacy/subscriptions/index.md): Managing free trials, special offers, and regular payments
- [API reference](https://docs.bango.com/legacy/subscriptions/api-ref/index.md): All the details of every endpoint for subscriptions API
- [Sending requests to Bango](https://docs.bango.com/legacy/subscriptions/api-ref/requests.md): Updates sent by the partner to the Bango Platform
- [Service availability check](https://docs.bango.com/api-reference/echo/service-availability-check.md): Optional. Use this endpoint to check authentication, authorization, and service availability.
- [Create a subscription](https://docs.bango.com/api-reference/subscriptions/create-a-subscription.md): Use this endpoint to create a subscription for a user in the Bango Platform.
- [Retrieve a subscription by id](https://docs.bango.com/api-reference/subscriptions/retrieve-a-subscription-by-id.md): Use this endpoint to retrieve all details of a subscription, if you have the unique identifier allocated by Bango for the subscription.
- [Change a subscription's plan](https://docs.bango.com/api-reference/subscriptions/change-a-subscriptions-plan.md): Use this endpoint to change a subscription's plan immediately or at a later date, given the unique identifier allocated by Bango for the subscription. This endpoint returns the updated subscription record.
- [Cancel a subscription now or at a future date](https://docs.bango.com/api-reference/subscriptions/cancel-a-subscription-now-or-at-a-future-date.md): Use this endpoint to cancel a subscription now or at a future date, given the unique identifier allocated by Bango for the subscription. This endpoint returns the updated subscription record.
- [Retrieve a subscription by external key](https://docs.bango.com/api-reference/subscriptions/retrieve-a-subscription-by-external-key.md): Use this endpoint to retrieve all details of a subscription, if you have the unique custom identifier supplied when creating the subscription.
- [Retrieve all subscriptions for a Bango User ID](https://docs.bango.com/api-reference/subscriptions/retrieve-all-subscriptions-for-a-bango-user-id.md): Use this endpoint to retrieve all details of all subscriptions for a single user, identified by a Bango User Id.
- [Uncancel a pending cancellation request for a subscription](https://docs.bango.com/api-reference/subscriptions/uncancel-a-pending-cancellation-request-for-a-subscription.md): Use this endpoint to undo a pending cancellation for a subscription. You can only undo subscriptions in state `ACTIVE` with a `cancelledDate` that is not `null`.
- [Create a plan](https://docs.bango.com/api-reference/plans/create-a-plan.md): Use this endpoint to create a subscription plan in the Bango Platform.
- [Retrieve a plan by name](https://docs.bango.com/api-reference/plans/retrieve-a-plan-by-name.md): Use this endpoint to retrieve a subscription plan using the planName.
- [Retrieve a plan by id](https://docs.bango.com/api-reference/plans/retrieve-a-plan-by-id.md): Use this endpoint to retrieve a plan using the id.
- [Retrieve all plans](https://docs.bango.com/api-reference/plans/retrieve-all-plans.md): Use this endpoint to retrieve all subscription plans you have in the Bango Platform.
- [Notifications from Bango](https://docs.bango.com/legacy/subscriptions/api-ref/notifications.md): Updates sent by the Bango Platform
- [Notification](https://docs.bango.com/api-reference/notification/notification.md): Used to notify partners of changes to their subscriptions. You must provide Bango with a notificationUrl as part of your onboarding
- [Key concepts](https://docs.bango.com/legacy/subscriptions/concepts/index.md): Important terminology and ideas
- [Products and plans](https://docs.bango.com/legacy/subscriptions/concepts/products-plans.md): Users subscribe to one of the plans of a product
- [Subscription lifecycle and timeline](https://docs.bango.com/legacy/subscriptions/concepts/lifecycle.md): States, events, and phase transitions
- [Billing periods](https://docs.bango.com/legacy/subscriptions/concepts/billing-periods.md): How often users are charged
- [Renewal](https://docs.bango.com/legacy/subscriptions/concepts/renewal.md): What does "renewal" mean?
- [Conversion](https://docs.bango.com/legacy/subscriptions/concepts/conversion.md): What does "conversion" mean?
- [Idempotency](https://docs.bango.com/legacy/subscriptions/concepts/idempotency.md): Avoiding accidental duplications
- [FAQ](https://docs.bango.com/legacy/subscriptions/faq/index.md): Contact Support if you have a question not answered here
- [Changes, deprecations, and end-of-life dates](https://docs.bango.com/legacy/subscriptions/changelog.md): All updates to the Bango Subscriptions API
- [Testing](https://docs.bango.com/legacy/subscriptions/testing.md): Ensuring you're ready to go live
- [About Bango Payments](https://docs.bango.com/legacy/dcb-payments-v5/index.md): Using the Bango Platform to identify users and take payments from them
- [Selling with Bango Payments](https://docs.bango.com/legacy/dcb-payments-v5/getting-started/selling-with-bango-payments.md): Follow these steps to sell goods and services to users
- [Bango Payments architecture](https://docs.bango.com/legacy/dcb-payments-v5/architecture/architecture.md): An abstraction layer between merchants and payment providers
- [High-level sequence diagram](https://docs.bango.com/legacy/dcb-payments-v5/architecture/high-level-sequence-diagram.md): An overview of data flow for user identification, payment, and refund
- [Bango Platform features](https://docs.bango.com/legacy/dcb-payments-v5/architecture/features.md): Things Bango handles for you
- [Identification overview](https://docs.bango.com/legacy/dcb-payments-v5/identifying-users/index.md): Every user has a unique Bango ID
- [Skeleton code](https://docs.bango.com/legacy/dcb-payments-v5/identifying-users/skeleton-code.md): Speaking the identity protocol
- [Common request/response flows](https://docs.bango.com/legacy/dcb-payments-v5/identifying-users/common-request-response-flows.md): Some typical conversations between your store and the Bango Platform
- [Identity selection and methods](https://docs.bango.com/legacy/dcb-payments-v5/identifying-users/identity-selection-and-methods.md): How the Bango Platform identifies a user
- [Transactions overview](https://docs.bango.com/legacy/dcb-payments-v5/transactions/index.md): Two stages: authorize, then capture
- [Checking available payment methods](https://docs.bango.com/legacy/dcb-payments-v5/transactions/checking-available-payment-methods.md): Improving the user experience before purchase
- [Authorizing a payment](https://docs.bango.com/legacy/dcb-payments-v5/transactions/authorizing-a-payment.md): Starting a transaction to reserve funds for a user purchase
- [Capturing a payment](https://docs.bango.com/legacy/dcb-payments-v5/transactions/capturing-a-payment.md): Completing a transaction to transfer funds from a user
- [Canceling or refunding a payment](https://docs.bango.com/legacy/dcb-payments-v5/transactions/canceling-or-refunding-a-payment.md): Deleting a transaction to release authorized funds or refund captured funds
- [Retrieving transaction details](https://docs.bango.com/legacy/dcb-payments-v5/transactions/retrieving-transaction-details.md): Discovering the status of an authorized or completed transaction
- [Subscriptions and recurring transactions](https://docs.bango.com/legacy/dcb-payments-v5/transactions/subscriptions-and-recurring-transactions.md): Taking regular payments from users
- [Testing overview](https://docs.bango.com/legacy/dcb-payments-v5/testing/index.md): Bango recommends three stages of testing
- [Using the Testing Guide](https://docs.bango.com/legacy/dcb-payments-v5/testing/using-the-testing-guide.md): Certifying your store for production
- [The Prefer HTTP header](https://docs.bango.com/legacy/dcb-payments-v5/testing/the-prefer-http-header.md): Forcing desired responses from the Bango Payment Merchant API
- [Bango TestPay](https://docs.bango.com/legacy/dcb-payments-v5/testing/bango-testpay.md): Simulating purchases and failures using the Bango test payment provider
- [Production testing](https://docs.bango.com/legacy/dcb-payments-v5/testing/production-testing.md): Going live, and testing with real payment providers
- [API reference overview](https://docs.bango.com/legacy/dcb-payments-v5/api-reference/index.md): Full details of the Bango Payment Merchant API
- [Callbacks and notifications](https://docs.bango.com/legacy/dcb-payments-v5/api-reference/callbacks-and-notifications.md): Asynchronous actions and communication by the Bango Platform
- [Transaction Payment Items structure](https://docs.bango.com/legacy/dcb-payments-v5/api-reference/transaction-payment-items.md): Representing your store's goods for sale in the Bango Payment Merchant API
- [Retrieve data about a user.](https://docs.bango.com/api-reference/identity/retrieve-data-about-a-user.md): Resource used to retrieve data about a user.
- [Delete a user.](https://docs.bango.com/api-reference/identity/delete-a-user.md): Resource used to delete data about a user.
- [Get a user's Bango ID (initial request)](https://docs.bango.com/api-reference/identity/get-a-users-bango-id-initial-request.md): Resource used to Get a user's Bango ID (initial request).
- [Get a user's Bango ID (subsequent request)](https://docs.bango.com/api-reference/identity/get-a-users-bango-id-subsequent-request.md): Resource used to Get a user's Bango ID (subsequent request).
- [Authorize transaction](https://docs.bango.com/api-reference/transaction/authorize-transaction.md): Resource used to authorize a transaction.
- [Check available payment methods](https://docs.bango.com/api-reference/transaction/check-available-payment-methods.md): Resource used to check available payment methods.
- [Retrieve data about a transaction.](https://docs.bango.com/api-reference/transaction/retrieve-data-about-a-transaction.md): Resource used to retrieve data about a transaction.
- [Capture transaction](https://docs.bango.com/api-reference/transaction/capture-transaction.md): Resource used to capture a transaction.
- [Cancel or refund a transaction.](https://docs.bango.com/api-reference/transaction/cancel-or-refund-a-transaction.md): Resource used to cancel or refund a transaction.
- [Payment Provider API reference overview](https://docs.bango.com/legacy/dcb-payments-v5/payment-provider-api-reference/index.md): Full details of the Bango Payment Provider API
- [Retrieve data about a user.](https://docs.bango.com/api-reference/identity/retrieve-data-about-a-user.md): Resource used to retrieve data about a user.
- [Authorize transaction](https://docs.bango.com/api-reference/transaction/authorize-transaction.md): Resource used to authorize a transaction.
- [Retrieve data about a transaction.](https://docs.bango.com/api-reference/transaction/retrieve-data-about-a-transaction.md): Resource used to retrieve data about a transaction.
- [Capture transaction](https://docs.bango.com/api-reference/transaction/capture-transaction.md): Resource used to capture a transaction.
- [Cancel or refund a transaction.](https://docs.bango.com/api-reference/transaction/cancel-or-refund-a-transaction.md): Resource used to cancel or refund a transaction.
- [Transaction reports](https://docs.bango.com/legacy/dcb-payments-v5/reporting/transaction-reports.md): Receiving data about all your attempted payments
- [Bango Care](https://docs.bango.com/legacy/dcb-payments-v5/bango-care/index.md): Search functionality to find transaction records held by Bango for your customers
- [Bango Dashboard](https://docs.bango.com/legacy/dcb-payments-v5/bango-dashboard/index.md): View data showing the performance of your Bango Payment routes
- [Developer Tools](https://docs.bango.com/legacy/dcb-payments-v5/developer-tools/index.md): See the developer tools available for customer usage
- [Change log](https://docs.bango.com/legacy/dcb-payments-v5/changelog.md): All updates to the Bango Payment API

## OpenAPI Specs

- [comsumeroffers](/api-reference/comsumeroffers.yaml)
- [entitlements](/api-reference/entitlements.yaml)
- [offers](/api-reference/offers.yaml)
- [BangoResellerAPI-latest-public](/BangoResellerAPI-latest-public.yaml)
- [BangoResellerNotification-latest-public](/BangoResellerNotification-latest-public.yaml)
- [MerchantInterface-BangoInitiatedRequests-latest-public](/MerchantInterface-BangoInitiatedRequests-latest-public.yaml)
- [MerchantInterface-MerchantInitiatedRequests-latest-public](/MerchantInterface-MerchantInitiatedRequests-latest-public.yaml)
- [openapi](/openapi/current/dcb-payments/bango-to-payment-provider/openapi.yaml)
- [openapi](/openapi/current/dcb-payments/merchant-to-bango/identity-token/openapi.yaml)
- [openapi](/openapi/current/dcb-payments/merchant-to-bango/identity-verification/openapi.yaml)
- [openapi](/openapi/current/dcb-payments/merchant-to-bango/payments/openapi.yaml)
- [openapi](/openapi/current/dcb-payments/payment-provider-to-bango/openapi.yaml)
- [openapi](/openapi/current/dvm/content-provider-to-dvm/entitlement/openapi.yaml)
- [openapi](/openapi/current/dvm/dvm-to-content-provider/entitlement/openapi.yaml)
- [openapi-post-charges](/openapi/current/dvm/dvm-to-reseller/charge/openapi-post-charges.json)
- [openapi-post-refunds](/openapi/current/dvm/dvm-to-reseller/charge/openapi-post-refunds.json)
- [openapi](/openapi/current/dvm/dvm-to-reseller/charge/openapi.json)
- [openapi](/openapi/current/dvm/dvm-to-reseller/eligibility/openapi.yaml)
- [openapi](/openapi/current/dvm/dvm-to-reseller/notification/openapi.yaml)
- [openapi-get-consumeroffers-consumerofferid](/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi-get-consumeroffers-consumerofferid.json)
- [openapi-post-consumeroffers-consumerofferid-cancellation](/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi-post-consumeroffers-consumerofferid-cancellation.json)
- [openapi-post-consumeroffers-consumerofferid-terminate](/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi-post-consumeroffers-consumerofferid-terminate.json)
- [openapi-post-consumeroffers-search](/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi-post-consumeroffers-search.json)
- [openapi-post-consumeroffers](/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi-post-consumeroffers.json)
- [openapi](/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json)
- [openapi](/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml)
- [openapi-post-charges-notifications](/openapi/current/dvm/reseller-to-dvm/notification/openapi-post-charges-notifications.json)
- [openapi-post-refunds-notifications](/openapi/current/dvm/reseller-to-dvm/notification/openapi-post-refunds-notifications.json)
- [openapi](/openapi/current/dvm/reseller-to-dvm/notification/openapi.json)
- [openapi](/openapi/current/dvm/reseller-to-dvm/offer/openapi.yaml)
- [openapi](/openapi/current/dvm/reseller-to-dvm/product/openapi.yaml)
- [openapi](/openapi/legacy/payments/merchant-to-bango/openapi.yaml)
- [openapi](/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml)
- [openapi](/openapi/legacy/resale/bango-to-content-provider/openapi.yaml)
- [openapi](/openapi/legacy/resale/bango-to-reseller/openapi.yaml)
- [openapi](/openapi/legacy/resale/content-provider-to-bango/openapi.yaml)
- [openapi](/openapi/legacy/resale/reseller-to-bango/openapi.yaml)
- [openapi](/openapi/legacy/subscriptions/bango-to-partner/openapi.yaml)
- [openapi](/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml)
- [openapi-post-token](/openapi/openapi-post-token.json)
- [openapi](/openapi/openapi.json)
- [openapi-post-charges](/openapi/proposed/dvm/dvm-to-payment-facilitator/charge/openapi-post-charges.json)
- [openapi-post-refunds](/openapi/proposed/dvm/dvm-to-payment-facilitator/charge/openapi-post-refunds.json)
- [openapi](/openapi/proposed/dvm/dvm-to-payment-facilitator/charge/openapi.json)
- [openapi-post-checkouts](/openapi/proposed/dvm/dvm-to-payment-facilitator/checkout/openapi-post-checkouts.json)
- [openapi](/openapi/proposed/dvm/dvm-to-payment-facilitator/checkout/openapi.json)
- [openapi-post-notifications](/openapi/proposed/dvm/dvm-to-payment-facilitator/notification/openapi-post-notifications.json)
- [openapi](/openapi/proposed/dvm/dvm-to-payment-facilitator/notification/openapi.json)
- [openapi-post-charges-notifications](/openapi/proposed/dvm/payment-facilitator-to-dvm/notification/openapi-post-charges-notifications.json)
- [openapi-post-checkouts-checkoutid-notifications](/openapi/proposed/dvm/payment-facilitator-to-dvm/notification/openapi-post-checkouts-checkoutid-notifications.json)
- [openapi-post-refunds-notifications](/openapi/proposed/dvm/payment-facilitator-to-dvm/notification/openapi-post-refunds-notifications.json)
- [openapi](/openapi/proposed/dvm/payment-facilitator-to-dvm/notification/openapi.json)
- [openapi-get-consumeroffers-consumerofferid-plan](/openapi/proposed/dvm/reseller-to-dvm/consumer-offer/openapi-get-consumeroffers-consumerofferid-plan.json)
- [openapi-post-consumeroffers-consumerofferid-retryfailedcreates](/openapi/proposed/dvm/reseller-to-dvm/consumer-offer/openapi-post-consumeroffers-consumerofferid-retryfailedcreates.json)
- [openapi](/openapi/proposed/dvm/reseller-to-dvm/consumer-offer/openapi.json)