Skip to main content
The gateway uses the same conventions everywhere, so once you learn them they apply to every endpoint.

​
Base URL

  • https://api.zeam.money/gw/v1
Sandbox and production share this base URL; your application’s registration determines which environment a request runs in.

​
Versioning

The API is versioned in the path (/v1). Additive, backward-compatible changes ship within /v1. Breaking changes ship under a new version. Deprecations are announced ahead of time with Deprecation and Sunset response headers and a changelog entry.

​
Resource format

  • JSON, camelCase. All request and response fields use camelCase.
  • Identifiers are UUID strings. Stellar public keys are 56-character G… strings.
  • Timestamps are ISO 8601 / RFC 3339 in UTC, for example 2026-01-15T10:30:00Z.
  • Amounts are decimal strings where precision matters, to avoid floating-point rounding.
Collections are wrapped for pagination; single resources are returned directly.

​
Request headers

The association is resolved server-side from the verified token — you do not need to send an association id header. Payment endpoints take an idempotencyKey in the request body, not a header, so a retry cannot create a duplicate.

​
Response headers

Every response includes an X-Request-Id. If you send one, the gateway uses it; otherwise it generates one. Log it and include it in support requests so Zeam can trace the exact call.
Make payments safe to retry: send a unique idempotencyKey in the request body. Replaying it returns the original result with isIdempotent: true.