Changelog

Release notes for the merchant API surface and developer documentation. Versions follow the Payment Gateway backend release tag. Internal infrastructure changes (deploy pipeline, multi-tenancy refactor, CI bumps, etc.) are documented in the repository only and are intentionally omitted here.

How to read this changelog

• Each version groups changes into Added, Changed, Deprecated, Removed, Security, and Fixed. Empty sections are omitted.
• Entries that require merchant client changes are prefixed with ⚠ Breaking.
• Every entry links to the affected chapter where possible.
• Docs site versions track the backend release tag. Not every backend release ships a merchant-surface change; releases with no merchant-visible delta are listed as internal-only so the version-to-tag mapping stays continuous.

[Unreleased]

• Documentation: Wave 3 — Security, FAQ, and Changelog chapters in three languages (en / zh-Hant / zh-Hans), plus an i18n completeness CI guard that fails the PR check when chapters drift across locales. Link to be added after the PR merges.

[v0.53.0] — 2026-05-20

Added

• Documentation: Wave 2 — Quickstart, Deposits, Withdrawals, and Callbacks chapters in three languages (en / zh-Hant / zh-Hans). Includes 5 Mermaid flow diagrams covering deposit-direct, deposit-cashier, withdrawal, callback-handshake, and error-recovery sequences. Cross-links between chapters now exist for all common merchant journeys.

Fixed

• Documentation: Sandbox chapter endpoint path corrected from /api/v1/merchant/deposit to /api/v1/merchant/orders/deposit. Response envelope shape corrected from {"code": 0} to {"success": true, "code": "SUCCESS"} so it matches the actual server response. Affected all three locales.

PR: #89

[v0.52.1] — 2026-05-20

Internal release; no merchant-API-surface or documentation changes. (Frontend impersonation banner fix in the operator console; not part of the merchant API.)

[v0.52.0] — 2026-05-20

Added

• Documentation: Wave 1 — Errors and Sandbox chapters in three languages. The Errors chapter is the canonical HTTP-status + business-code reference for the merchant API; the Sandbox chapter documents test credentials, fixture amounts, and the manual callback trigger.
• Code samples: verify.{sh,py,php,ts} callback signature verification samples added under docs-site/shared/code-samples/. These are referenced by the Callbacks chapter (which lands in v0.53.0).
• CI: Cross-language sample parity test enforced in CI (docs-pr-check.yml) — all four verify.* samples must accept identical fixtures and return identical results, preventing per-language drift.

PR: #86

[v0.51.0] — 2026-05-19

Added

• Documentation: docs.open-pay.co infrastructure live. VitePress site with three locales (en / zh-Hant / zh-Hans), Authentication chapter (EN seed), auto-generated API Reference from a filtered OpenAPI export, sidebar/navigation, search, and PR/release CI deploying to Cloudflare Pages.
• Code samples: sign.{sh,py,php,ts} request signing samples added under docs-site/shared/code-samples/. Referenced by Authentication — all four samples produce identical signatures from identical inputs and are checked by CI.
• Backend: python -m app.cli export-openapi --scope merchant CLI added for filtered OpenAPI export (merchant-tagged routes only, internal admin/platform routes excluded). Internal tool that powers the API Reference build; merchants do not invoke it directly.

PR: #78

[v0.50.0] — 2026-05-19

Internal release; no merchant-API-surface or documentation changes. (Centralised logging infrastructure for the OL environment and a platform-console picker fix; neither affects the merchant API.)

Earlier versions

Release history before v0.50.0 predates the merchant documentation site. Earlier merchant-API changes are not catalogued here; consult your account manager if you need historical context on a specific endpoint, callback payload, or schema field.