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

# API reference

> Every endpoint an API key can call, generated from the API's own code.

The pages in this section are generated from the Payve API's controllers and request models. Each one lists the method, path, parameters and request body for an endpoint.

For worked examples, response fields and failure cases, read the guide for each area. The reference tells you what an endpoint accepts. The guides tell you how to use it.

## Base URL

```text
https://api.payvehq.com
```

Every path starts with `/v1`. The sandbox is at `https://sandbox.api.payvehq.com`. See [Environments](/get-started/environments.md).

## Authentication

Send your secret key in the `x-api-key` header. See [Authentication](/get-started/authentication.md).

```bash
curl "https://api.payvehq.com/v1/wallets" \
  -H "x-api-key: $PAYVE_API_KEY"
```

Two endpoints need no key: `GET /v1/currencies` and `GET /v1/rates`.

## Conventions

| Topic | Rule | More |
| - | - | - |
| Amounts | Integers in minor units in requests. Strings of digits in responses. | [Requests and responses](/essentials/requests-and-responses.md#amounts) |
| Ids | Numeric `id` in payout, pay-in and conversion URLs. Prefixed ids elsewhere. | [Ids](/essentials/requests-and-responses.md#ids) |
| Idempotency | `Idempotency-Key` is required on payouts, pay-ins and conversions. | [Idempotency](/essentials/idempotency.md) |
| Responses | Results are wrapped in `data`. | [Responses](/essentials/requests-and-responses.md#responses) |
| Errors | An `error` object with a `code`. | [Errors](/essentials/errors.md) |
| Pagination | `cursor` and `limit` on the main lists. | [Pagination](/essentials/requests-and-responses.md#pagination) |
| Rate limit | 200 requests per minute per IP address. | [Rate limits](/essentials/rate-limits.md) |

## Endpoints by area

| Area | Guide | Scope needed to write |
| - | - | - |
| Quotes | [Quotes](/guides/quotes.md) | None |
| Payouts | [Payouts](/guides/payouts.md) | `payouts:write` |
| Pay-ins | [Pay-ins](/guides/payins.md) | None |
| Payment links | [Payment links](/guides/payment-links.md) | `payins:write` |
| Conversions | [Conversions](/guides/conversions.md) | `conversions:write` |
| Wallets | [Wallets](/guides/wallets.md) | None |
| Beneficiaries | [Beneficiaries](/guides/beneficiaries.md) | `beneficiaries:write` |
| Refunds | [Refunds](/guides/refunds.md) | `payouts:write` |
| Statements | [Statements](/guides/statements.md) | Read only by API key |
| Webhooks | [Webhooks](/webhooks/overview.md) | Read only by API key |

Reading needs no particular scope. Any valid key can call the `GET` endpoints for its own account.

> [!NOTE]
>
> These pages show endpoints without a "send request" console, so that nobody moves live money from
> a documentation page by accident. Use cURL or your own code.

## Not in this reference

Endpoints the dashboard uses, such as creating API keys and managing webhook endpoints, need a dashboard session and are not part of the public API.
