# Zeam API

> Developer documentation for the Zeam platform — cross-border payments, wallet management, and financial connectivity.

## Docs

- [Add payment destination](https://docs.zeam.money/api-reference/business/add-payment-destination.md): The first destination of a given method is auto-promoted to primary when no existing destination carries that method.
- [Available connectors for a beneficiary](https://docs.zeam.money/api-reference/business/available-connectors-for-a-beneficiary.md): Orchestrates beneficiary lookup (Business API) + connector discovery (Connect GraphQL) to find Connect routes usable for the specified beneficiary's payment destination.
- [Bulk create beneficiaries](https://docs.zeam.money/api-reference/business/bulk-create-beneficiaries.md): Each beneficiary is processed independently — individual failures do not roll back the rest of the batch. Response includes a per-row result array.
- [Create a wallet](https://docs.zeam.money/api-reference/business/create-a-wallet.md)
- [Create beneficiary](https://docs.zeam.money/api-reference/business/create-beneficiary.md): Body forwarded verbatim. Minimum required: `beneficiary_type` plus `first_name`/`last_name` (Individual) or `company_name` (Business).
- [Delete beneficiary](https://docs.zeam.money/api-reference/business/delete-beneficiary.md): Hard delete — cascades to detail rows, payment destinations, addresses, and tags.
- [Delete payment destination](https://docs.zeam.money/api-reference/business/delete-payment-destination.md)
- [Get asset by ID](https://docs.zeam.money/api-reference/business/get-asset-by-id.md)
- [Get asset DTO by ID](https://docs.zeam.money/api-reference/business/get-asset-dto-by-id.md)
- [Get association by ID](https://docs.zeam.money/api-reference/business/get-association-by-id.md)
- [Get beneficiary](https://docs.zeam.money/api-reference/business/get-beneficiary.md)
- [Get wallet by ID](https://docs.zeam.money/api-reference/business/get-wallet-by-id.md)
- [Get wallet DTO by ID](https://docs.zeam.money/api-reference/business/get-wallet-dto-by-id.md)
- [List all assets](https://docs.zeam.money/api-reference/business/list-all-assets.md): Returns all assets enriched with bridge data.
- [List all associations](https://docs.zeam.money/api-reference/business/list-all-associations.md): Returns all associations visible to the authenticated caller.
- [List all wallets](https://docs.zeam.money/api-reference/business/list-all-wallets.md)
- [List asset DTOs](https://docs.zeam.money/api-reference/business/list-asset-dtos.md): Returns minimal `AssetDTO` records for assets that have at least one active instance. Prefer this over the full asset list when you only need symbol / contract / issuer.
- [List beneficiaries](https://docs.zeam.money/api-reference/business/list-beneficiaries.md): Supports `search`, `beneficiary_type`, and `payment_method` query filters.
- [List beneficiary tags](https://docs.zeam.money/api-reference/business/list-beneficiary-tags.md)
- [List payment destinations](https://docs.zeam.money/api-reference/business/list-payment-destinations.md)
- [List wallet types](https://docs.zeam.money/api-reference/business/list-wallet-types.md)
- [List wallets by association](https://docs.zeam.money/api-reference/business/list-wallets-by-association.md): Returns wallets belonging to the specified association.
- [Replace beneficiary tags](https://docs.zeam.money/api-reference/business/replace-beneficiary-tags.md): Replace-style — the tag array in the body overwrites the existing set.
- [Set primary payment destination](https://docs.zeam.money/api-reference/business/set-primary-payment-destination.md): Marks the destination as primary for its method. Any prior primary for the same method is unset automatically.
- [Swap Quote](https://docs.zeam.money/api-reference/business/swap-quote.md): Returns a path-payment quote. Both `fromAsset` and `toAsset` are required and must differ.
- [Update beneficiary](https://docs.zeam.money/api-reference/business/update-beneficiary.md): Replace-style update — all child collections (details, payment destinations, addresses, tags) are deleted and recreated from the request body. Send the full intended state.
- [Update payment destination](https://docs.zeam.money/api-reference/business/update-payment-destination.md)
- [Update wallet](https://docs.zeam.money/api-reference/business/update-wallet.md)
- [Connect platform health](https://docs.zeam.money/api-reference/connect/connect-platform-health.md): Returns the health status of the Connect platform.
- [Execute a payment](https://docs.zeam.money/api-reference/connect/execute-a-payment.md): Unified execute surface. When `TRANSACTIONS_URL` is configured the gateway first calls transaction/init to obtain a reference, injects it as `reference` in the body, then proxies to Connect `/offramp`.
- [Execute an off-ramp](https://docs.zeam.money/api-reference/connect/execute-an-off-ramp.md): Proxies to Connect `/offramp`.
- [Execute an on-ramp](https://docs.zeam.money/api-reference/connect/execute-an-on-ramp.md): Proxies to Connect `/onramp`.
- [Get a directional payment quote](https://docs.zeam.money/api-reference/connect/get-a-directional-payment-quote.md): Creates a quote for the specified direction (`send` or `receive`). Returns 402 Payment Required on success (documented convention).
- [Get a payment quote](https://docs.zeam.money/api-reference/connect/get-a-payment-quote.md): Fixed alias for the `quote/send` direction. Use this when you want a direction-free quoting surface.
- [Get Connect asset by ID](https://docs.zeam.money/api-reference/connect/get-connect-asset-by-id.md)
- [Get Connect transaction status](https://docs.zeam.money/api-reference/connect/get-connect-transaction-status.md)
- [Get integrator info](https://docs.zeam.money/api-reference/connect/get-integrator-info.md): Returns the integrator record for the authenticated app.
- [Get provider by ID](https://docs.zeam.money/api-reference/connect/get-provider-by-id.md)
- [List Connect assets](https://docs.zeam.money/api-reference/connect/list-connect-assets.md): Returns assets supported by the Connect platform.
- [List payment routes](https://docs.zeam.money/api-reference/connect/list-payment-routes.md): Returns available cross-border payment routes.
- [List providers](https://docs.zeam.money/api-reference/connect/list-providers.md): Returns all payment providers.
- [List supported countries](https://docs.zeam.money/api-reference/connect/list-supported-countries.md): Returns countries where cross-border routes are available.
- [Metadata-driven execution](https://docs.zeam.money/api-reference/connect/metadata-driven-execution.md): Forwards the request to Connect's REST API under the specified path. The path is taken from the GraphQL `execution[].path` field returned by `/v1/connect-query`. Supports POST, GET, PUT, PATCH, DELETE. Absolute URLs are rejected (SSRF guard).
- [On-ramp cash-in](https://docs.zeam.money/api-reference/connect/on-ramp-cash-in.md): Proxies to Connect `/onramp/cash-in`.
- [Query available connectors](https://docs.zeam.money/api-reference/connect/query-available-connectors.md): The gateway builds a canonical GraphQL Connectors query against the Connect service. Callers supply `countryISO` and `method` filters; the gateway owns the query shape. Direction is pinned to `OFF_RAMP`.
- [Gateway liveness](https://docs.zeam.money/api-reference/health/gateway-liveness.md): Returns the gateway's liveness state, uptime in milliseconds, and — if a database is wired — the database ping result. Unauthenticated.
- [API reference](https://docs.zeam.money/api-reference/introduction.md): Complete endpoint reference for the Zeam API.
- [Ed25519 challenge (app principal)](https://docs.zeam.money/api-reference/public-auth/ed25519-challenge-app-principal.md): Fetches a Stellar Ed25519 challenge for the given app public key. The gateway proxies `GET /auth-connect?account=<G...>` to the Zeam anchor. The caller signs the returned challenge with their Stellar seed and submits it to `POST /v1/public/auth-connect`.
- [Refresh an access token](https://docs.zeam.money/api-reference/public-auth/refresh-an-access-token.md): Exchanges a `refreshToken` for a new `idToken` regardless of whether the original token was issued via OTP or Connect sign-in.
- [Server-side Ed25519 sign-in (convenience)](https://docs.zeam.money/api-reference/public-auth/server-side-ed25519-sign-in-convenience.md): Authenticates using the public key and secret issued during application registration. Returns tokens for Connect API access.
- [Start OTP login](https://docs.zeam.money/api-reference/public-auth/start-otp-login.md): Begins an OTP login flow for a user, member, or third-party user. Dispatches the OTP (WhatsApp by default). Unauthenticated — this endpoint issues the credential that protects every `/v1/*` route.
- [Submit signed Ed25519 challenge](https://docs.zeam.money/api-reference/public-auth/submit-signed-ed25519-challenge.md): Submits the signed challenge XDR and receives tokens.
- [Verify OTP and issue tokens](https://docs.zeam.money/api-reference/public-auth/verify-otp-and-issue-tokens.md): Exchanges a one-time code for an `idToken` / `refreshToken`.
- [Get transaction status](https://docs.zeam.money/api-reference/transactions/get-transaction-status.md): Returns the current status of a transaction.
- [Initialise a transaction](https://docs.zeam.money/api-reference/transactions/initialise-a-transaction.md): Creates a new transaction reference. The gateway rejects any caller-supplied body and injects `{"origin":"ApiGateway"}` as the request payload.
- [Load a transaction for execution](https://docs.zeam.money/api-reference/transactions/load-a-transaction-for-execution.md): Loads transaction data scoped by the caller's ACL.
- [Ed25519 app authentication](https://docs.zeam.money/authentication/ed25519-app-auth.md): Authenticate your application using Ed25519 cryptographic key pairs.
- [OAuth authentication](https://docs.zeam.money/authentication/oauth-end-users.md): Use OAuth tokens to authenticate mobile and web app users.
- [OTP user authentication](https://docs.zeam.money/authentication/otp-user-auth.md): Sign in end users with a one-time password delivered via WhatsApp.
- [Authentication](https://docs.zeam.money/authentication/overview.md): Choose the right authentication method for your integration.
- [Token lifecycle](https://docs.zeam.money/authentication/token-lifecycle.md): How tokens are issued, refreshed, and expire.
- [API concepts](https://docs.zeam.money/concepts.md): Core concepts you need to understand before integrating with the Zeam API.
- [Connect payment flow](https://docs.zeam.money/guides/connect-payment.md): Execute a cross-border off-ramp payment end-to-end in nine steps.
- [Create a quote](https://docs.zeam.money/guides/create-quote.md): Get real-time pricing before executing a payment.
- [Event-driven design](https://docs.zeam.money/guides/event-driven-design.md): How the Zeam API handles asynchronous workflows and why webhooks are required for production integrations.
- [Execute transactions](https://docs.zeam.money/guides/execute-transaction.md): Send payments and track their status through completion.
- [Query connectors](https://docs.zeam.money/guides/query-connectors.md): Discover available payment routes, countries, and methods.
- [Application lifecycle](https://docs.zeam.money/guides/register-application.md): Register, submit, approve, and manage your integrator application — from first credential to production.
- [Webhooks](https://docs.zeam.money/guides/webhooks.md): Receive real-time notifications for application and payment events.
- [Zeam API](https://docs.zeam.money/introduction.md): Build cross-border payments, wallet management, and financial connectivity on the Zeam platform.
- [Environments](https://docs.zeam.money/platform/environments.md): One canonical API URL. Access mode is determined by your credentials and account configuration, not by the URL you call.
- [Errors](https://docs.zeam.money/platform/errors.md): How to handle errors from the Zeam API.
- [Response envelope](https://docs.zeam.money/platform/response-envelope.md): Every gateway response uses a consistent JSON envelope.
- [Security](https://docs.zeam.money/platform/security.md): Security best practices for Zeam API integrations.
- [Quickstart](https://docs.zeam.money/quickstart.md): From first API call to payment execution — a guided integration walkthrough.
- [Glossary](https://docs.zeam.money/resources/glossary.md): Key terms used in the Zeam API documentation.
- [Postman Collection](https://docs.zeam.money/resources/postman.md): Explore and test the Zeam API Gateway endpoints interactively with our curated Postman collection.
- [Support](https://docs.zeam.money/resources/support.md): How to reach the Zeam gateway team.
- [Flutter SDK](https://docs.zeam.money/sdks/flutter.md): Official Dart/Flutter client for the Zeam API. Mobile, desktop, web, and server.
- [Go SDK](https://docs.zeam.money/sdks/go.md): Official Go client for the Zeam API.
- [Go SDK recipes](https://docs.zeam.money/sdks/go-recipes.md): Pre-built workflows for common Zeam integration flows.
- [MCP server](https://docs.zeam.money/sdks/mcp.md): Connect AI agents and development tools to the Zeam platform via the Model Context Protocol.
- [SDKs and integrations](https://docs.zeam.money/sdks/overview.md): Official SDKs, MCP server, and REST API for integrating with the Zeam platform.
- [TypeScript SDK](https://docs.zeam.money/sdks/typescript.md): Official TypeScript client for the Zeam API. Server-side only.

## OpenAPI Specs

- [gateway](https://docs.zeam.money/openapi/gateway.yaml)

## Optional

- [GitHub](https://github.com/ZeamMoney/zeam-sdk-go)