Skip to main content
The Kira API is a REST platform for moving money. You create users and run them through KYC/KYB verification, open virtual accounts, send payouts, manage recipients, and receive webhook events for every state change. This site documents the integration end to end — start with the Quickstart, then explore the guides and the interactive API reference.

​
Base URLs

Kira serves two environments. The /sandbox prefix applies to every path in the sandbox environment. For example, the users endpoint is https://api.balampay.com/v1/users in production and https://api.balampay.com/sandbox/v1/users in sandbox.

​
Authentication

Every authenticated call carries two credentials:
  • x-api-key: <api_key> — your API key, on every request.
  • Authorization: Bearer <access_token> — a bearer token from POST /auth, valid for 3600 seconds.
POST /auth itself needs only the x-api-key header. Use the returned access_token as your bearer token on all other requests. See the Authentication guide for the full flow.

​
Response envelopes

Successful responses are wrapped in a consistent envelope:
Webhook events use a parallel shape, with event instead of message:
In prose: success responses use { message, data } and webhook payloads use { event, data }. See the Webhooks guide for delivery details and the event catalog.

​
Versioning

Send the X-Api-Version: 2026-04-14 header on every request — it always selects the documented schema, regardless of your account’s stored default. If your account default is 2026-04-14 or older, you can additionally pin once with POST /v1/versioning/upgrade { "target_version": "2026-04-14" } to make the header optional. Pins are forward-only: accounts already defaulting to a newer version keep using the header instead. See the Versioning guide.

​
Before you debug

The sandbox has documented gotchas — casing inconsistencies, field renames between request and response, tenant-scoped seed IDs, and more. Read the Known limitations & quirks guide before you spend an hour debugging.

​
Next steps

Quickstart

Authenticate, pin a version, and make your first call.

Authentication

The two-credential model and the token flow in depth.

Webhooks

Register an endpoint and handle event payloads.

API reference

Browse every endpoint interactively.