Skip to main content

Administrative Request/Response Models

The data models below define the structure for administrative operations such as generating X-Reports, Z-Reports, performing terminal logon, and opening the Paynt app.

StartAdminRequest​

data class StartAdminRequest(
    val type: StartAdminType = StartAdminType.Unknown
)

StartAdminResponse​

data class StartAdminResponse(
    val type: StartAdminType = StartAdminType.Unknown,
    val detailedList: List<StartAdminReportTotals>? = null,  // Brand-specific totals
    val total: StartAdminReportTotals? = null,               // Overall totals
    val response: String? = null                             // Response code (acquirer specific)
)

StartAdminReportTotals​

data class StartAdminReportTotals(
    val saleCount: Int = 0,      // Number of sales
    val refundCount: Int = 0,    // Number of refunds
    val saleAmount: Int = 0,     // Total sales amount in cents
    val refundAmount: Int = 0,   // Total refunds amount in cents
    val brand: String = "All"    // Card brand or "All"
)

StartAdminType​

enum class StartAdminType {
    XReport,    // X Report (current totals)
    ZReport,    // Z Report (end of day with totals reset)
    Logon,      // Terminal logon
    OpenApp,    // Just open the app
    Unknown
}