REST API

Build on Maicro

Access your customers, savings accounts, adashi groups, installment contracts and agreements programmatically. Simple REST endpoints, predictable responses, rate-limited by plan.

Quick start

1

Generate an API key

Go to Settings › API Keys in your dashboard. Create a key for the live or test environment.

2

Make a request

Pass your key in the X-API-Key header. All endpoints return JSON with a consistent success / error shape.

3

Handle the response

Check success === true, then read data. Paginated endpoints include a meta object with page, limit and total.

What you can access

Customer management

Create, read and update customer records including KYC status, contact details and tags.

Savings accounts

List accounts, retrieve balances and paginate through full transaction histories.

Adashi groups

Query rotating savings groups, member rosters and contribution records.

Installment contracts

Access Easy Buy contracts and their repayment schedules with overdue flags.

Agreements

Retrieve signed agreements and their party details, terms and status.

Disputes

List open disputes, create new ones and track resolution status.

Example request

Request

curl https://maicro.ng/api/v1/customers \
  -H "X-API-Key: mk_live_your_key_here" \
  -H "Accept: application/json"

Response

{
  "success": true,
  "data": [
    {
      "id": "cus_01j…",
      "customer_number": "C-0001",
      "name": "Amina Yusuf",
      "phone": "+2348000000000",
      "kyc_status": "verified",
      "created_at": "2026-01-15T10:00:00Z"
    }
  ],
  "meta": { "page": 0, "limit": 25, "total": 412 }
}

Ready to integrate?

Read the full API reference or try endpoints interactively in the playground.