Clearing integration

If shopreme handles payment (S&G mobile payment, or snap cart on-device NFC payment) - we integrate with your Payment Service Provider (PSP), handle the payment processing, and send the resulting transaction info (TLOG) to your ERP after every successful transaction.
The process of sending transaction information to your systems is called "transaction clearing" in the shopreme universe.

This article explains what clearing is, how it works in the shopreme ecosystem, when it is required, and what teams typically implement it.

Why transaction clearing integration is important

Clearing ensures that every successful transaction from Scan & Go is:

• Logged for bookkeeping on the retailer’s side

• Forwarded for stock updates

• Linked to loyalty systems (e.g., earning points) or coupon redemption

• (Optionally) Used to trigger receipt generation

Without clearing, your ERP or financial backend won't know that a purchase occurred, which can lead to gaps in accounting, reconciliation issues, or unredeemed coupons.

How clearing works

Clearing is handled by the Outbound API on the shopreme Middleware. After a successful payment, the Middleware sends a structured clearing request (/liveClearing) to your external system.

This request includes:

• Full transaction metadata

• Purchased products (product numbers and barcodes)

• Final payment amounts and methods

• Loyalty and coupon data

• Store identifier

• Timestamps for when the purchase started and completed

📌 Note: If your backend doesn’t respond with a 200 status code (success), the Middleware automatically retries the request at a configurable interval until the clearing is successful. After 10 retries, shopreme stores the log and alerts the operations and support team - this information is not lost.

Receipt generation (optional)

Clearing integration can be extended to also include receipt handling. If receipt handling is configured:

1. After clearing is successful, the shopreme backend sends a /receipt request to your system using the same transactionId

2. Your system generates the PDF or print-ready receipt

3. The receipt is made available in the Scan & Go app (in PDF) or printed on paper from a shopreme self-checkout device

📌 The specifications of this API can be found on the shopreme Knowledge Base, for the respective teams to work on this integration in detail.

Who sets this up?

Clearing integration is typically handled by:

• Backend developers – who implement the clearing and receipt endpoints

• ERP/invoicing teams – who consume the data for reconciliation

• Accounting and finance stakeholders – who define reporting requirements

• Loyalty or marketing teams – if promotion/coupon tracking is needed

The DataHub section in the shopreme Management Console provides sample payloads, retry behavior documentation, and error monitoring information to support integration and testing.