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
| Attribute | Description |
|---|---|
| Granularity | Terminal-level (one row per terminal) |
| Frequency | Monthly |
| Format | CSV |
| Scope | All 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
| Field | Description |
|---|---|
| OrganizationNumber | Official company registration number (from national registry) |
| MerchantId | Unique identifier for the merchant in the system |
| MerchantName | Name of the merchant (legal or display name) |
| GLN | Global Location Number, a standardized identifier for a location or organization |
Payment Configuration
| Field | Description |
|---|---|
| InstoreConfigID | Internal identifier for the payment configuration the terminal is connected to |
| InstoreConfigName | Descriptive/common name of the payment configuration associated with the InStoreConfigId |
Terminal Identification
| Field | Description |
|---|---|
| TerminalID | Unique identifier for the payment virtual terminal in the system |
| POSName | Terminal’s common name or readable label (e.g. defined by customer or technician) |
| SerialNumber | Manufacturer’s serial number of the terminal |
| VirtualTID | Virtual Terminal ID linking terminals with the voucher terminal table to ensure terminal authorization |
Device & Deployment
| Field | Description |
|---|---|
| DeviceType | Terminal model or device type |
| DeploymentTag | Label used during rollout to group or distinguish terminals |
Terminal Status & Configuration
| Field | Description |
|---|---|
| TerminalStatus | Current operational status of the terminal (e.g. active, deactivated) |
| TerminalConfigName | Name or identifier of the configuration package assigned to the terminal |
| TerminalConfigVersion | Version of the configuration currently running on the terminal |
| TerminalConfigID | Unique identifier for the terminal configuration |
| PAVersion | Version of the payment application running on the terminal |
Merchant Location Information
| Field | Description |
|---|---|
| MerchantStreet | Street address of the merchant location |
| MerchantPostalCode | Postal or ZIP code of the merchant location |
| MerchantPostalArea | City or town of the merchant location |
| MerchantCountryCode | Country code in ISO format (e.g. NO for Norway) |
Updated 13 days ago
Did this page help you?