Adyen · JSON Structure

Terminal Transaction Totals Structure

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.

Type: object Properties: 14 Required: 1

PaymentsFinancial ServicesFintech

TransactionTotals is a JSON Structure definition published by Adyen, describing 14 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

PaymentInstrumentType AcquirerID HostReconciliationID CardBrand POIID SaleID OperatorID ShiftNumber TotalsGroupID PaymentCurrency PaymentTotals LoyaltyUnit LoyaltyCurrency LoyaltyTotals

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/terminal-transaction-totals-structure.json",
  "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.",
  "type": "object",
  "properties": {
    "PaymentInstrumentType": {
      "$ref": "#/components/schemas/PaymentInstrumentType"
    },
    "AcquirerID": {
      "type": "int32",
      "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": "#/components/schemas/PaymentTotals"
      }
    },
    "LoyaltyUnit": {
      "$ref": "#/components/schemas/LoyaltyUnit"
    },
    "LoyaltyCurrency": {
      "type": "string",
      "pattern": "^[A-Z]{3,3}$",
      "description": "If LoyaltyUnit is Monetary."
    },
    "LoyaltyTotals": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LoyaltyTotals"
      }
    }
  },
  "required": [
    "PaymentInstrumentType"
  ],
  "name": "TransactionTotals"
}