Quick Start Guide

Get started with the Kasi Collections API in minutes

Quick Start Guide

Get up and running with the Kasi Collections API quickly. Follow these steps to test the API and start integrating.

Prerequisites

API credentials (contact integrations@kasi.money)
Base URL: https://api.kasipayments.co.za/v1
Your API key

Step 1: Create a Test Policy

Create a single policy to test the API:

curl -X POST https://api.kasipayments.co.za/v1/policies \
  -H "X-API-Key: your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "policy_number": "TEST001",
    "customer_id": "CUST001",
    "external_customer_ref": "EXT001",
    "product_code": "FUNERAL_01",
    "collection_amount": 150.00
  }'

Expected Response:

{
  "id": "uuid-here",
  "policy_number": "TEST001",
  "status": "active",
  "created_at": "2025-11-26T10:00:00Z"
}

Step 2: Import Bulk Policies

Create a CSV file with test policies:

customer_id,external_customer_ref,policy_number,product_code,collection_amount
CUST001,EXT001,POL001,FUNERAL_01,150.00
CUST002,EXT002,POL002,FUNERAL_01,200.00

Import the policies:

curl -X POST https://api.kasipayments.co.za/v1/policies/import \
  -H "X-API-Key: your-key" \
  -F "file=@policies.csv"

Expected Response:

{
  "imported": 2,
  "failed": 0,
  "errors": []
}

Step 3: Execute Collections

Trigger collections for a test period:

curl -X POST https://api.kasipayments.co.za/v1/collections/execute \
  -H "X-API-Key: your-key" \
  -H "Content-Type: application/json" \
  -d '{"period_month": "2025-11"}'

Expected Response:

{
  "execution_id": "exec_123",
  "status": "processing",
  "policies_queued": 2
}

Step 4: Query Collection Status

Check the status of a collection (use the collection ID from the execution response):

curl https://api.kasipayments.co.za/v1/collections/{collectionId} \
  -H "X-API-Key: your-key"

Expected Response:

{
  "id": "coll_123",
  "period_month": "2025-11",
  "collection_status": "PAID_FULL",
  "collection_amount_collected": 150.00,
  "number_of_attempts": 1
}

Step 5: Export Results

Export collection results as CSV:

curl "https://api.kasipayments.co.za/v1/reports/collections?period_month=2025-11&format=csv" \
  -H "X-API-Key: your-key" \
  -o results.csv

Expected Output: CSV file with collection results.

Step 6: Generate Settlement

Create a settlement statement:

curl -X POST https://api.kasipayments.co.za/v1/settlements \
  -H "X-API-Key: your-key" \
  -H "Content-Type: application/json" \
  -d '{"period_month": "2025-11"}'

Expected Response:

{
  "settlement_number": "SETTLE-2025-11-001",
  "period_month": "2025-11",
  "total_collections": 350.00,
  "net_amount": 231.44,
  "payment_date": "2025-12-03",
  "status": "pending"
}

Getting Started Checklist

Next Steps

Explore the Full API Reference for interactive documentation
Read about Monthly Workflows for production setup
Check out Use Cases for real-world examples
Review Technical Details for security and error handling

Need Help?

Email: integrations@kasi.money
Documentation: Browse all sections in the sidebar
API Reference: Visit the interactive API docs

Fee Structure

Understanding fees and calculations

Technical Details

Security, error handling, data formats, and architecture

Quick Start Guide

On this page