Skip to main content
Use the Zeam API Gateway Postman collection to explore every endpoint, run authenticated requests, and test integration flows without building requests from scratch.

Browse collection docs

View the published collection documentation at our custom domain.

Run in Postman

Run In Postman

​
What’s included

The collection covers the full API surface organized into key flows:
  • Authentication — OTP request/verify, token refresh, Ed25519 challenge and sign-in
  • Business — Associations, assets, wallets, beneficiaries, payment destinations
  • Connect — Quotes, routing, on-ramp, off-ramp, transaction execution
  • Transactions — Init, load, and status
  • Applications — Registration, lifecycle, webhooks

​
Getting started

1

Fork the collection

Click Run in Postman above to fork the collection into your workspace. The collection includes pre-wired collection variables so requests chain naturally.
2

Set your environment variables

Open the collection’s Variables tab and fill in:
VariableDescription
urlBase URL — always https://api.zeam.money/gw
bearer_tokenYour idToken from OTP or Connect sign-in
x_zeam_authYour connect secret (required for Connect endpoints)
association_idYour association UUID
Leave ed25519_bearer_token, wallet_id, beneficiary_id, and similar fields empty — they are populated automatically by the collection’s test scripts as you run requests in order.
3

Authenticate

Run OTP Request → Verify OTP in sequence. The test script on Verify OTP saves the returned idToken and refreshToken into bearer_token and refresh_token automatically.For Ed25519 app auth, run Ed25519 Auth instead.
4

Explore

With authentication in place, all other requests are ready to run. Work through the flows in order: fetch your association, list wallets, query beneficiaries, get a quote, and execute a payment.
Token expiry is 3600 seconds. Run Refresh Token at any time to get a new idToken without re-entering your credentials.

​
Authentication reference

Endpoint groupAuth required
/v1/public/auth/*None — these endpoints issue credentials
/v1/business/*OAuth bearer (Authorization: Bearer $ID_TOKEN)
/v1/application/*OAuth bearer
/v1/transaction/*OAuth bearer
/v1/connect-*Connect bearer + x-zeam-auth: <connect-secret> (except /v1/connect-query which accepts either)
/v1/stellar/*OAuth bearer
See Authentication overview for a full explanation of each credential type.