Areye Developer API — Documentation

Authentication

The Areye Business API uses API key authentication. Include your key in the X-Business-API-Key header on every request. You can find and rotate your key in the Business Portal under Settings & API.

Request Header

X-Business-API-Key: your_api_key_here

Keep your API key secret. Never expose it in client-side code or public repositories. Use environment variables. Rotate your key immediately from the Business Portal if you suspect it has been compromised.

Endpoints

All paths are relative to the base URL https://api.areye.app/api. Every request is authenticated with your X-Business-API-Key unless marked public.

Bookings & Trips

POST /business/book Book a ride, parcel, cargo or airport transfer on behalf of an employee or guest — supports scheduling and up to 3 stops

GET /business/trips List all trips (filter by date range, employee, status, service type)

GET /business/trips/active List trips currently in progress

GET /business/trips/{id} Retrieve a single trip with receipt and route details

POST /business/trips/{id}/cancel Cancel a trip before driver assignment (full refund to wallet)

GET /business/trips/{id}/waybill Download the printable waybill for a delivery

GET /trip-track/{reference} Public shareable tracking link — no authentication required

Batches & Subscriptions

POST /business/batches Submit a bulk delivery batch (segment: parcel or cargo, up to 50 stops)

GET /business/batches List batches with per-stop status

GET /business/batches/{id} Retrieve a single batch with all stops

POST /business/subscriptions Create a recurring delivery (parcel/cargo, days of week, pickup time)

GET /business/subscriptions List recurring delivery subscriptions

PATCH /business/subscriptions/{id}/{action} Pause, resume or cancel a subscription

Car Rental & Fleet

GET /business/rentals/vehicles List your rental fleet with rates, deposits and availability

POST /business/rentals/vehicles Add a vehicle to your rental fleet (photos, daily rate, km limits)

POST /business/rentals/vehicles/bulk Bulk-add vehicles to your fleet

PATCH /business/rentals/vehicles/mode Bulk-set listing mode (rental / ride-hailing / both)

PATCH /business/rentals/vehicles/{id} Update a vehicle — rates, deposit, marketplace publishing

DELETE /business/rentals/vehicles/{id} Remove a vehicle from your fleet

GET /business/rentals/bookings List rental bookings against your fleet

POST /business/rentals/bookings Create a rental booking (self-drive or chauffeured)

PATCH /business/rentals/bookings/{id}/{action} Confirm, complete or cancel a rental booking

Rent-to-Own & Driver Applications

GET /business/rto List rent-to-own agreements against your vehicles

POST /business/rto Create a rent-to-own agreement (earnings-skim or direct-pay, chosen cadence)

POST /business/rto/{id}/payments Record an instalment payment toward an agreement

GET /business/fleet-applications List driver applications for your marketplace-published vehicles

PATCH /business/fleet-applications/{id}/{action} Approve or reject a driver application (assigns the vehicle / opens the agreement)

Wallet, Payouts & Billing

GET /business/wallet Get current wallet balance and billing type

GET /business/wallet/transactions List wallet transactions (debits, credits, top-ups)

POST /business/wallet/topup Initiate a wallet top-up via a payment gateway

GET /business/wallet/topup/{ref}/status Poll the status of a wallet top-up

GET /business/payment-gateways List available payment gateways for your zone

GET /business/payouts List earnings payout requests

POST /business/payouts Request a payout of positive earnings

DELETE /business/payouts/{id} Cancel a pending payout request

GET /business/billing/statements List monthly billing statements

People, Groups & Coupons

GET /business/people List all employees and their spending limits

POST /business/people Invite an employee to your business account

PATCH /business/people/{id} Update employee details, group or spending limit

DELETE /business/people/{id} Remove an employee from your account

GET /business/groups List groups for organising employees

POST /business/groups Create a group

GET /business/coupons List employee discount coupons

POST /business/coupons Issue a new coupon (fixed or percent)

PATCH /business/coupons/{id}/deactivate Revoke a coupon

Reference Data

GET /business/vehicle-types List vehicle types with live pricing and availability

GET /business/parcel-sizes List parcel size tiers with rates

GET /business/zones List active service zones

Account

GET /business/profile Retrieve your business account profile and settings

PATCH /business/profile Update company name, billing contact, webhook URL or low-balance threshold

GET /business/api-key Retrieve API key metadata

POST /business/api-key/regenerate Rotate your API key (previous key invalidated immediately)

GET /business/dashboard Aggregate account metrics — trips, spend, active employees

Example: Book a ride for an employee

POST /api/business/book

curl -X POST https://api.areye.app/api/business/book \
  -H "X-Business-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "ride",
    "passenger_name": "Jane Smith",
    "passenger_phone": "+267XXXXXXXX",
    "pickup_address": "Plot 64271, Block 3 Industrial, Gaborone",
    "pickup_lat": -24.6282,
    "pickup_lng": 25.9231,
    "dropoff_address": "Molapo Crossing Mall, Gaborone",
    "dropoff_lat": -24.6540,
    "dropoff_lng": 25.9110,
    "vehicle_type_id": 1,
    "expense_code": "TRAVEL-Q3"
  }'

201 Created — Response

{
  "success": true,
  "data": {
    "reference": "ARY-8F3A21",
    "status": "pending",
    "type": "ride",
    "fare": 85.00,
    "currency": "BWP",
    "tracking_url": "https://api.areye.app/api/trip-track/ARY-8F3A21"
  }
}

Booking a delivery instead? Set "type": "parcel" or "cargo" and add recipient details. Track any booking via the returned reference.

Webhooks

Set your webhook URL in Business Portal → Settings & API. Areye signs every payload — verify the X-Areye-Signature header (HMAC-SHA256 of the raw body using your webhook secret) before processing to confirm the event originated from Areye. The event name is also sent in the X-Areye-Event header.

Event	Description
`trip.completed`	A trip booked under your account completed — final fare, receipt and route data available
`coupon.redeemed`	An employee redeemed a discount coupon on a trip
`wallet.low_balance`	Wallet balance fell below your configured threshold
`fleet.application.received`	A driver applied for one of your marketplace-published vehicles

Rate Limits

The Business API operates on a fair-use basis suitable for normal booking and fleet-management workloads. If you are planning high-volume or bulk automation, contact our team so we can provision the right limits for your account. Endpoints that trigger external payment gateways may apply stricter per-minute limits.

Errors

Areye uses standard HTTP status codes. Responses are JSON with a success flag and, on failure, a human-readable message.

Status	Meaning
200	Success
201	Created — resource was successfully created
401	Unauthorized — missing or invalid API key
403	Forbidden — your account does not have this feature enabled
404	Not Found — resource does not exist
422	Unprocessable — validation failed, insufficient wallet balance, or credit limit exceeded
429	Too Many Requests — rate limit exceeded
500	Internal Server Error — contact support

SDKs & Libraries

Official SDKs are under development. In the meantime, use the REST API directly with your preferred HTTP client.

JavaScript / Node.js

Coming Q3 2026

Python