Retrieve totals from the terminal

Return payment totals from a terminal and filter for totals by group or operator.

Use GetTotalsRequest to retrieve totals from a terminal without starting a new reconciliation period.

Requirements

Endpoint

The URL used to send Terminal API messages depends on your type of implementation. See Use the correct endpoint.

GetTotalsRequest

For a list of GetTotalsRequest fields, see GetTotalsRequest fields.

The SaleID and ServiceID in the MessageHeader should be unique. SaleID and ServiceID combinations are rejected if used recently, within 48 hours.

The fields described below are the fields you specify when making a GetTotalsRequest call to the Terminal API.

 {
   "SaleToPOIRequest":{
      "MessageHeader":{
         "ProtocolVersion":"3.0",
         "MessageClass":"Service",
         "MessageCategory":"GetTotals",
         "MessageType":"Request",
         "ServiceID":"0518144235",
         "SaleID":"CashRegB3",
         "POIID":"P400Plus-275008565"
      },
      "GetTotalsRequest":{
         "TotalFilter":{
            "POIID":"P400Plus-275008565"
         }
      }
   }
}

Use the TotalFilter to limit the totals to the presented field/value combinations.

Use the TotalDetails cluster to group the results on the specified fields.

GetTotalsRequest - Specific totalsGroupID

Returns totals for a specific group of totals. Specified with the totalsGroupID.

 {
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.0",
      "MessageClass": "Service",
      "MessageCategory": "GetTotals",
      "MessageType": "Request",
      "ServiceID": "0821163913",
      "SaleID": "CashRegB3",
      "POIID": "P400Plus-275008565"
    },
    "GetTotalsRequest": {
      "TotalFilter": {
        "POIID": "P400Plus-275008565",
        "TotalsGroupID": "GroupA"
      }
    }
  }
}

GetTotalsRequest - Group by OperatorID

Return a list of totals for an operator. Specified with the OperatorID.

 {
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.0",
      "MessageClass": "Service",
      "MessageCategory": "GetTotals",
      "MessageType": "Request",
      "ServiceID": "0821164804",
      "SaleID": "CashRegB3",
      "POIID": "P400Plus-275008565"
    },
    "GetTotalsRequest": {
      "TotalFilter": {
        "POIID": "P400Plus-275008565"
      },
      "TotalDetails": [
        "OperatorID"
      ]
    }
  }
}

GetTotalsResponse

For a list of GetTotalsResponse fields, see GetTotalsResponse fields.


Copy code
{
   "SaleToPOIResponse":{
      "MessageHeader":{
         "ProtocolVersion":"3.0",
         "SaleID":"CashRegB3",
         "MessageClass":"Service",
         "MessageCategory":"GetTotals",
         "ServiceID":"0518144235",
         "POIID":"P400Plus-275008565",
         "MessageType":"Response"
      },
      "GetTotalsResponse":{
         "POIReconciliationID":"1000",
         "Response":{
            "Result":"Success"
         },
         "TransactionTotals":[
            {
               "SaleID":"CashRegB3",
               "PaymentInstrumentType":"StoredValue",
               "PaymentCurrency":"EUR",
               "PaymentTotals":[
                  {
                     "TransactionType":"Debit",
                     "TransactionCount":1,
                     "TransactionAmount":100.99
                  }
               ],
               "OperatorID":"",
               "CardBrand":"SVS",
               "TotalsGroupID":"GroupA",
               "ShiftNumber":""
            },
            {
               "SaleID":"CashRegB3",
               "PaymentInstrumentType":"Card",
               "PaymentCurrency":"EUR",
               "PaymentTotals":[
                  {
                     "TransactionType":"Debit",
                     "TransactionCount":51,
                     "TransactionAmount":1841.52
                  }
               ],
               "OperatorID":"",
               "CardBrand":"mc",
               "TotalsGroupID":"GroupA",
               "ShiftNumber":""
            }
         ]
      }
   }