> ## 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.

# Zeam API Gateway

> One REST API for registered integrators to move money on the Zeam platform.

The Zeam API Gateway is the single, REST-based front door to the Zeam platform.
It gives registered integrators one base URL and one credential set to manage
wallets, discover payment corridors, quote and execute payments, and receive
status updates, without having to learn the internal Zeam services behind it.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Issue an access token and make your first authenticated call.
  </Card>

  <Card title="Authentication" icon="shield-check" href="/authentication/overview">
    How tokens, the application secret, and association scoping work.
  </Card>

  <Card title="Start in the sandbox" icon="flask-conical" href="/access/sandbox">
    Test end to end before you request production access.
  </Card>

  <Card title="API reference" icon="terminal" href="/api-reference/introduction">
    Every endpoint, request, and response, generated from the contract.
  </Card>
</CardGroup>

## What the gateway is

Zeam runs several internal services for authentication, business data, currency
connectors, transactions, and payments. The gateway puts a single, stable REST
contract in front of them. It verifies your access token, resolves the
**association** (the Zeam business tenant) your application belongs to, and
proxies or orchestrates the work downstream. You integrate against one contract,
and Zeam can evolve its internals without breaking you.

Every response uses the same conventions: camelCase JSON, cursor pagination,
[RFC 7807 errors](/platform/errors), and an `X-Request-Id` for support
correlation.

## Who it is for

The gateway is built for **server-side, machine-to-machine** integrations.
Callers authenticate with application credentials, not a human login. This is
not an end-user mobile API.

Each integration is onboarded as an **application** bound to exactly one
**association**. Every request is scoped to that association, and one
application can never read or change another association's data.

## What you can do

In this first release, the gateway exposes a focused set of capabilities:

* **Wallets**: list wallets, create a wallet, and read a wallet's balances and
  transactions.
* **Beneficiaries**: list and add beneficiaries for your association.
* **Connectors**: discover the payment connectors available for a corridor.
* **Quotes**: request a send or receive quote for a connector and amount.
* **Intents and payments**: initiate a transaction intent, execute it as a
  payment, and read its state.
* **Webhooks**: list the webhook registrations for your association.

<Info>
  You register webhook endpoints in the Zeam business portal, not through the
  gateway. The gateway lets you **list** your registrations. See
  [Webhooks](/webhooks/overview).
</Info>

## Start in the sandbox

Integrations begin in the sandbox. Use it to build and test against real
contracts and flows before you are promoted to production after validation and
operational readiness. See [Sandbox](/access/sandbox) and
[Production promotion](/access/production-promotion).

## How it works

A request carries your access token and application secret. The gateway verifies
the token, attaches your association, and calls the right downstream service,
returning a clean REST response. Read [API concepts](/concepts) for the full
picture.

<Note>
  Digital assets, including regulated crypto assets, are subject to risks such as
  price volatility. They do not typically have legal tender status and are not
  covered by deposit protection insurance. Transacting in digital assets may not
  be suitable for everyone.
</Note>