Terminal Estate Report

Overview

The Monthly Terminal Estate Report provides a comprehensive overview of all terminals associated with a merchant over a given period.

The report captures the current state, configuration, and deployment status of each terminal, along with associated merchant and location information. It is designed to support operational management, estate tracking, and lifecycle monitoring of payment devices.


Key Features

  • Full visibility of the terminal estate across merchants and locations
  • Includes terminal status, deployment, and configuration details
  • Tracks device type, serial number, and identifiers
  • Provides location and merchant context
  • Supports operational monitoring and inventory management
  • Structured format (e.g. CSV) for integration and analysis

Report Characteristics

AttributeDescription
GranularityTerminal-level (one row per terminal)
FrequencyMonthly
FormatCSV
ScopeAll terminals registered within the reporting period

Availability

  • Generated on a monthly basis
  • Covers all terminals registered during the reporting period
  • Reflects the latest known state of each terminal

Delivery Options

The report can be accessed via:

  • Manual retrieval (via Aera Portal)
  • Automated delivery (via webhook + Reporting API)

For details, see Get Reports.


Report Structure

Each row in the report represents a single terminal.

The field groupings shown below are for documentation purposes only; the actual report is delivered as a flat file without these groupings.

Merchant & Organization Information

FieldDescription
OrganizationNumberOfficial company registration number (from national registry)
MerchantIdUnique identifier for the merchant in the system
MerchantNameName of the merchant (legal or display name)
GLNGlobal Location Number, a standardized identifier for a location or organization

Payment Configuration

FieldDescription
InstoreConfigIDInternal identifier for the payment configuration the terminal is connected to
InstoreConfigNameDescriptive/common name of the payment configuration associated with the InStoreConfigId

Terminal Identification

FieldDescription
TerminalIDUnique identifier for the payment virtual terminal in the system
POSNameTerminal’s common name or readable label (e.g. defined by customer or technician)
SerialNumberManufacturer’s serial number of the terminal
VirtualTIDVirtual Terminal ID linking terminals with the voucher terminal table to ensure terminal authorization

Device & Deployment

FieldDescription
DeviceTypeTerminal model or device type
DeploymentTagLabel used during rollout to group or distinguish terminals

Terminal Status & Configuration

FieldDescription
TerminalStatusCurrent operational status of the terminal (e.g. active, deactivated)
TerminalConfigNameName or identifier of the configuration package assigned to the terminal
TerminalConfigVersionVersion of the configuration currently running on the terminal
TerminalConfigIDUnique identifier for the terminal configuration
PAVersionVersion of the payment application running on the terminal

Merchant Location Information

FieldDescription
MerchantStreetStreet address of the merchant location
MerchantPostalCodePostal or ZIP code of the merchant location
MerchantPostalAreaCity or town of the merchant location
MerchantCountryCodeCountry code in ISO format (e.g. NO for Norway)

Did this page help you?