API Docs

Quick start

New to panel integration? Follow the visual setup guide first, then return here for the full reference.

1. Register as an employer account.
2. Open Developer Hub and generate an API key.
3. Add funds at wallet/deposit (not via API).
4. In your panel, set API URL to https://www.gainworkers.com/api/v2.
5. Run action=services, map IDs, test action=add.

Endpoint

Actions

Example: create order

curl -X POST 'https://www.gainworkers.com/api/v2' \
  -d 'key=gw_live_YOUR_KEY' \
  -d 'action=add' \
  -d 'service=1001' \
  -d 'link=https://example.com/landing' \
  -d 'quantity=100'

{"order":9841203}

Example: balance

curl -X POST 'https://www.gainworkers.com/api/v2' \
  -d 'key=gw_live_YOUR_KEY' \
  -d 'action=balance'

{
  "balance": "124.5600",
  "currency": "USD",
  "deposit_url": "https://www.gainworkers.com/wallet/deposit",
  "deposits_via_api": false
}

Webhooks

Set a callback URL per API key in Developer Hub → Settings. We POST JSON on status changes with header X-GainWorkers-Signature: sha256=... (HMAC-SHA256 of the raw body).

{
  "event": "order.completed",
  "order": 12345,
  "status": "Completed",
  "remains": "0",
  "charge": "5.0000",
  "currency": "USD",
  "timestamp": 1751731200
}

Use webhooks to reduce action=status polling to every 5+ minutes.

Service codes

Error codes

Security checklist

• Store API keys server-side only. Never expose them in browser JavaScript.
• Enable IP whitelist on each production key.
• Use HTTPS for API calls and webhook callbacks.
• Send add, cancel, refill via POST body.
• API orders auto-publish when balance is sufficient (no manual admin queue).
• Fund wallet only through the deposit page after login.
• Verify webhook HMAC before updating order status in your database.