> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payzah.site/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Payzah API Changelog: Updates and Breaking Changes

> Track every change to the Payzah API and documentation, including new endpoints, behaviour changes, deprecations, and breaking changes.

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.

<Note>
  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.
</Note>

## How to Read This Page

Each entry is tagged so you can tell at a glance whether it affects you:

| Tag            | Meaning                                                                |
| -------------- | ---------------------------------------------------------------------- |
| **Added**      | New endpoint, field, or capability. Safe to ignore until you need it   |
| **Changed**    | Existing behaviour modified in a backwards-compatible way              |
| **Fixed**      | A bug corrected. May change responses you were working around          |
| **Deprecated** | Still works, but scheduled for removal. Plan to migrate                |
| **Breaking**   | Requires a change on your side. Announced in advance wherever possible |
| **Docs**       | Documentation only. No API behaviour changed                           |

<Warning>
  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.
</Warning>

***

## August 2026

<Update label="August 2026" description="Documentation">
  **Docs** — Published a [Quickstart](/docs/getting-started/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/introduction).

  **Docs** — Published an [Arabic Quickstart](/docs/ar/quickstart) covering the same three-step sandbox payment flow.

  **Docs** — Published a [public sandbox API key](/docs/guides/test-credentials) 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/guides/refund).

  **Docs** — Published plugin installation guides for [Shopify](/docs/plugins/shopify), [WooCommerce](/docs/plugins/woocommerce), and [Odoo](/docs/plugins/odoo).

  **Docs** — Added a [Troubleshooting](/docs/guides/troubleshooting) page mapping every error code to a specific fix, and a [Go-Live Checklist](/docs/guides/go-live-checklist).

  **Docs** — Documented the [Refund API](/docs/guides/refund) in full, including success and failure responses and the `refund_type` values.
</Update>

***

## Reporting an Issue

Found behaviour that contradicts this documentation? Contact [Info@payzah.com](mailto:Info@payzah.com) with the `trackid`, the endpoint you called, and the full response body. Undocumented behaviour changes are treated as bugs.