Bango uses cookies to give you the best website experience. By using this website you agree to let Bango use cookies. More info
OK
Bango Developer
  1. Bango Resale
  2. For merchants
  3. Reporting
  4. Merchant Entitlement Reports

Merchant Entitlement Reports

Receiving reports about your entitlements

Summary

Bango create monthly files for the merchant to use. Bango encourages merchants to use the reports for informational and reconciliation purposes.

All reports are automatically generated and will be made available to the merchant from launch. It is the responsibility of the merchant to retrieve reports as required.


File Specifications

Bango will create four reports. The below table summarises the report differences and frequency.

ReportFrequencyDescription
Active ReportDaily, Weekly and MonthlyAll active entitlements on the Bango system at the time the report is run.
Change ReportDaily, Weekly and MonthlyLatest status of all entitlements on the Bango system where the status has changed during the reporting period.
Event ReportDaily, Weekly and MonthlyAll entitlement events during the reporting period (one entitlement ID could have multiple entries).
Summary ReportDaily, Weekly and MonthlyOverview showing the count of entitlements by state since launch and during the reporting period. Counts are split out by the entitlements current product key.

File name and encoding

The report will be Windows-1252 encoded file containing RFC4180 comma separate values (CSV).

The file names determine the file type, version and contents; outlined in the table below.

Active ReportChange ReportEvent ReportSummary Report
MonthlyAR_V1_M_YYYYMM.csvCR_V1_M_YYYYMM.csvER_V1_M_YYYYMM.csvSR_V1_M_YYYYMM.csv
WeeklyAR_V1_W_YYYYMMDD.csvCR_V1_W_YYYYMMDD.csvER_V1_W_YYYYMMDD.csvSR_V1_W_YYYYMMDD.csv
DailyAR_V1_D_YYYYMMDD.csvCR_V1_D_YYYYMMDD.csvER_V1_D_YYYYMMDD.csvSR_V1_D_YYYYMMDD.csv

Active, Change and Event reports

File Format

All three reports generated by Bango include the same information fields.

All files include a header row. The header row and field formats are defined and controlled according to the file version, reported in the report file name. All times shown in reports are in UTC.

HeaderTypeDescription
MerchantEntitlementIdStringEntitlement identifier created on the merchant system.
BangoEntitlementIdStringEntitlement identifier created on the Bango system. Each entitlement has a unique identifier.
StatusStringEntitlement status, one of Active, Suspended, Cancelled, Revoked, Pending or Failed
MerchantAccountKeyMerchant the entitlement is against.
ProductKeyStringThe identifier for the merchant service you want to activate for the user. Bango owns these identifiers and makes them available to you as necessary.
DisplayNameStringA user-visible string representing the entitlement.
CreatedDatedd/MM/yyyy HH:mm:ss timestamp stringDate/Time (UTC) the entitlement was created on the Bango system (status Pending).
ActivatedDatedd/MM/yyyy HH:mm:ss timestamp string or nullDate/Time (UTC) the entitlement was activated on the Bango system (status Active). If the entitlement is still in a pending state, this field will be null.
SuspendedDatedd/MM/yyyy HH:mm:ss timestamp string or nullDate/Time (UTC) the entitlement was suspended on the Bango system (status Suspended). If the entitlement is still in an Active state, this field will be null.
ExpiryDatedd/MM/yyyy HH:mm:ss timestamp string or nullIf an Expiry Date is set on entitlement creation, it will be shown here. If no expiry date is set, the field will be null.
LastUpdateddd/MM/yyyy HH:mm:ss timestamp stringDate/Time (UTC) the entitlement last changed state or records updated on the Bango system.
EndDatedd/MM/yyyy HH:mm:ss timestamp stringDate/Time (UTC) the entitlement was Ended on the Bango system (status Cancelled / Revoked). If the entitlement is still in an Active state, this field will be null.

Summary report

File Format

All files include a header row. The header row and field formats are defined and controlled according to the file version, reported in the report file name.

HeaderTypeDescription
Product DescriptionStringHuman readable description of the product key.
Product KeyStringThe identifier for the merchant service.
Total Pending EntitlementsNumberTotal count of Pending entitlements since launch.
New Pending Entitlements in Current PeriodNumberThe count of created entitlements in the reporting period in a Pending state.
Total Active EntitlementsNumberTotal count of Active entitlements since launch.
New Activations in Current PeriodNumberThe count of entitlements that were activatied in the reporting period.
Total DeactivationsNumberTotal count of Cancelled or Revoked entitlements since launch.
New Deactivations in Current PeriodNumberThe count of entitlements that were Cancelled or Revoked in the reporting period.
Total RejectionsNumberTotal count of rejected entitlements since launch.
Total Rejections in Current PeriodNumberThe count of rejected entitlements in the reporting period.
Total Failed EntitlementsNumberTotal count of Failed entitlements since launch.
Failed in Current PeriodNumberThe count of entitlements that were Failed in the reporting period.

File Timing

The Bango reporting system will make report files available for download within 24 hours of the end of the reporting period for each report.


File Access

The reports will be generated by Bango and made available to merchants via Amazon S3. Within the Amazon S3 bucket the reports will be broken down by reseller and then by frequency of the report.

E.g. s3://merchant_identifier/EntitlementReports/[Reseller]/[Frequency]/

Bango will provide the reseller the following information to access their specific S3 storage area:

InformationDescription
Amazon S3 Endpoint (dedicated to the reseller)Endpoint used for the reseller to connect to their dedicated file storage (e.g. s3://merchant_identifier/
Access KeyA string which acts as the username to access the Amazon S3 storage
Secret KeyA string which acts as the username to access the Amazon S3 storage

This information will be provided by our Bango support team as part of the provisioning process.

Examples of accessing data stored in Amazon S3 are:

    1. Connecting to Amazon S3 API.
    2. Using a wide variety of 3rd party applications available publicly.
Copyright © 2000–2021 Bango.net Limited