Skip to main content
Every meaningful change to the Payzah API and its documentation is recorded here, newest first. Check this page before upgrading, and after any support issue that involves behaviour you did not expect.
This changelog starts from August 2026. Changes made before that date are not recorded here. Endpoints and field names in use before this date remain unchanged and fully supported.

How to Read This Page

Each entry is tagged so you can tell at a glance whether it affects you:
Breaking changes are the only entries that require action from you. Subscribe your engineering team to this page, or check it before any production deployment.

August 2026

Documentation
Docs — Published a Quickstart that takes you from nothing to a completed sandbox payment in about five minutes.Docs — Documented the machine-readable resources available to AI agents and LLMs: llms.txt, llms-full.txt, openapi.yaml, and per-page Markdown via a .md suffix. See the Introduction.Docs — Published an Arabic Quickstart covering the same three-step sandbox payment flow.Docs — Published a public sandbox API key so developers can test the API without registering a merchant account first.Docs — Added an interactive API console. Every endpoint can now be called directly from the documentation against the test environment.Docs — Documented refund timing: K-Net refunds reach customers in around one business day, card refunds take up to 14 days. Also documented the settlement window and why refunding before settlement is faster. See Refunds.Docs — Published plugin installation guides for Shopify, WooCommerce, and Odoo.Docs — Added a Troubleshooting page mapping every error code to a specific fix, and a Go-Live Checklist.Docs — Documented the Refund API in full, including success and failure responses and the refund_type values.

Reporting an Issue

Found behaviour that contradicts this documentation? Contact [email protected] with the trackid, the endpoint you called, and the full response body. Undocumented behaviour changes are treated as bugs.