For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Reference

Every KiiChain Pay backend endpoint, plus the official Postman collection.

This section documents every endpoint of the KiiChain Pay backend API. Endpoints are grouped by module.

Both this reference and the Postman collection are regenerated automatically on every KiiChain Pay backend release.

Generating API keys covers authentication and request signing. The Guides walk through full on-ramp, off-ramp, FX and DEX flows end to end.

Try it in Postman

You can explore the API in the KiiChain Pay Backend Postman collection. It has every endpoint in this reference, ready to run, with signing already wired up.

What you get:

  • Requests grouped by RPC server. Folders follow the service boundaries — one per <Module>QueryServer (reads) and <Module>MsgServer (writes). Example: UsersQueryServer, TicketsMsgServer — so each folder maps into a module in this reference.

  • Signing handled for you. A pre-request script computes the Ed25519 signature for every write request (POST/PATCH/PUT/DELETE) from your environment's api_key and priv_key, following the scheme described in Sign write requests. No manual x-timestamp / x-signature headers needed.

  • A ready-made environment. Fork it alongside the collection and fill in:

Variable
Value

base_url

https://backend.pay.kiichain.io (production), or the staging base URL.

api_key

Your api_key from Generating API keys.

priv_key

Your priv_key — the pre-request script uses this to sign write requests.

Getting started

  1. Fork the collection and its environment into your own Postman workspace (top-right Fork button on each).

  2. Open the forked environment, select it as active, and fill in api_key, and priv_key.

  3. Send a read request first (You can try Me at UsersQueryServer) to confirm your API key is valid.

  4. Send a write request (Anything with *MsgServer). The pre-request script signs it automatically.

Last updated