Reconciliation Request

Content of the Reconciliation Request message. It conveys Information related to the Reconciliation requested by the Sale System.

Request Parameters

Required

Optional

Type of Reconciliation requested by the Sale to the POI.

Identification of the Acquirer. Could be present only if ReconciliationType is AcquirerReconciliation or AcquirerSynchronisation.

Identification of the reconciliation period between Sale and POI. Absent if ReconciliationType is not PreviousReconciliation.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200
It conveys Information related to the Reconciliation transaction processed by the POI System. Content of the Reconciliation Response message.
Show more Show less
Responseobject
Result of a message request processing. 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.
Show children Hide children
Resultstring
Result of the processing of the message.
ErrorConditionstring
Condition that has produced an error on the processing of a message request. Returned if Result is not Success.
AdditionalResponsestring
Additional information related to processing status of a message request. If present, the POI logs it for further examination.
ReconciliationTypestring
Type of Reconciliation requested by the Sale to the POI.
POIReconciliationIDinteger
Identification of the reconciliation period between Sale and POI. Absent if ReconciliationType is AcquirerReconciliation.
TransactionTotalsarray[object]
Result of the Sale to POI Reconciliation processing. If Response.Result is Success.
Show children Hide children
PaymentInstrumentTypestring
Type of payment instrument.
AcquirerIDinteger
Identification of the Acquirer.
HostReconciliationIDstring
Identifier of a reconciliation period with a payment or loyalty host.
CardBrandstring
Type of payment or loyalty card. If configured to present totals per card brand, and Response.Result is Success.
POIIDstring
Identification of a POI System or a POI Terminal for the Sale to POI protocol. Sent if requested in the message request.
SaleIDstring
Identification of a Sale System or a Sale Terminal for the Sale to POI protocol. Sent if requested in the message request.
OperatorIDstring
Identification of the Cashier or Operator. Sent if requested in the message request.
ShiftNumberstring
Shift number. Sent if requested in the message request.
TotalsGroupIDstring
Identification of a group of transaction on a POI Terminal, having the same Sale features. Sent if requested in the message request.
PaymentCurrencystring
Currency of a monetary amount.
PaymentTotalsarray[object]
Totals of the payment transaction during the reconciliation period. If both TransactionCount and TransactionAmount are not equal to zero.
Show children Hide children
TransactionTypestring
Type of transaction for which totals are grouped. Debit, Credit, ReverseDebit, ReverseCredit, OneTimeReservation, CompletedDeffered, FirstReservation, UpdateReservation, CompletedReservation, CashAdvance.
TransactionCountinteger
Number of processed transaction during the period.
TransactionAmountnumber
Maximum: 99999999.999999
Sum of amount of processed transaction during the period.
LoyaltyUnitstring
Unit of a loyalty amount.
LoyaltyCurrencystring
Currency of a monetary amount. Sent if LoyaltyUnit is Monetary.
LoyaltyTotalsarray[object]
Totals of the loyalty transaction during the reconciliation period. If both TransactionCount and TransactionAmount are not equal to zero.
Show children Hide children
TransactionTypestring
Type of transaction for which totals are grouped. Award, ReverseAward, Redemption, ReverseRedemption, Rebate, ReverseRebate.
TransactionCountinteger
Number of processed transaction during the period.
TransactionAmountnumber
Maximum: 99999999.999999
Sum of amount of processed transaction during the period.

Reconciliation Request

Request Parameters

Response parameters

HTTP Responses

200