Skip to main content

API Keys

API keys authenticate your requests to the Ikawaari API.

Key Types

PrefixEnvironmentPurpose
ik_test_SandboxTesting and development
ik_live_LiveProduction transactions

Create an API Key

  1. Go to Developers → API Keys
  2. Click Create API key
  3. Name your key and select scopes
  4. Copy the full key — it's only shown once
warning

Store your API keys securely. Never expose them in client-side code, public repositories, or logs.

Key Scopes

Control what each API key can access:

ScopeDescription
payments:readView payments
payments:writeCreate and manage payments
customers:readView customers
customers:writeCreate and manage customers
webhooks:readView webhooks
webhooks:writeCreate and manage webhooks
refunds:writeIssue refunds
reports:readView reports

See API Key Scopes for the full list.

Roll a Key

If a key is compromised, roll it to generate a new one while revoking the old:

  1. Go to Developers → API Keys
  2. Click the menu on the key
  3. Select Roll key

The old key is immediately revoked and a new one is generated.

Rate Limits

Each API key has a configurable rate limit (default: 100 requests/minute). See Rate Limits.