Overview

Freedom Pay API documentation: accept payments, make payouts, save cards and work with invoices.

Choose your API in «Which API to use» and start with its Overview: it describes the request format, the signature and the errors.

The host depends on the country: choose the region in the URL bar of a method, for example https://api.freedompay.kz.

API	What it is for	PCI DSS certificate
Gateway API	Payments with card data collected on your side, server to server. Two APIs: Sync API and Async API.	Required
Merchant API	Payments on the Freedom Pay payment page or in a payment frame, payouts, saved cards, payments from the mobile balance, invoices. The client enters card data on Freedom Pay pages.	Not required
Partner API	For Freedom Pay partners: clients and terminals, e-money wallets, payment orders and account statements, exchange rates. To connect, contact your account manager.	—

Ready-made plugins for online stores (WordPress, Tilda, OpenCart and others): see CMS.

Get the merchant ID and the secret key in your personal account: see Get Merchant ID and key.

Read the Overview of your API and sign every request as described there.

Test the integration in test mode: see «Test mode» in Gateway API Overview or Merchant API Overview.

Receive the result of payments and payouts on your server: see Callbacks Overview.

To check that the API is available, send GET {domain}/status/healthcheck, for example https://api.freedompay.kz/status/healthcheck.

The request needs no signature.

status = ok means that the API is available.

Response example:

{"status": "ok", "time": "2026-11-02T05:20:49+00:00"}

Field	Type	Description
`status`	string	State of the API: `ok` — available.
`time`	string	Time of the answer in UTC, ISO 8601.

For the full list of error codes, see Error codes.

If you find an inaccuracy in the documentation or need help with the integration, write to support@freedompay.kz.

For connection and merchant settings, contact your account manager.