Referrals
Referral system and earnings
Retrieve user's referral statistics and settings
JWT token obtained from login or register endpoint
Referral stats retrieved successfully
GET /api/v3/referrals/stats HTTP/1.1
Host: localhost:8009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Referral stats retrieved successfully
{
"success": true,
"data": {
"referral_code": "text",
"referral_link": "text",
"stats": {
"total_referrals": 1,
"pending_referrals": 1,
"completed_referrals": 1,
"flagged_referrals": 1,
"total_earned": 1,
"total_redeemed": 1,
"total_withdrawn": 1,
"available_balance": 1
},
"settings": {}
}
}Retrieve list of referrals and earnings
JWT token obtained from login or register endpoint
120Referral earnings retrieved successfully
No content
GET /api/v3/referrals/earnings HTTP/1.1
Host: localhost:8009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Referral earnings retrieved successfully
No content
Redeem referral balance to main balance
JWT token obtained from login or register endpoint
50Referral balance redeemed successfully
No content
POST /api/v3/referrals/redeem HTTP/1.1
Host: localhost:8009
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13
{
"amount": 50
}Referral balance redeemed successfully
No content
Request withdrawal of referral balance
JWT token obtained from login or register endpoint
500bkash01712345678Withdrawal request submitted successfully
POST /api/v3/referrals/withdraw HTTP/1.1
Host: localhost:8009
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71
{
"amount": 500,
"payment_method": "bkash",
"payment_details": "01712345678"
}Withdrawal request submitted successfully
No content
Retrieve referral transaction history
JWT token obtained from login or register endpoint
120Transaction history retrieved successfully
No content
GET /api/v3/referrals/transactions HTTP/1.1
Host: localhost:8009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Transaction history retrieved successfully
No content
Last updated