Search docs

Are you looking for test card numbers?

Would you like to contact support?

Start searching Adyen's documentation...

  Documentation

Reconcile a balance mismatch

Get the totals of a reconciliation period and use them to reconcile balance mismatches between the terminal and cash register.

You may need to reconcile the balance between your terminal and cash register when a mismatch occurs. For example, if the connection dropped at some point and the cash register doesn't receive the final response.

Use the ReconciliationRequest to:

  1. Get the totals of the current reconciliation period and start a new period (using "ReconciliationType":"SaleReconciliation".

  2. Get the report of a previous reconciliation period Using "ReconciliationType":"PreviousReconciliation" and "POIReconciliationID":"NNN" . In this case, no new reconciliation period is started.

Before you begin

Endpoint

The URL used to send Terminal API messages depends on your type of implementation. For more information on the architectures available, see the Terminal API Overview.

ReconciliationRequest

For a list of ReconciliationRequest fields, see ReconciliationRequest 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 ReconciliationRequest call to the Terminal API.

{
   "SaleToPOIRequest":{
      "MessageHeader":{
         "ProtocolVersion":"3.0",
         "MessageClass":"Service",
         "MessageCategory":"Reconciliation",
         "MessageType":"Request",
         "ServiceID":"0518145303",
         "SaleID":"CashRegB3",
         "POIID":"P400Plus-275008565"
      },
      "ReconciliationRequest":{
         "ReconciliationType":"SaleReconciliation"
      }
   }
}

ReconciliationResponse

For a list of ReconciliationResponse fields, see ReconciliationResponse fields.

The reconciliation response contains information about the status of the terminal in the following fields:

{
   "SaleToPOIResponse":{
      "ReconciliationResponse":{
         "ReconciliationType":"SaleReconciliation",
         "POIReconciliationID":"1000",
         "Response":{
            "Result":"Success"
         },
         "TransactionTotals":[
            {
               "SaleID":"CashRegB3",
               "PaymentInstrumentType":"Card",
               "PaymentCurrency":"EUR",
               "PaymentTotals":[
                  {
                     "TransactionType":"Debit",
                     "TransactionCount":1,
                     "TransactionAmount":10.99
                  }
               ],
               "OperatorID":"John",
               "CardBrand":"mc",
               "TotalsGroupID":"GroupA",
               "ShiftNumber":"123"
            }
         ]
      },
      "MessageHeader":{
         "ProtocolVersion":"3.0",
         "SaleID":"CashRegB3",
         "MessageClass":"Service",
         "MessageCategory":"Reconciliation",
         "ServiceID":"0518145303",
         "POIID":"P400Plus-275008565",
         "MessageType":"Response"
      }
   }
}