Reconciliation

Message category	Class	Direction
`Reconciliation`	Service	ECR → terminal

📘
Used in these guides
Reconciliation and totals

A Reconciliation request can be used to one of the following:

Function	Value of ReconciliationType	Description
Close current reconciliation period	"AcquirerSyncronisation"	Closes the current period for the merchant for all acquirers of the merchant and for all terminals/POIs acquirers of the merchant. The totals of the closed period are received in the response
Request totals for a previously closed reconciliation period	"PreviousReconciliation"	Requests the result of a previous reconciliation period without closing the period. The period is identified by `POIReconciliationID`. Totals are included in the response.

For both variants, totals per brand or payment instrument type are included in the Reconciliation response.

Merchants can be set up with two alternative reconciliation configurations:

Automatic reconciliation:

Aera closes the reconciliation period at a scheduled time, normally close to midnight. If a merchant configured for Automatic sends a Reconciliation request with ReconciliationType = "AcquirerSyncronisation", the request is declined. To get the totals of a closed period, the merchant can send a Reconciliation request with ReconciliationType = "PreviousReconciliation".

On demand reconciliation:

To close a period and a start a new one, the merchant must send a reconciliation request with ReconciliationType = "AcquirerSyncronisation". The totals of the closed period are received in the response.

Example request and response

reconciliation

All fields

Example Reconciliation request

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "2",
      "MessageClass": "Service",
      "MessageCategory": "Reconciliation",
      "MessageType": "Request",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "ReconciliationRequest": {
      "ReconciliationType": "PreviousReconciliation",
      "POIReconciliationID": "20241130_001"
    }
  }
}

Field	Required	Description
`ReconciliationRequest`	Required	Contains the fields below
↳ `ReconciliationType`	Required	Type of Reconciliation request, "AcquirerSyncronisation" or "PreviousReconciliation" as descibed above
↳ `POIReconciliationID`	Optional	Refers to the reconciliation period. If omitted, totals for the last closed period are included in the response. Not used for ReconciliationType = "AcquirerSyncronisation"

Example Reconciliation response

{
  "SaleToPOIResponse": {
    "MessageHeader": {
      "MessageCategory": "Reconciliation",
      "MessageClass": "Service",
      "MessageType": "Response",
      "POIID": "AT12345",
      "ProtocolVersion": "3.1",
      "SaleID": "ECR123",
      "ServiceID": "2"
    },
    "ReconciliationResponse": {
      "Response": {
        "AeStan": "123456",
        "AeAcquirerResponseCode": "00",
        "AeResponseCode": "000",
        "AdditionalResponse": "",
        "Result": "Success"
      },
      "ReconciliationType": "PreviousReconciliation",
      "POIReconciliationID": "20241130_001",
      "TransactionTotals": [
        {
          "CardBrand": "01:BankAxept",
          "HostReconciliationID": "009:Nets",
          "PaymentCurrency": "NOK",
          "PaymentTotals": [
            {
              "TransactionType": "Debit",
              "TransactionCount": 30,
              "TransactionAmount": 3230.75
            },
            {
              "TransactionType": "Credit",
              "TransactionCount": 2,
              "TransactionAmount": 200
            },
            {
              "TransactionType": "ReverseDebit",
              "TransactionCount": 2,
              "TransactionAmount": 200
            },
            {
              "TransactionType": "ReverseCredit",
              "TransactionCount": 1,
              "TransactionAmount": 100
            },
            {
              "TransactionType": "CashBack",
              "TransactionCount": 8,
              "TransactionAmount": 400
            },
            {
              "TransactionType": "CashAdvance",
              "TransactionCount": 3,
              "TransactionAmount": 300
            },
            {
              "TransactionType": "CashDeposit",
              "TransactionCount": 1,
              "TransactionAmount": 100
            }
          ]
        }
      ]
    }
  }
}

Field	Required	Description
`ReconciliationResponse`	Required	Contains the fields below
↳ `Response`	Required
↳ `ReconciliationType`	Required	Copy from the request
↳ `POIReconciliationID`	Optional	ID of the requested period
↳ `TransactionTotals`	Optional	List, one per combination of CardBrand and HostReconciliationID
↳ `CardBrand`	Optional	Grouping per brand or subset of brand, normally based on a BIN- range, consists of PIT/Card Type ":" and the Brand Name
↳ `HostReconciliationID`	Optional	Combination SessionId as received by the acquirer (using a default value if not present) ":" and the name of the Acquirer Processor
↳ `PaymentCurrency`	Optional
↳ `PaymentTotals`	Optional	List, one per TransactionType with amount/count > 0
↳ `TransactionType`	Optional	Enumerations: "Debit", "Credit", "ReverseDebit", "ReverseCredit", "CashBack", "CashAdvance", "CashDeposit "Debit" : All purchases (sales) including goods only, goods with cashback ("CashBack") and cash only ("CashAdvance") "Credit" : All refunds including cash deposits ("CashDeposit") "ReverseDebit" : All manual reversals (cancellations) of purchases (sales) "ReverseCredit" : All manual reversals (cancellations) of refunds (no manual reversal of cash deposits) "CashBack" : All purchases (sales) with both goods and cash (included in "Debit" counts/amounts) "CashAdvance" : All purchases (sales) with cash only (included in "Debit" amounts/counts) "CashDeposit" : All cash only deposits (included in "Credit" amounts/counts)
↳ `TransactionCount`	Optional	Total number of transactions (for "Debit" including "CashBack" and "CashAdvance" counts, for "Credit" including "CashDeposit" counts)
↳ `TransactionAmount`	Optional	Total transaction amount (for "Debit" including "CashBack" and "CashAdvance" amounts, for "Credit" including "CashDeposit" amounts)