Request Affiliate Status
Request affiliate status for the authenticated user.
{
"organization": "Community Garden Network"
}
201 Created
{
"user_id": "did:key:z6Mk...",
"organization": "Community Garden Network",
"nickname": null,
"status": "pending",
"affiliate_logo": null,
"weekly_allocation": 0,
"weekly_balance": 0,
"one_time_balance": 0
}
409 Conflict - Affiliate already approved
Get Affiliate by User ID
Retrieve affiliate details for a specific user.
200 OK
{
"user_id": "did:key:z6Mk...",
"organization": "Community Garden Network",
"nickname": "GardenCo",
"status": "approved",
"affiliate_logo": "https://example.com/logo.png",
"weekly_allocation": 1000,
"weekly_balance": 750,
"one_time_balance": 500
}
404 Not Found - Affiliate not found403 Forbidden - User not authorized to view this affiliate
Update Affiliate Logo
Update the affiliate’s logo URL.
{
"logo": "https://example.com/new-logo.png"
}
200 OK
{
"user_id": "did:key:z6Mk...",
"organization": "Community Garden Network",
"nickname": "GardenCo",
"status": "approved",
"affiliate_logo": "https://example.com/new-logo.png",
"weekly_allocation": 1000,
"weekly_balance": 750,
"one_time_balance": 500
}
Admin: List Affiliates
Retrieve paginated list of all affiliates (admin only).
| Parameter | Type | Default | Description |
|---|
search | string | - | Search by organization or user ID |
page | integer | 0 | Page number |
count | integer | 20 | Items per page |
200 OK
[
{
"user_id": "did:key:z6Mk...",
"organization": "Community Garden Network",
"nickname": "GardenCo",
"status": "approved",
"affiliate_logo": "https://example.com/logo.png",
"weekly_allocation": 1000,
"weekly_balance": 750,
"one_time_balance": 500
}
]
Admin: Update Affiliate
Update affiliate settings (admin only).
{
"user_id": "did:key:z6Mk...",
"status": "approved",
"nickname": "GardenCo",
"weekly_balance": 1000,
"one_time_balance": 500
}
user_id are optional.
Response: 200 OK
{
"user_id": "did:key:z6Mk...",
"organization": "Community Garden Network",
"nickname": "GardenCo",
"status": "approved",
"affiliate_logo": "https://example.com/logo.png",
"weekly_allocation": 1000,
"weekly_balance": 1000,
"one_time_balance": 500
}
Schema: Affiliate
interface Affiliate {
user_id: string; // DID of the affiliate user
organization: string; // Organization name
nickname: string | null; // Optional display name
status: string; // "pending" | "approved" | "rejected"
affiliate_logo: string | null; // Logo URL
weekly_allocation: number; // Weekly token allocation
weekly_balance: number; // Current weekly balance
one_time_balance: number; // One-time balance pool
}