# Zeam API Gateway

> Developer documentation for the Zeam API Gateway, the single REST surface for registered integrators building on the Zeam platform.

## Docs

- [Production promotion](https://paytectechnologies.mintlify.app/access/production-promotion.md): How integrations move from the sandbox to live production access.
- [Sandbox](https://paytectechnologies.mintlify.app/access/sandbox.md): Build and test against the sandbox before you are promoted to production.
- [Issue an access token](https://paytectechnologies.mintlify.app/api-reference/auth/issue-an-access-token.md): Exchanges integrator client credentials for a bearer access token. Public (no bearer required). Proxies the Zeam Auth Service token endpoint.
- [Add a beneficiary](https://paytectechnologies.mintlify.app/api-reference/beneficiaries/add-a-beneficiary.md): Adds a beneficiary under the association resolved from the token.
- [List beneficiaries](https://paytectechnologies.mintlify.app/api-reference/beneficiaries/list-beneficiaries.md): Lists beneficiaries for the association resolved from the token.
- [List connectors](https://paytectechnologies.mintlify.app/api-reference/connectors/list-connectors.md): Discovers connectors for a corridor. The gateway translates this to the Connect GraphQL connectors query internally and returns a REST collection.
- [Get intent state](https://paytectechnologies.mintlify.app/api-reference/intents/get-intent-state.md): Returns the state of a transaction intent and its transactions.
- [Initiate a transaction intent](https://paytectechnologies.mintlify.app/api-reference/intents/initiate-a-transaction-intent.md): Initiates a transaction intent in the Transaction Service. The gateway injects origin=ApiGateway.
- [API reference](https://paytectechnologies.mintlify.app/api-reference/introduction.md): The complete /v1 integrator surface, generated from the gateway's OpenAPI contract.
- [Execute a payment intent](https://paytectechnologies.mintlify.app/api-reference/payments/execute-a-payment-intent.md): Submits a payment for execution via Hydra. The gateway maps the association to the integrator id and sets the required consumer header before calling Hydra ingest.
- [Create a quote](https://paytectechnologies.mintlify.app/api-reference/quotes/create-a-quote.md): Requests a strict send/receive quote for a connector and amount.
- [Create a wallet](https://paytectechnologies.mintlify.app/api-reference/wallets/create-a-wallet.md): Creates a wallet under the association resolved from the token. Any client-supplied associationId is rejected.
- [Get wallet balances](https://paytectechnologies.mintlify.app/api-reference/wallets/get-wallet-balances.md): Resolves the wallet's public key and returns its on-chain balances/trustlines.
- [List wallet transactions](https://paytectechnologies.mintlify.app/api-reference/wallets/list-wallet-transactions.md): Lists transactions for the wallet (resolved by its public key).
- [List wallets](https://paytectechnologies.mintlify.app/api-reference/wallets/list-wallets.md): Lists wallets for the association resolved from the token.
- [List webhooks](https://paytectechnologies.mintlify.app/api-reference/webhooks/list-webhooks.md): Lists webhook registrations for the association resolved from the token.
- [API keys](https://paytectechnologies.mintlify.app/authentication/api-keys.md): How application credentials are issued, and which header each one maps to.
- [Authentication](https://paytectechnologies.mintlify.app/authentication/overview.md): The two-factor model that protects every gateway request: a bearer token plus your application secret.
- [Access tokens](https://paytectechnologies.mintlify.app/authentication/tokens.md): Issue a short-lived bearer token, use it, and refresh it by re-issuing.
- [Changelog](https://paytectechnologies.mintlify.app/changelog.md): User-visible changes to the Zeam API Gateway and its documentation.
- [API concepts](https://paytectechnologies.mintlify.app/concepts.md): How the gateway authenticates you, scopes your data, and normalizes the platform behind one REST contract.
- [Make your first transaction](https://paytectechnologies.mintlify.app/guides/make-your-first-transaction.md): An end-to-end path from sandbox credentials to an executed payment with status tracking.
- [Zeam API Gateway](https://paytectechnologies.mintlify.app/introduction.md): One REST API for registered integrators to move money on the Zeam platform.
- [Conventions](https://paytectechnologies.mintlify.app/platform/conventions.md): Base URLs, versioning, field formats, and the headers shared by every endpoint.
- [Errors](https://paytectechnologies.mintlify.app/platform/errors.md): Every error uses the RFC 7807 problem format. Classify by HTTP status, not the body.
- [Pagination](https://paytectechnologies.mintlify.app/platform/pagination.md): List endpoints return cursor-paginated collections with a stable wrapper.
- [Rate limits](https://paytectechnologies.mintlify.app/platform/rate-limits.md): How the gateway signals rate limiting and how to back off.
- [Quickstart](https://paytectechnologies.mintlify.app/quickstart.md): Issue an access token and make your first authenticated call against the sandbox.
- [Glossary](https://paytectechnologies.mintlify.app/resources/glossary.md): Core terms used across the Zeam API Gateway documentation.
- [Support](https://paytectechnologies.mintlify.app/resources/support.md): How to get help, request access, and report issues.
- [Webhooks](https://paytectechnologies.mintlify.app/webhooks/overview.md): Receive payment-intent updates at your own endpoint, registered through the Zeam business portal.

## OpenAPI Specs

- [openapi](https://paytectechnologies.mintlify.app/api-reference/openapi.yaml)