API Reference
Overview
Browse the merchant-server API and webhook guides.
Merchant API surface
Authenticate merchant-server requests with X-Api-Key (zp_live_…). Create sessions, poll status, and reconcile orders — then pass clientToken to @zippypay/checkout in the browser. Never expose your API key client-side.
/api/v1/payment-sessionsCreate an amount-locked checkout session and receive a one-time client token.
/api/v1/payment-sessions?merchantReference={ref}Look up a session by your merchantReference for reconciliation.
/api/v1/payment-sessions/{sessionId}Read merchant-safe session status by sessionId.
Test requests
Each payment session endpoint page includes synchronized examples and an interactive playground for cURL, JavaScript, and Python.
Webhook reference
Webhooks are inbound callbacks rather than additional API-key operations. Register endpoints in the merchant portal and use these guides to build and test your receiver.