Brand key required

Payouts

Record an external payment you have already made. Roster does not transfer money. Every payment settles explicitly selected, approved commissions in one currency.

List payment records

GET/v1/affiliates/payouts

Filter by creator_email, currency, or status. Responses include allocations, recovered refund adjustments, and standard page/limit pagination. /v1/payouts is an alias.

Record an allocated payment

POST/v1/affiliates/payouts

Field	Type	Description
creator_email	string	Required creator email; every selected event must belong to this creator.
event_ids	string[]	Required, 1–100 approved, verified, eligible, unpaid commission IDs.
currency	string	Required uppercase ISO currency shared by every selected event.
amount	integer	Positive amount in currency minor units. Must equal selected net commissions minus outstanding refund debt.
method	string	manual, paypal, or bank; describes the external payment method.
idempotency_key	string	8–200 characters. Reuse for retries of this exact payment only. Idempotency-Key header is also accepted.
note	string	Optional external payment reference or memo.

request body

{
  "creator_email": "emma@example.com",
  "event_ids": ["evt_001", "evt_002"],
  "currency": "USD",
  "amount": 15000,
  "method": "bank",
  "idempotency_key": "external-payment-2026-09-06-001",
  "note": "Bank receipt 001"
}

The record and selected commission allocations commit together. The record has status paid and kind external_payment_record. No other commission is implicitly settled. Identical retries return the existing payment; changed details under the same key return HTTP 409.

Refunds on previously paid orders create outstanding adjustments. A later payment automatically recovers this debt in the same currency, and lists the recovered amounts in adjustments. A mismatch between the entered amount and the calculated amount returns HTTP 409 before any write.

Eligibility and review

List commissions to inspect can_pay, net_commission, eligible_at, and outstanding_adjustment. Unverified historical events require reconciliation before settlement. Directly setting a commission status to paid is not supported.

Inspect and annotate a payment

GET/v1/payouts/{id}

PATCH/v1/payouts/{id}

PATCH accepts a note only. Settlement amount, status, paid timestamp and allocations are immutable; financial corrections require adjustment records, not rewriting payment history.