Commissions & Payouts API

Track affiliate commissions and manage payout processing. Requires commissions:read and/or payouts:write scopes.

List Commissions

curl https://api.affilync.com/api/commissions \
  -H "Authorization: Bearer YOUR_TOKEN"

Query Parameters:

Parameter	Type	Default	Description
status	string	all	Filter: pending, approved, paid, cancelled, reversed
campaign_id	string	—	Filter by campaign
date_from	string	—	ISO 8601 start date
date_to	string	—	ISO 8601 end date
page	int	1	Page number
per_page	int	20	Results per page (max 100)

Response (200):

{
  "data": [
    {
      "id": "comm_abc123",
      "affiliate_id": "usr_xyz789",
      "campaign_id": "camp_abc123",
      "order_id": "ord_456",
      "amount": "25.00",
      "currency": "USD",
      "status": "approved",
      "commission_rate": "10.00",
      "order_amount": "250.00",
      "attributed_click_id": "clk_789",
      "created_at": "2026-03-20T14:30:00Z",
      "approved_at": "2026-03-21T10:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 156
  }
}

Get Commission Details

curl https://api.affilync.com/api/commissions/comm_abc123 \
  -H "Authorization: Bearer YOUR_TOKEN"

Commission Tiers

Multi-tier commission structures let brands reward top performers with higher rates.

curl https://api.affilync.com/api/campaigns/camp_abc123/commission-tiers \
  -H "Authorization: Bearer YOUR_TOKEN"

Response (200):

{
  "data": [
    { "tier": "Bronze", "min_conversions": 0, "rate": "5.00" },
    { "tier": "Silver", "min_conversions": 10, "rate": "7.50" },
    { "tier": "Gold", "min_conversions": 25, "rate": "10.00" },
    { "tier": "Platinum", "min_conversions": 50, "rate": "12.50" },
    { "tier": "Diamond", "min_conversions": 100, "rate": "15.00" }
  ]
}

---

Affiliate Earnings

Get your earnings summary with breakdowns by period.

curl https://api.affilync.com/api/affiliate/earnings/summary \
  -H "Authorization: Bearer YOUR_TOKEN"

Response (200):

{
  "data": {
    "total_earned": "3247.50",
    "pending": "450.00",
    "available_for_payout": "2797.50",
    "this_month": "890.00",
    "last_month": "1120.00",
    "currency": "USD"
  }
}

---

Payouts

List Payouts

curl https://api.affilync.com/api/payouts \
  -H "Authorization: Bearer YOUR_TOKEN"

Query Parameters:

Parameter	Type	Default	Description
status	string	all	pending, processing, completed, failed
page	int	1	Page number
per_page	int	20	Results per page

Response (200):

{
  "data": [
    {
      "id": "pay_abc123",
      "amount": "500.00",
      "currency": "USD",
      "status": "completed",
      "payment_method": "stripe_connect",
      "commissions_count": 12,
      "requested_at": "2026-03-15T00:00:00Z",
      "completed_at": "2026-03-17T14:20:00Z",
      "transaction_id": "txn_stripe_abc"
    }
  ],
  "meta": { "page": 1, "per_page": 20, "total": 8 }
}

Request Payout (Affiliate)

curl -X POST https://api.affilync.com/api/payouts/request \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "500.00",
    "payment_method_id": "pm_abc123"
  }'

Requirements:

• Minimum payout: $50.00 USD
• Payment method must be verified
• 72-hour hold period on new commissions
• Rate limited: 5 requests per hour

Approve Payout (Brand)

curl -X POST https://api.affilync.com/api/brand/payouts/pay_abc123/approve \
  -H "Authorization: Bearer YOUR_TOKEN"

---

Payout Settings

Get Payout Settings

curl https://api.affilync.com/api/affiliate/settings/payout \
  -H "Authorization: Bearer YOUR_TOKEN"

Update Payout Settings

curl -X PUT https://api.affilync.com/api/affiliate/settings/payout \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "payout_method": "stripe_connect",
    "minimum_threshold": "100.00",
    "frequency": "monthly",
    "auto_payout": true
  }'

Supported payout methods: stripe_connect, paypal, bank_transfer

Supported frequencies: daily, weekly, biweekly, monthly, manual

---

Commission Object

Field	Type	Description
id	string	Unique commission ID
affiliate_id	string	Affiliate user ID
campaign_id	string	Campaign that generated the commission
order_id	string	Associated order/conversion ID
amount	string	Commission amount (decimal)
currency	string	ISO 4217 currency code
status	string	pending, approved, paid, cancelled, reversed
commission_rate	string	Rate applied (percentage or fixed)
order_amount	string	Original order value
attributed_click_id	string	Click that led to conversion
created_at	string	ISO 8601 timestamp
approved_at	string	When commission was approved
paid_at	string	When commission was paid out