Bango uses cookies to give you the best website experience. By using this website you agree to let Bango use cookies. More info

Bango Developer

Site map

Index of all pages

Bango Platform
Providing APIs and services for merchants, resellers, and payment providers

About the Bango PlatformThe collection of APIs and services provided by Bango
Getting started
Follow these steps to integrate the Bango Platform

Integration stepsHow to integrate the Bango Platform
What Bango needs from youAuthorizing access to the Bango Platform

Architectural overview
Introducing the Bango Platform

Bango Platform architectureA high-level view
TerminologyBango terms you should know

Connectivity and security
Complying with Bango Platform security requirements

Connectivity overviewSecuring and enabling access to the Bango Platform and Bango APIs
Bango API endpoint URLsBase URLs for Bango APIs
Basic authenticationCredentials for testing and for production
IP whitelistingLimiting which of your hosts may access the Bango Platform
TLS/SSL with X.509 server certificateConnections are private, authenticated and tamper-proof
Signing HTTP Messages

Bango Payment
Identifying users and taking payments

About Bango PaymentsUsing the Bango Platform to identify users and take payments from them
Getting started
Follow these steps to get started with the Bango Payment API

Selling with Bango PaymentsFollow these steps to sell goods and services to users

Architectural overview
Introducing the Bango Payments: what it is, and how it works

Bango Payments architectureAn abstraction layer between merchants and payment providers
High-level sequence diagramAn overview of data flow for user identification, payment, and refund
Bango Platform featuresThings Bango handles for you

Identifying users
How to identify users using the Bango Payment API, including skeleton code

Identification overviewEvery user has a unique Bango ID
Skeleton codeSpeaking the identity protocol
Common request/response flowsSome typical conversations between your store and the Bango Platform
Identity selection and methodsHow the Bango Platform identifies a user

Transactions
How to let users purchase items, and how to cancel and refund purchases

Transactions overviewTwo stages: authorize, then capture
Checking available payment methodsImproving the user experience before purchase
Authorizing a paymentStarting a transaction to reserve funds for a user purchase
Capturing a paymentCompleting a transaction to transfer funds from a user
Canceling or refunding a paymentDeleting a transaction to release authorized funds or refund captured funds
Retrieving transaction detailsDiscovering the status of an authorized or completed transaction
Subscriptions and recurring transactionsTaking regular payments from users

Testing
How to ensure your store is compatible with the Bango Payments testing requirements

Testing overviewBango recommends three stages of testing
Using the Testing GuideCertifying your store for production
The Prefer HTTP headerForcing desired responses from the Bango Payment Merchant API
Bango TestPaySimulating purchases and failures using the Bango test payment provider
Production testingGoing live, and testing with real payment providers

Merchant API reference
Complete reference information for all Bango Payment Merchant API methods, with sample requests and responses

API reference overviewFull details of the Bango Payment Merchant API
Transaction Payment Items structureRepresenting your store's goods for sale in the Bango Payment Merchant API
Callbacks and notificationsAsynchronous actions and communication by the Bango Platform

Payment Provider API reference
Complete reference information for all Bango Payment Provider API methods, with sample requests and responses

API reference overviewFull details of the Bango Payment Provider API

Reporting
Receiving regular Bango Payment API reports

Transaction reportsReceiving data about all your attempted payments

Bango Care
Search functionality to find transaction records held by Bango Payments for your customers

Bango CareSearch functionality to find entitlement records held by Bango Resale for your customers

Bango Dashboard
View data showing the performance of your Bango Payment routes

Bango DashboardView data showing the performance of your Bango Payment routes

Developer Tools
See the developer tools available for customer usage

Developer ToolsSee the developer tools available for customer usage

Change logAll updates to the Bango Payment API

Bango Resale
Bundling and reselling goods and services

About Bango Resale
For resellers
What Bango Resale offers to a Reseller

About Bango Resale for resellersUsing the Bango Platform to resell items from third-party merchants to your own customers
Getting started
Follow these steps to get started with Bango Resale

Bundling and reselling with Bango ResaleFollow these steps to sell products and services from third-party merchants to your own customers

Architectural overview
Introducing the Bango Reseller API: what it is, and how it works

Bango Reseller API architectureAn abstraction layer between resellers and merchants

Managing entitlements
Controlling user access to merchant services

Entitlements overviewAbout entitlements and the entitlement lifecycle
Creating an entitlementAsking a merchant to activate a service for a user
Retrieving a single entitlementFetching the current details for an existing entitlement
Retrieving multiple entitlementsFetching entitlements that match filter criteria
Updating an entitlementMaking sparse updates to an existing entitlement
Suspending an entitlementTemporarily withdrawing service access for a user
Resuming an entitlementRestoring service access for a user after a period of suspension
Canceling an entitlementWithdrawing service access at the end of the period for which the user has already paid
Revoking an entitlementWithdrawing service access immediately

