Loading…
arrow_backMerchant API Reference

Webhooks (optional)

If you set a Webhook URL on the Merchant API card, VendStack POSTs an event there after every terminal transaction, so your systems stay in sync without polling. This is the return signal to complement the /vend call we make to you.

Each delivery is signed the same way as our requests — verify the X-VendStack-Signature header (HMAC-SHA256 of timestamp.rawBody with your signing secret) and reject anything that doesn't match or is stale.

Headers: X-VendStack-Event, X-VendStack-Timestamp, X-VendStack-Signature.

Body

{
  "event": "transaction.completed",
  "status": "completed",
  "reference": "VS-20260727-1A2B3C4D",
  "channel": "whatsapp",
  "customer_msisdn": "2348030000000",
  "recipient_msisdn": "08012345678",
  "service": "data",
  "network": "MTN",
  "product": "5GB",
  "amount": 2500,
  "occurred_at": "2026-07-27T14:20:05+01:00"
}
  • event is transaction.completed or transaction.failed.
  • reference matches the one from the original /vend — use it to reconcile.
  • Return 2xx to acknowledge; we retry a few times on failure.