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

# API Reference

> Full integrator API surface for the EQX Settlement Platform

The EQXPay API exposes REST endpoints over HTTPS. All requests must be authenticated with a Bearer token. See [Authentication](/authentication) for details.

## Base URL

```text theme={null}
Sandbox: https://sandbox.api.eqxpay.io
Production: https://api.eqxpay.io
```

## Request format

* **Content-Type**: `application/json` for all `POST` and `PATCH` requests
* **Authorization**: `Bearer <token>` on every request
* **Idempotency-Key**: Required on state-mutating operations (see [Authentication](/authentication))

## Response format

All responses are JSON. Successful responses return the resource or a list. Errors return the [standard error envelope](/errors).

## Sections

<CardGroup cols={2}>
  <Card title="Payouts" icon="money-bill-transfer" href="/api-reference/payouts/overview">
    Routes, quotes, and retail payout transactions to beneficiaries.
  </Card>

  <Card title="Autoconvert" icon="rotate" href="/api-reference/autoconvert/overview">
    On-deposit auto-conversion summary and credit history.
  </Card>

  <Card title="Onramp" icon="arrow-down-to-line" href="/api-reference/onramp/overview">
    Inbound on-chain funding events.
  </Card>

  <Card title="Beneficiaries" icon="user-group" href="/api-reference/beneficiaries/overview">
    Create and manage payout recipients.
  </Card>

  <Card title="Markets" icon="globe" href="/api-reference/markets/overview">
    Exchange rates and supported corridors.
  </Card>

  <Card title="Collections" icon="inbox" href="/api-reference/collections/overview">
    Inbound payment collections and market/rail discovery.
  </Card>

  <Card title="Checkout" icon="credit-card" href="/api-reference/checkout/overview">
    Hosted checkout sessions for payer-facing payment collection.
  </Card>

  <Card title="Deposits" icon="wallet" href="/api-reference/deposits/overview">
    On-chain deposit addresses and deposit history.
  </Card>

  <Card title="Risk" icon="shield-halved" href="/api-reference/risk/overview">
    Risk signals for compliance and fraud monitoring.
  </Card>

  <Card title="Auth" icon="key" href="/api-reference/auth/overview">
    Authentication, 2FA, token management, and user registration.
  </Card>
</CardGroup>