Loading…
arrow_backMerchant API Reference

Going live

  • Your Merchant API is saved in the dashboard (base URL + signing secret) — this powers every channel.
  • All endpoints your products need respond over HTTPS within a few seconds.
  • You verify the signature on every request and reject stale/invalid ones.
  • /vend validates the PIN against customer_msisdn, debits that wallet, and is idempotent on reference.
  • (For scheduling) /vend accepts a signed PIN-less request when authorization: "scheduled" is present, and debits on the strength of the signature.
  • /validate returns real account names (recommended — customers confirm before paying).
  • (Recommended) /status looks a purchase up by reference so timed-out vends reconcile cleanly instead of being reported as unconfirmed.
  • Errors return a customer-safe message (and error_code: "invalid_pin" for wrong PINs).
  • (Optional) If you set a Webhook URL, you verify its signature and reconcile on reference.
  • (Optional) You call the customer receipts endpoint when a wallet is funded, so customers get a receipt in chat.

Your store starts in test mode: customers can run the whole flow (menus, confirmation, PIN) but purchases are not sent to your backend — perfect for rehearsing without moving money. When the checklist above passes, open Dashboard → Integrations and click Go live. From then on real purchases hit your /vend; share your code (*347*321*1#), WhatsApp number or Telegram bot with your customers. You can switch back to test at any time.