> ## Documentation Index
> Fetch the complete documentation index at: https://developer.arltechgroup.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Arltech Finance API — PayGo device financing for Uganda

## Overview

The Arltech Finance API lets you integrate with EasyOwn's PayGo lending platform. Use it to manage the full customer lifecycle — from registration and approval through monthly payments and device locking — without accessing the EasyOwn admin interface directly.

<CardGroup cols={2}>
  <Card title="Production" icon="server">
    `https://api.arltechgroup.com`
  </Card>

  <Card title="UAT" icon="flask">
    `https://developer-uat.arltechgroup.com`
  </Card>

  <Card title="URL Prefix" icon="link">
    All endpoints start with `/finance/`
  </Card>

  <Card title="Format" icon="brackets-curly">
    All requests and responses are `application/json`
  </Card>

  <Card title="Auth" icon="key">
    JWT — pass token in `x-access-token` header
  </Card>
</CardGroup>

## Customer lifecycle

```
Register → Approve → [IMEI Enrolled → LOCKED] → Payments → ENABLED → Paid off
```

| Stage            | Deal status   | Description                                    |
| ---------------- | ------------- | ---------------------------------------------- |
| Registration     | `LOCKED`      | Customer and CustomerDeal created              |
| Approval         | `APPROVED`    | Salesstage set to `ENROLLMENT`                 |
| IMEI enrolled    | `LOCKED`      | PT Interface registers device; PayGo active    |
| Payment received | `ENABLED`     | Device unlocked until next payment date        |
| Repossessed      | `REPOSSESSED` | Contract terminated; device locked permanently |

## Rate limiting

There are no hard rate limits on the API, but please avoid hammering collection endpoints — `generateCollectionCalls` in particular does a full portfolio scan.
