Reference
Changelog and versioning
Track API and Checkout SDK compatibility changes.
Versioning
Documentation is path-versioned under /docs/v1/.... The HTTP API currently uses /api/v1/.... Breaking API changes will ship under a new path version with advance notice.
Current version
- Docs path version:
v1 - Merchant API:
v1( create and GET payment sessions) - Checkout SDK:
@zippypay/checkout1.2.1
Checkout SDK 1.2.1
Current release. No SDK behavior changes vs 1.2.0.
- Documentation updates for mobile app checkout and SDK defaults.
- Documents
mobileAppdefaultenforce, Pay with Zippy handoff, store links, and method switching.
Checkout SDK 1.2.0
Phone checkout now defaults to Pay with Zippy when mobileApp is omitted.
mobileAppdefaults toenforceon phone (SDK init or web component).- Opt out with
mobileApp: { policy: 'off' }ormobile-app-policy="off"for web-only phone checkout. - Web component supports
off,option, andenforceformobile-app-policy. - Breaking: integrations that relied on web-only phone checkout must explicitly set
policy: 'off'.
Checkout SDK 1.1.11
- iOS App Store link updated to
https://apps.apple.com/in/app/zippypay/id6806799311.
Checkout SDK 1.1.x
Mobile app checkout and related fixes. Minimum version for Pay with Zippy: 1.1.0.
- Added
mobileApp.policy:off,option,enforce(phone only). - Pay with Zippy opens the app on customer tap (iOS and Android). Checkout stays on the merchant page.
- Opening Zippy… disabled button state while the SDK attempts to open the app.
- Failed handoff: Try again, Or pay another way, Install Zippy (bottom). Store is not opened automatically.
- Before payment is claimed in the app, customers may switch from Pay with Zippy to QR or manual via the failed handoff screen.
- Inline timer hidden on idle/opening; bottom progress bar during pay window.
- Added
checkoutPolicyto restrict web fallback methods.
See Mobile app checkout for configuration and customer flow details.
Checkout SDK 1.1.0
First public release of @zippypay/checkout. Released 2026-08-31.
- Inline and modal embed modes with Shadow DOM scoping (no separate CSS import).
- QR and manual Zippy ID checkout paths with session polling.
- Web component (
zippy-pay-checkout) and framework examples for React, Vue, and Angular. - Theming, redirect handling, and terminal screen countdowns.
Deprecation policy
Reserved webhook event types (payment_session.cancelled, payment_session.failed, transaction.cancelled, transaction.failed) are listed for forward compatibility but are not emitted live yet. Do not build production logic against them until announced here.