Referrals API

List Referral Programs

GET /v1/referral-programs

Create Referral Program

POST /v1/referral-programs

{
  "name": "Friend Referral",
  "referrerReward": {
    "type": "points",
    "amount": 500
  },
  "refereeReward": {
    "type": "points",
    "amount": 250
  },
  "maxReferrals": 10
}

Field	Type	Required	Description
name	string	Yes	Program name
referrerReward	object	Yes	Reward for the referrer
refereeReward	object	Yes	Reward for the new user
maxReferrals	number	No	Max referrals per customer

Get Referral Code

GET /v1/referrals/{customerId}/code

Response:

{
  "success": true,
  "data": {
    "code": "JANE-X7K2",
    "url": "https://your-app.com/ref/JANE-X7K2",
    "referralsCount": 3,
    "maxReferrals": 10
  }
}

Apply Referral

POST /v1/referrals/apply

{
  "code": "JANE-X7K2",
  "refereeId": "cust_new456"
}

Referral History

GET /v1/referrals/{customerId}/history

Returns a list of all referrals made by the customer, including status and reward information.