Skip to main content
This walks you from credentials to a working request in three steps. Sandbox and production share one base URL; your application’s registration determines the environment.
Base URL: https://api.zeam.money/gw/v1Sandbox and production use the same base URL. Your application’s registration determines which environment a request runs in.
1

Get sandbox credentials

Register an application in the business portal (or ask an administrator to) to get its clientId, client secret, and application secret (apiKey). See API keys.
2

Issue an access token

Exchange your client credentials for a short-lived bearer token. This route is public.
cURL
The response contains the token and its lifetime in seconds:
Response
Keep the associationId; you send it as x-association-id on every protected request.
3

Call a protected endpoint

Every protected request carries three headers: the bearer token, your application secret as x-zeam-auth, and your association id as x-association-id.
cURL
A successful response is a paginated collection:
Response

​
Next steps

Authentication

Understand tokens, the application secret, and association scoping.

Your first transaction

Go from credentials to a completed P2P transfer with status tracking.

API reference

Browse every endpoint and try requests in the playground.

Errors

Learn the RFC 7807 error format and how to handle failures.