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 Record Correlation Reports

Merchant Record Correlation Reports

Reports to verify you hold the same entitlement data as Bango

If you store entitlement data on your own systems, you should supply it daily to Bango to allow Bango to perform a record correlation process and send you correlation reports.

The record correlation process checks that your data matches the Bango data, and highlights any discrepancies. Bango support two types of correlation which are detailed below:

CorrelationTypeDescription
Event Only (Default)All entitlements which have had an event in the correlation period being run. If there is more than one record for an entitlement in the same period you should provide us with the latest one.
Active + EventConsists of all ACTIVE entitlements and all entitlements which have had an event in the correlation period being run. If there is more than one record for an entitlement in the same period you should provide us with the latest one.

Bango performs similar record correlation processes with resellers who offer your products and services to customers through Bango Resale.

Unless otherwise agreed, the Bango data is considered the source of truth.

Supplying correlation data to Bango

To supply correlation data to Bango, you must upload it to your reporting Amazon S3 bucket provided by Bango within 4 hours of the period finishing (periods are in UTC).

All times should be in UTC. The files must be RFC 4180 CSV format, in a single file for each correlation period and uploaded to a dedicated input folder broken down by reseller. The naming convention for the reseller must match the resellerKey Bango use for the reseller.

E.g. s3://merchant_identifier/CorrelationReports/[Reseller]/Input/


File name and examples
File NameExample File Name
MonthlyYYYYMMDD-YYYYMMDD.csvExample correlation file name for January 2020 - 20200101-20200131.csv
WeeklyYYYYMMDD-YYYYMMDD.csvWeekly record correlation is defined as Monday to Sunday. Example correlation file name for Monday 6th January 2020 to Sunday 12th January 2020 - 20200106-20200112.csv
DailyYYYYMMDD-YYYYMMDD.csvExample correlation file name for 5th January 2020 - 20200105-20200106.csv

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

InformationDescription
Amazon S3 Endpoint (dedicated to the merchant)Endpoint used for the merchant 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 password 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.

Data comparison results

When comparing the data you supply to the data in the Bango Platform, Bango checks the following:

  • ExternalEntitlementId also known as the MerchantEntitlementId
  • ProductKey
  • Status
  • Record correlation report input format

    The data you provide to Bango must be in the following format:

    HeaderType
    ExternalEntitlementIdString
    BangoUserIdString
    EntitlementIdUUID String
    StatusString
    ResellerKeyString
    ProductKeyString
    OfferKeyString
    CreatedDateISO 8601 timestamp string
    ActivatedDateISO 8601 timestamp string or null
    SuspendedDateISO 8601 timestamp string or null
    ResumedDateISO 8601 timestamp string or null
    EndDateISO 8601 timestamp string or null

    Record correlation report output files

    Bango will provide four output files for each correlation execution in an output folder. The naming convention for the OTT service provider must match the merchantAccountKey value passed in the create entitlement.

    E.g. s3://merchant_identifier/CorrelationReports/[OTTServiceProvider1]/Output/

    File nameFile description
    Matching EntitlementsAll entitlements that matched
    Bango Only EntitlementsExtra Entitlements detected in Bango system
    [Merchant Name] Only EntitlementsMissing Entitlements detected in Bango system
    Mismatching EntitlementsEntitlements which both Bango and the Reseller have in their system but there are discrepancies with the data held

    Record correlation report output results

    Column nameDescription
    EntitlementId(UUID string) Unique identifier for an entitlement
    ExternalEntitlementIdUnique identifier for an entitlement held by the Reseller
    CorrelationResultThe result of the correlation for the individual entitlement. Expected values are OK: Entitlement data matches, Error: Extra Entitlement detected in Bango system, Error: Missing Entitlement detected in Bango system, Error: ProductKey is different, Error: Status is different, Error: CustomerIdentifier is different, or Error: Multiple differences.

    Bango recommends that merchants resolve any discrepancies identified by contacting Bango Support.

    Here's an example of a matched correlation report:

    EntitlementId,ExternalEntitlementId,CorrelationResult
    f5666778-dcee-4365-93a1-5f385f40eafc,,OK: Entitlement data matches
    15dc371d-8c62-4c14-8cfc-5561d352f2e1,,OK: Entitlement data matches
    5ec1ff0f-dc1d-4d0c-bc9e-b50b172193d6,,OK: Entitlement data matches
    bb39454e-1841-4077-8ceb-a3828c0a9047,,OK: Entitlement data matches

    Here's an example of a Bango only correlation report:

    EntitlementId,ExternalEntitlementId,CorrelationResult
    8a679908-2004-4ec8-a8c7-4c36e8dd5a5f,,Error: Extra Entitlement detected in Bango system
    af6268b7-2029-4a60-b435-b21747efc54f,,Error: Extra Entitlement detected in Bango system

    Here's an example of a Reseller only correlation report:

    EntitlementId,ExternalEntitlementId,CorrelationResult,CorrelationDescription
    bbb63636-3fe7-450e-bcda-073e2b6eee89,,Error: Missing Entitlement detected in Bango system
    dfc92708-362c-472c-9052-d21e1e5b68fa,,Error: Missing Entitlement detected in Bango system

    Here's an example of an unmatched correlation report:

    EntitlementId,ExternalEntitlementId,CorrelationResult
    6c92895b-b521-44f2-afb8-1a83db9aff50,,Error ProductKey is different
    ee803684-847b-4549-84cf-7c7879221571,,Error Status is different
    d1a70dcc-0b24-4531-991a-47df73b5caf3,,Error: Multiple differences
    Copyright © 2000–2021 Bango.net Limited