Testing
How to ensure you comply with the Bango Reseller API testing requirements

Testing overviewWhat you need to test to go live with the Bango Reseller API

Reseller API reference
Complete reference information for all Bango Reseller API methods, with sample requests and responses

Reseller API reference overviewFull details of the Bango Reseller API
Sending requests to BangoUpdates sent by the reseller to the Bango Platform
Notifications from BangoUpdates sent by the Bango Platform
Standard reasons for suspend, cancel, revoke, and terminateUse these categories and codes when suspending, canceling, revoking, or terminate an entitlement

Reporting
Receiving regular Bango Resale reports

Reporting overviewHow to receive regular reports of different types
Reseller Entitlement Reports v2Receiving reports about your entitlements
Reseller Record Correlation ReportsReports to verify you hold the same entitlement data as Bango

Batch Processing
Processing of multiple requests as part of a batch

Batch processingProcessing of multiple requests as part of a batch

Bango Care
Search functionality to find entitlement records held by Bango Resale for your customers

Bango CareSearch functionality to find entitlement records held by Bango Resale for your customers

Bango Dashboard
View data showing the performance of your Bango Resale routes

Bango DashboardView data showing the performance of your Bango Resale routes

Developer Tools
See the developer tools available for customer usage

Developer ToolsSee the developer tools available for customer usage

FAQ
Contact Support if you have a question not answered here

For merchants
What Bango Resale offers to a Merchant

About Bango Resale for merchantsUsing the Bango Platform to offer OTT services to customer via a bundling partner
Getting started
Follow these steps to get started with Bango Resale

Bundling OTT services with Bango ResaleFollow these steps to sell products and services via third-party resellers to their customers

Architectural overview
Introducing the Bango Merchant Interface API: what it is, and how it works

Bango Merchant Interface API architectureAn abstraction layer between resellers and merchants

Testing
What you need to test to go live with the Bango Merchant Interface API

Testing overviewWhat you need to test to go live with the Bango Merchant Interface API

Merchant Interface Reference
Complete reference information for all Bango Merchant Interface methods, with sample requests and responses

Merchant Interface OverviewFull details of the Bango Merchant Interface
Client APIFull details of the Bango Merchant Client API
Server APIFull details of the Bango Merchant Server API

Reporting
Receiving regular Bango Resale reports

Reporting OverviewHow to receive regular reports of different types
Merchant Entitlement ReportsReceiving reports about your entitlements
Merchant Record Correlation ReportsReports to verify you hold the same entitlement data as Bango

Bango Care
Search functionality to find entitlement records held by Bango Resale for your customers

Bango CareSearch functionality to find entitlement records held by Bango Resale for your customers

Bango Dashboard
View data showing the performance of your Bango Resale routes

Bango DashboardView data showing the performance of your Bango Resale routes

Developer Tools
See the developer tools available for customer usage

Developer ToolsSee the developer tools available for customer usage

End of Life
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.

End of LifeThe 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(EOL 1st June 2019) - Reinstating a user's access to a service where possible
Entitlement reactivation API(EOL 1st June 2019) - Details of the API for reactivating service access where possible
Entitlement reports(EOL 31st December 2019) - Receiving reports about your entitlements
Reconciliation reports(EOL 30th September 2020) - Optional reports to verify you hold the same entitlement data as Bango

Bango Subscriptions API
Managing free trials, special offers, and regular payments

Key concepts
Important terminology and ideas

Products and plansUsers subscribe to one of the plans of a product
Subscription lifecycle and timelineStates, events, and phase transitions
Billing periodsHow often users are charged
RenewalWhat does "renewal" mean?
ConversionWhat does "conversion" mean?
IdempotencyAvoiding accidental duplications

API reference
All the details of every API endpoint

Sending requests to BangoUpdates sent by the partner to the Bango Platform
Notifications from BangoUpdates sent by the Bango Platform

TestingEnsuring you're ready to go live
FAQ
Contact Support if you have a question not answered here

Changes, deprecations, and end-of-life datesAll updates to the Bango Subscriptions API

Troubleshooting and support
Tips for common problems, and support contact details

TroubleshootingDealing with common Bango Platform integration and testing problems
Technical notes
Additional technical information

Technical notesAdditional technical information
Spend limits in carrier billing

Support contact detailsHow to contact Bango with questions or comments
What's new on this site?All recent new documentation and significant changes

Site mapIndex of all pages

← Previous: What's new on this site?