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

# API reference

> The complete /v1 integrator surface, generated from the gateway's OpenAPI contract.

This reference documents the `/v1` REST surface of the Zeam API Gateway. Each
endpoint page is generated from the gateway's OpenAPI contract and includes an
interactive playground.

## Base URLs

* Sandbox: `https://api.dev.zeam.paytec.io/v1`
* Production: `https://api.zeam.app/v1`

## Authentication

Every endpoint except `POST /auth/token` requires both headers:

```http theme={null}
Authorization: Bearer <access token>
x-zeam-auth: <application secret>
```

See [Authentication](/authentication/overview) for how to obtain and use these.

## Conventions

* Requests and responses are JSON with camelCase fields.
* Collections are [cursor-paginated](/platform/pagination).
* Errors use the [RFC 7807 problem format](/platform/errors); branch on the HTTP
  status.
* Every response carries an `X-Request-Id`.

## Endpoint groups

The endpoints are grouped in the sidebar:

* **Auth**: issue an access token.
* **Wallets**: list and create wallets; read balances and transactions.
* **Beneficiaries**: list and add beneficiaries.
* **Connectors**: discover connectors for a corridor.
* **Quotes**: request a send or receive quote.
* **Intents**: initiate a transaction intent and read its state.
* **Payments**: execute a payment intent.
* **Webhooks**: list your webhook registrations.

<Note>
  `GET /healthz` is an operational readiness probe and is intentionally excluded
  from this reference, which covers only the `/v1` integrator surface.
</Note>