Quickstart

Issue an access token and make your first authenticated call against the sandbox.

This walks you from credentials to a working request in three steps. It uses the sandbox base URL. Swap in the production base URL once you are promoted.

Base URLs

• Sandbox: https://api.dev.zeam.paytec.io/v1
• Production: https://api.zeam.app/v1

1. Get sandbox credentials

   Your Zeam business administrator registers an application in the business portal and shares its clientId, client secret, and application secret (apiKey) with you. See API keys.

2. Issue an access token

   Exchange your client credentials for a short-lived bearer token. This route is public.

   cURL

   curl -sS https://api.dev.zeam.paytec.io/v1/auth/token \
     -H "Content-Type: application/json" \
     -d '{
       "clientId": "11111111-1111-1111-1111-111111111111",
       "clientSecret": "$ZEAM_CLIENT_SECRET"
     }'
   

   The response contains the token and its lifetime in seconds:

   Response

   {
     "accessToken": "eyJ0eXAiOiJKV1Qi...",
     "tokenType": "Bearer",
     "expiresIn": 3599
   }
   
3. Call a protected endpoint

   Send the access token as a bearer token and your application secret as the x-zeam-auth header. Both are required on every protected request.

   cURL

   curl -sS https://api.dev.zeam.paytec.io/v1/wallets \
     -H "Authorization: Bearer $ZEAM_TOKEN" \
     -H "x-zeam-auth: $ZEAM_APP_SECRET"
   

   A successful response is a paginated collection:

   Response

   {
     "data": [
       { "id": "…", "walletName": "Treasury ZAR", "publicKey": "G…" }
     ],
     "pagination": { "nextCursor": null, "hasMore": false }
   }
   

Next steps

Authentication

Understand tokens, the application secret, and association scoping.

Make your first transaction

Go from a quote to an executed payment and webhook updates.

API reference

Browse every endpoint and try requests in the playground.

Errors

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