GetTotalsResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/main/json-schema/adyen-get-totals-response-schema.json",
  "title": "GetTotalsResponse",
  "description": "It conveys Information related to the Reconciliation transaction processed by the POI System. Content of the Reconciliation Response message.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/adyen-gettotals-api-openapi.yml#/components/schemas/GetTotalsResponse",
  "type": "object",
  "properties": {
    "Response": {
      "$ref": "#/$defs/Response"
    },
    "POIReconciliationID": {
      "type": "integer",
      "description": "Identification of the reconciliation period between Sale and POI."
    },
    "TransactionTotals": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/TransactionTotals"
      }
    }
  },
  "required": [
    "Response",
    "POIReconciliationID"
  ],
  "$defs": {
    "ErrorCondition": {
      "type": "string",
      "enum": [
        "Aborted",
        "Busy",
        "Cancel",
        "DeviceOut",
        "InProgress",
        "InsertedCard",
        "InvalidCard",
        "LoggedOut",
        "MessageFormat",
        "NotAllowed",
        "NotFound",
        "PaymentRestriction",
        "Refusal",
        "UnavailableDevice",
        "UnavailableService",
        "UnreachableHost",
        "WrongPIN"
      ]
    },
    "LoyaltyTotals": {
      "type": "object",
      "description": "Totals of the loyalty transaction during the reconciliation period.",
      "properties": {
        "TransactionType": {
          "$ref": "#/$defs/TransactionType"
        },
        "TransactionCount": {
          "type": "integer",
          "description": "Number of processed transaction during the period."
        },
        "TransactionAmount": {
          "type": "number",
          "maximum": 99999999.999999,
          "minimum": 0,
          "description": "Sum of amount of processed transaction during the period."
        }
      },
      "required": [
        "TransactionType",
        "TransactionCount",
        "TransactionAmount"
      ]
    },
    "LoyaltyUnit": {
      "type": "string",
      "enum": [
        "Monetary",
        "Point"
      ]
    },
    "PaymentInstrumentType": {
      "type": "string",
      "enum": [
        "Card",
        "Cash",
        "Check",
        "Mobile",
        "StoredValue"
      ]
    },
    "PaymentTotals": {
      "type": "object",
      "description": "Totals of the payment transaction during the reconciliation period.",
      "properties": {
        "TransactionType": {
          "$ref": "#/$defs/TransactionType"
        },
        "TransactionCount": {
          "type": "integer",
          "description": "Number of processed transaction during the period."
        },
        "TransactionAmount": {
          "type": "number",
          "maximum": 99999999.999999,
          "minimum": 0,
          "description": "Sum of amount of processed transaction during the period."
        }
      },
      "required": [
        "TransactionType",
        "TransactionCount",
        "TransactionAmount"
      ]
    },
    "Response": {
      "type": "object",
      "description": "If Result is Success, ErrorCondition is absent or not used in the processing of the message. In the other cases, the ErrorCondition has to be present and can refine the processing of the message response. AdditionalResponse gives more information about the success or the failure of the message request processing, for logging without real time involvements. Result of a message request processing.",
      "properties": {
        "Result": {
          "$ref": "#/$defs/Result"
        },
        "ErrorCondition": {
          "$ref": "#/$defs/ErrorCondition"
        },
        "AdditionalResponse": {
          "type": "string",
          "pattern": "^.+$",
          "description": "If present, the POI logs it for further examination."
        }
      },
      "required": [
        "Result"
      ]
    },
    "Result": {
      "type": "string",
      "enum": [
        "Failure",
        "Partial",
        "Success"
      ]
    },
    "TransactionTotals": {
      "type": "object",
      "description": "If Result is Success, contains all the totals, classified as required by the Sale in the message request. At least, transaction totals are provided per Acquirer, Acquirer Settlement, and Card Brand. Result of the Sale to POI Reconciliation processing.",
      "properties": {
        "PaymentInstrumentType": {
          "$ref": "#/$defs/PaymentInstrumentType"
        },
        "AcquirerID": {
          "type": "integer",
          "description": "If available."
        },
        "HostReconciliationID": {
          "type": "string",
          "pattern": "^.+$",
          "description": "If available."
        },
        "CardBrand": {
          "type": "string",
          "pattern": "^.+$",
          "description": "If configured to present totals per card brand, and Response.Result is Success."
        },
        "POIID": {
          "type": "string",
          "pattern": "^.+$",
          "description": "If requested in the message request."
        },
        "SaleID": {
          "type": "string",
          "pattern": "^.+$",
          "description": "If requested in the message request."
        },
        "OperatorID": {
          "type": "string",
          "pattern": "^.+$",
          "description": "If requested in the message request."
        },
        "ShiftNumber": {
          "type": "string",
          "pattern": "^.+$",
          "description": "If requested in the message request."
        },
        "TotalsGroupID": {
          "type": "string",
          "pattern": "^.{1,16}$",
          "description": "If requested in the message request."
        },
        "PaymentCurrency": {
          "type": "string",
          "pattern": "^[A-Z]{3,3}$",
          "description": "Currency of a monetary amount."
        },
        "PaymentTotals": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PaymentTotals"
          }
        },
        "LoyaltyUnit": {
          "$ref": "#/$defs/LoyaltyUnit"
        },
        "LoyaltyCurrency": {
          "type": "string",
          "pattern": "^[A-Z]{3,3}$",
          "description": "If LoyaltyUnit is Monetary."
        },
        "LoyaltyTotals": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/LoyaltyTotals"
          }
        }
      },
      "required": [
        "PaymentInstrumentType"
      ]
    },
    "TransactionType": {
      "type": "string",
      "enum": [
        "Award",
        "CashAdvance",
        "CompletedDeffered",
        "CompletedReservation",
        "Credit",
        "Debit",
        "Declined",
        "Failed",
        "FirstReservation",
        "IssuerInstalment",
        "OneTimeReservation",
        "Rebate",
        "Redemption",
        "ReverseAward",
        "ReverseCredit",
        "ReverseDebit",
        "ReverseRebate",
        "ReverseRedemption",
        "UpdateReservation"
      ]
    }
  }
}