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

# Backend API Overview

> Projects, networks, transactions, widgets, and callbacks

The Redf Backend API exposes the HTTP endpoints used to configure payment projects and run on-chain transaction flows.

## What Is Included

The API includes:

* health monitoring with `/api/health`;
* network and currency discovery with `/api/networks` and `/api/networks/{network_id}/currencies`;
* project lifecycle management with `/api/projects` and related settings and stats endpoints;
* transaction creation, lookup, callbacks, and redirects;
* widget-based payment entry with `/api/widgets`.

## Guide Map

Start with the pages below before diving into the endpoint reference:

* [Quickstart](/pay/quickstart): end-to-end first integration path.
* [Networks, Currencies, and Projects](/pay/currency): discover supported values before project creation.
* [Project Management](/pay/projects): create, update, inspect, and delete projects.
* [Authentication and Signed Requests](/pay/signature): understand the protected HMAC-based flow.
* [Transaction Lifecycle](/pay/transactions): create, list, inspect, redirect, and monitor transactions.
* [Callbacks, Widgets, and Redirects](/pay/callbacks): delivery and hosted-flow behavior.
* [Errors and Operational Notes](/pay/errors): how to handle failures and validation responses.

## Recommended Flow

1. Discover a supported network and currency.
2. Create a project and store the returned `secret_key` securely.
3. Create transactions with either the signed or unsigned flow.
4. Track settlement with status, info, redirect, and callback endpoints.
5. Use project stats and wallet lookup endpoints for operations and reporting.

<Note>
  The API reference in this section is generated directly from `OPENAPI.yaml`, so endpoint details stay aligned with the backend specification.
</Note>