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

# Conventions and errors

> Shared request patterns, pagination behavior, and error handling conventions used across the FinSync API.

# Conventions and errors

## Base URL

Production examples in this portal use `https://finsync.ar`. Individual operations live under `/api/...`.

## Request and response format

* Request bodies are JSON unless noted otherwise.
* Response payloads are JSON for the documented operational endpoints.
* IDs are typically integer database identifiers.

## Pagination

Several list endpoints accept `page` and `pageSize`.

Example:

```bash theme={null}
curl --request GET \
  --url "https://finsync.ar/api/operations?page=1&pageSize=25" \
  --header "x-api-key: YOUR_API_KEY"
```

Some endpoints may return different shapes depending on whether pagination parameters were supplied. The generated API reference documents those response details per route.

## Common error patterns

Expect standard HTTP status codes such as:

* `400` for validation or payload issues.
* `401` for missing or invalid authentication.
* `404` when a referenced resource does not exist.
* `500` for unexpected server errors.

Many endpoints return a JSON object with an `error` field for non-success responses.

## Operational conventions

* Operations can include multiple transactions.
* Approval and cancellation routes usually require pending transactions.
* Manual balance adjustments support either an absolute balance or a delta, depending on the request body.

When building automation or AI-assisted workflows, combine this page with the endpoint-specific schemas in the API reference to avoid assuming one response shape across all routes.