Skip to main content

Get report types

The first step towards creating a report is to understand what report types are available. You can do this in two ways:

  • View available report types
  • Get details for a specific report type

Before you begin

During onboarding, the report types available are determined by the payment method groups, regions, and entity entitlements set on your profile. Contact your relationship manager if you need to make changes to your profile.

View available report types

Retrieve the available report types by performing a GET call to the /report-types endpoint. In the response you will see the following fields:

Fields in report types response
Field name Description
reportTypeId Unique identifier of the report type being requested.
reportTypeName The name of the report type.
reportDescription The textual description of the report type.
reportGranularityTypeCode The level at which report detail is presented. For example, fee level, transaction level and so on.
gatewayRegion Indicates the geographical region for which the report type is applicable. The region code is defined using ISO-3166 code. For e.g. USA, CAN, AU and so on.
paymentMethodGroup

The category of payment method used for reporting purpose such as local payment method, global payment method.

  • Global Payment Methods - Indicates that the report type contains data for global payment methods, such as Visa, Mastercard, Amex, Discover.
  • Local Payment Methods - Indicates that the report type contains data from local payment methods, such as Alipay, Sofort, iDeal, Trustly.
  • Global & Local Payment Methods - Indicates that the report type contains data from both global payment methods and local payment methods.

The following example shows how to retrieve the report types available for you:

HTTP method: GET
Endpoint: /report-types

Json
{
    "reportTypes": [
        {
            "gatewayRegion": "CAN, EU",
            "paymentMethodGroup": "Global Payment Methods",
            "reportTypeId": "3016",
            "reportTypeName": "Dispute Inventory",
            "reportDescription": "Provide inventory details on all dispute details for the given period",
            "reportGranularityTypeCode": "Dispute Level"
        },
        {
            "gatewayRegion": "USA",
            "paymentMethodGroup": "Global Payment Methods,Local Payment Methods",
            "reportTypeId": "3016",
            "reportTypeName": "Dispute Inventory",
            "reportDescription": "Provide inventory details on all dispute details for the given period",
            "reportGranularityTypeCode": "Dispute Level"
        },
        {
            "gatewayRegion": "USA",
            "paymentMethodGroup": "Global Payment Methods,Local Payment Methods",
            "reportTypeId": "3016",
            "reportTypeName": "Dispute Detail Parallel",
            "reportDescription": "Provide details on all dispute details for the given period.",
            "reportGranularityTypeCode": "Transaction Level"
        },
        {
            "gatewayRegion": "CAN, EU",
            "paymentMethodGroup": "Global Payment Methods",
            "reportTypeId": "3050",
            "reportTypeName": "Dispute Detail Parallel",
            "reportDescription": "Provide details on all dispute details for the given period.",
            "reportGranularityTypeCode": "Transaction Level"
        }
    ]
}
Tip

Each report has a specific reportTypeId and lists the regions and payment method group associated. When report types share common payment method group and region combination, attributes can be combined into a custom report.

For more information about the available report types, refer to Report Types.

Get details for a specific report type

Each report has a set of attributes associated with it. To see that set of attributes, use the reportTypeId in the path.

Fields in report types response
Field name Description
reportAttributeName The name of the attribute in the report.
businessDefinitionText The clear and concise description of the data elements used in the reports.
defaultIncludeIndicator Indicates the BOOLEAN value to signifiy if the attribute is included in the report. TRUE indicates that the attribute is included by default.
attributeCategories

Defines the category of the attribute. The available categories include:

  • IBAN - Attributes in this category provide additional information specific to IBAN transactions.
  • 3DS - Attributes in this category offer additional details specific to 3DS transactions.
  • Tax - Attributes in this category supply additional insights on tax-related matters.
  • Card Present - Attributes in this category furnish extra details for Card Present transactions.
  • N/A - Attributes that are generic or not tied to a specific category.

Categories assist in making informed decisions when creating custom reports for specific use cases, such as 3DS transaction reports or reports that need to include Card Present data. They provide additional context for including these attributes in the reporting process.

The following example shows how you can retrieve the attributes of a specific report type:

HTTP method: GET
Endpoint: /report-types/reportTypeId

Json
{
    "reportTypeFields": [
        {
            "reportAttributeName": "Transaction Identifier",
            "businessDefinitionText": "Identifies a unique occurrence of a transaction.",
            "defaultIncludeIndicator": true,
            "attributeCategories": "N/A"
        },
        {
            "reportAttributeName": "Sales Order",
            "businessDefinitionText": "Identifies a unique occurrence of the confirmation of goods and/or services purchased.",
            "defaultIncludeIndicator": true,
            "attributeCategories": "N/A"
        },
        {
            "reportAttributeName": "Transaction Amount",
            "businessDefinitionText": "Specifies the monetary value of the transaction performed.",
            "defaultIncludeIndicator": true,
            "attributeCategories": "N/A"
        },
        {
            "reportAttributeName": "Service Tax Amount",
            "businessDefinitionText": "Specifies the monetary value of the service tax on the transaction.",
            "defaultIncludeIndicator": true,
            "attributeCategories": "Tax"
        }
    ]
}
Tip

defaultIncludeIndicator is an important value which shows if the attribute will be included by default in any report configuration. If an attribute is not included by default, it must be explicitly included. By using understanding attributes included by default, it is much easier to get started building a report with the most meaningful and relevant attributes.