For Retailers

Connect your system to Zedlayby

If you have your own point-of-sale or business management system, you can link it to Zedlayby. When a shopper makes a payment or their layby status changes, your system is notified automatically — no manual checking required.

What the integration gives you

Live payment alerts

Your system is notified the moment a shopper makes a payment on any active layby. No need to log into Zedlayby to check.

Status updates

Get notified when a layby is approved, completed or cancelled — so your inventory and records stay in sync.

One less screen to watch

Your team works in your own system. Zedlayby simply feeds it the information it needs, when it needs it.

How to set it up

1

Get your API key

Log in to your retailer dashboard and go to Settings → POS Integration. Generate your API key there. This key identifies your business — keep it private.

2

Register your webhook URL

In the same settings screen, enter the web address of your system where you'd like to receive notifications. This is called a webhook — it's simply a URL on your end that Zedlayby will send a message to whenever something important happens.

Your URL must be publicly accessible (not behind a firewall) and must accept HTTPS connections.

3

Handle incoming notifications

When a payment is recorded on Zedlayby, we send a notification to your webhook URL. The message is in standard JSON format and contains the reference number, the amount paid, and the current status of the layby.

Your system should respond with a 200 OK status to confirm receipt. If we don't get a confirmation, we'll retry a few times automatically.

What a notification looks like

When a payment is recorded, your webhook receives a POST request with a body similar to this:

{
  "event": "payment.recorded",
  "reference": "ZED-00001234",
  "shopper_name": "John Banda",
  "product": "Samsung 65\" Smart TV",
  "amount_paid": 500.00,
  "total_paid_to_date": 1500.00,
  "balance_remaining": 2000.00,
  "status": "ACTIVE",
  "timestamp": "2025-04-11T10:30:00Z"
}

All amounts are in Zambian Kwacha (ZMW). Timestamps are in UTC.

Layby status values

Status What it means
SUBMITTEDThe shopper has applied. Awaiting your approval.
APPROVEDYou have approved the application. Payments can now begin.
ACTIVEAt least one payment has been recorded.
COMPLETEDFully paid. The shopper may collect their item.
CANCELLEDThe layby has been cancelled. Refund terms apply.

Security note

Every notification we send includes your API key in the request header under Authorization: Bearer YOUR_KEY. Always verify this on your end before processing the notification — this confirms the request genuinely came from Zedlayby.

Need help getting connected?

Our team can walk you through the setup. Email us with the name of your POS system and we'll help from there.

Contact Support