POST /v1/referral

Switch between `cash` and `credits`, and set a payout address. The switch applies to commission accrued from here on. Anything already in your ledger keeps the form it was earned in — we do not retroactively convert a paid-out dollar into credits or the other way round.

Request

curl -X POST 'https://api.puntersedge.online/v1/referral' \
  -H 'X-API-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"reward_type": "REWARD_TYPE", "payout_email": "you@example.com", "code": "CODE"}'

Parameters

Responses

Status codes: 200, 401, 402, 422, 429, 500. Response bodies are JSON; the full schema is in /openapi.json.

Example response

200 application/json Field names and types are as the API returns them; values are a real sample, trimmed to a few items.

{
  "code": "PE-7QK2ZD",
  "reward_type": "cash",
  "payout_email": "example@example.com",
  "active": true,
  "terms": {
    "commission_pct": 10,
    "term_months": 12,
    "credits_per_aud": 1000,
    "min_payout_aud": 50
  },
  "signups": 14,
  "converted": 3,
  "active_referrals": 3,
  "expired_referrals": 0,
  "earned_aud": 26.1,
  "owing_aud": 0.0,
  "credits_earned": 26100,
  "recent": [
    {
      "at": "2026-09-19T04:12:08Z",
      "amount_aud": 9.9,
      "reward": "credits"
    }
  ],
  "link": "https://puntersedge.online/api?ref=PE-7QK2ZD",
  "note": "Switched to cash. Earnings already settled as credits stay as credits."
}

Related endpoints

• GET /v1/referral — Your referral link and earnings