Skip to main content
The API reference is auto-generated from the OpenAPI specification. Every endpoint includes request/response schemas, authentication requirements, and interactive examples.

​
How to use

  • Browse endpoints by category in the sidebar
  • Use the interactive playground to test calls directly
  • Code samples are available in curl, Go, TypeScript, and Python
  • All endpoints require Authorization: Bearer <token> unless marked as public

​
Authentication

Most endpoints require a bearer token. See Authentication for how to obtain one. Connect endpoints (/v1/connect-*) additionally require the x-zeam-auth header with your issued connect secret: 
x-zeam-auth: <connect-secret>

​
Base URL

All requests target the single canonical endpoint: 
https://api.zeam.money/gw
Access mode (Sandbox or full production) is determined by your credentials and account configuration. See Environments.