Skip to main content

API Reference

Ikawaari currently exposes multiple implemented API route families.

Examples include:

  • https://api.ikawaari.com/payment_intents
  • https://api.ikawaari.com/webhook_endpoints
  • https://api.ikawaari.com/api/v1/merchant/*
  • https://api.ikawaari.com/api/v1/escrow/*
  • https://api.ikawaari.com/api/v1/billing/*
  • https://api.ikawaari.com/api/checkout/*

Start with Route Families to understand how the implemented platform surface is organized.

Authentication​

Authentication depends on the route family and caller type. Common auth mechanisms include:

  • Bearer API keys
  • Merchant JWT tokens
  • App tokens

Typical examples use a Bearer token header:

Authorization: Bearer ik_test_your_key_here

Request Format​

  • Content-Type: application/json
  • All amounts are in the smallest currency unit (e.g., 5000 = 5,000 XOF)
  • Dates are ISO 8601 or Unix timestamps

Response Format​

All responses return JSON. Successful responses include the resource object directly. Errors follow this format:

{
  "error": {
    "code": "error_code",
    "message": "Human-readable description",
    "type": "error_type"
  }
}

Pagination​

Pagination behavior depends on the endpoint family. Some list endpoints use simple limit parameters and some merchant endpoints use page-based pagination.

Example:

GET /payment_intents?limit=10
ParameterDescription
limitNumber of items returned by supported list endpoints
pagePage number for supported merchant list endpoints

Idempotency​

For POST requests, include an Idempotency-Key header to safely retry requests:

curl -X POST https://api.ikawaari.com/payment_intents \
  -H "Authorization: Bearer ik_test_your_key" \
  -H "Idempotency-Key: unique-request-id-123" \
  -H "Content-Type: application/json" \
  -d '{"amount": 5000, "currency": "XOF"}'

Route Families​

Core route families​

Supporting route families​

  • Merchant APIs under api/v1/merchant/*
  • Checkout APIs under api/v1/checkout/* and api/checkout/*
  • Product module APIs under api/v1/escrow/*, api/v1/billing/*, api/v1/marketplace/*, and others

Resources​

Core​

Billing​

Connect​