---
title: "Choose how your referral reward is paid"
method: POST
path: "/v1/referral"
tags: ["Referrals"]
---

# Choose how your referral reward is paid

`POST /v1/referral`

## Request

- Base URL: `https://api.puntersedge.online`
- URL: `https://api.puntersedge.online/v1/referral`
- Auth: API key in header `X-API-Key`

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.

## Headers

- `X-API-Key` string
- `X-RapidAPI-Proxy-Secret` string

## Request body

- RewardIn
  - `reward_type` string, required: `cash` or `credits`.
  - `payout_email` string, nullable: Where a cash remittance should go, if it differs from the account email. Ignored for `credits`.
  - `code` string, nullable: Requested referral code, first call only. 3-24 characters, lowercase letters, digits and hyphens. Ignored once a code has been issued — a code that changes is a dead link on somebody's blog.

## Response `200`

Successful Response

- unknown

## Other responses

- `401`: Missing or invalid API key. Send `X-API-Key`. See https://puntersedge.online/developers/errors
- `402`: Monthly credit allowance exhausted for this plan. Upgrade at https://puntersedge.online/api/pricing
- `422`: Validation Error
- `429`: Rate limit exceeded for this plan. Honour the `Retry-After` header (seconds) before retrying. See https://puntersedge.online/developers/rate-limits
- `500`: Unexpected server error. Safe to retry with backoff.

---

[API](https://skmtc.dev/puntersedge/apis/puntersedge-odds-api.md) · [All operations](https://skmtc.dev/puntersedge/apis/puntersedge-odds-api/llms.txt) · [OpenAPI document](https://skmtc.dev/puntersedge/apis/puntersedge-odds-api/revisions/f35b6aab1946?raw)