> ## Documentation Index
> Fetch the complete documentation index at: https://test-docs.upayments.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> REST API for programmatic access to FinMI

# API Overview

FinMI provides a REST API for programmatic access to your payment data.

## Base URL

```
https://app.finmi.io/api
```

## Authentication

All API requests require authentication via session cookie (for browser requests) or API key (for server-to-server).

<Info>
  Public API key access is available on the Scale tier. See **Settings → API Keys** to generate keys.
</Info>

## Response Format

All endpoints return JSON:

```json theme={null}
{
  "data": { ... },
  "error": null
}
```

Error responses:

```json theme={null}
{
  "error": "Human-readable error message"
}
```

## Rate Limits

| Tier    | Rate Limit            |
| ------- | --------------------- |
| Lite    | 60 requests/minute    |
| Starter | 120 requests/minute   |
| Growth  | 300 requests/minute   |
| Scale   | 1,000 requests/minute |

## Common HTTP Status Codes

| Code | Meaning                              |
| ---- | ------------------------------------ |
| 200  | Success                              |
| 201  | Created                              |
| 400  | Bad request (invalid parameters)     |
| 401  | Unauthorized (not logged in)         |
| 403  | Forbidden (insufficient permissions) |
| 404  | Not found                            |
| 429  | Rate limited                         |
| 500  | Server error                         |