Introduction

This solution leverages the Mini Game Open APIs provided by the AlipayHK Open Platform, enabling merchants to publish and manage games on AlipayHK throughout their full lifecycle via API integration.

Create & Edit Game Applications

Create and edit applications—including multilingual names, icons, and display tags, with the merchant's gameId mapped to a wallet-side appId—via /api/open/v1/alipay/intl/hkwallet/app/save. New applications are activated immediately with no version attached.

Submit Game Versions

Upload game packages (with MD5 integrity verification) via /api/open/v1/alipay/intl/hkwallet/app/versions/create. The platform automatically generates a version number and returns a preview link.

Testing & Improvements

Preview access is limited to the phone-number whitelist (up to 64 numbers) submitted with the version, allowing merchants to test and iterate on the package before launch. When a new package is ready, submit a new version and re-test.

AlipayHK Approval: Submit a version for review, withdraw a submission, or take it offline via /api/open/v1/alipay/intl/hkwallet/app/versions/apply, driving the state flow Preview → In Review → Released → Offline.

Launch & Lifecycle Notifications

Upon approval, the version goes live automatically. Merchants can also take a live version offline at any time. Status changes—audit results, version release/offline transitions, and application availability shifts (first version online, all versions offline)—are delivered asynchronously via callbacks to the merchant's pre-configured HTTPS callback URL, with automatic retries on delivery failure.

Game Information Query (on-demand)

Merchants call /api/open/v1/alipay/intl/hkwallet/app/query at any time to retrieve application details, the current effective version, audit progress, and version history. As notifications are asynchronous messages, this query API serves as the authoritative source of state whenever verification is needed.

Security & Reliability

All APIs are protected by platform-level signature verification and rate limiting, with merchants identified by their partner credentials. Version uploads are idempotent per appId + package version, preventing duplicate version creation; state transitions are strictly validated to prevent conflicting operations.