Getting Started with Kira API

Overview

This section covers the basics of getting started with the Kira API, including authentication and general concepts.

Prerequisites

Before you begin, you'll need:

  • Client ID - UUID provided by Kira
  • Password - Secret password provided by Kira
  • API Key - API key provided by Kira

Contact Kira support to obtain your credentials.

Quick Start

1. Authentication

Learn how to authenticate with the Kira API and obtain access tokens.

📖 Authentication Guide

Key topics:

  • Obtaining access tokens
  • Using Bearer tokens and API keys
  • Token expiration and refresh
  • Security best practices

2. Base URLs

EnvironmentBase URL
Productionhttps://api.balampay.com
Sandboxhttps://api.balampay.com/sandbox

3. Required Headers

All API requests (except /auth) require:

Authorization: Bearer YOUR_ACCESS_TOKEN
x-api-key: YOUR_API_KEY
Content-Type: application/json  # For POST/PUT requests

4. Authentication Example

# Authenticate
curl --location 'https://api.balampay.com/auth' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '{
    "client_id": "your-client-id",
    "password": "your-password"
  }'

# Response
{
  "access_token": "eyJhbGci...",
  "token_type": "Bearer",
  "expires_in": 3600
}

Next Steps

After authentication, you can:

  1. Manage Users - Create and manage users
  2. Create Virtual Accounts - Set up virtual accounts for users
  3. Set up Webhooks - Receive real-time notifications

Support