Payouts

A payout batch aggregates eligible commissions for one affiliate and settles them in one transfer. See Affiliates & payouts for the model.

Object

{
  "id": "pob_…",
  "object": "payout_batch",
  "affiliate_id": "aff_…",
  "currency": "USD",
  "amount": "245.00",
  "method": "bank",
  "status": "settled",
  "as_of": "2026-05-31T23:59:59Z",
  "commissions": [ "com_…", "com_…", … ],
  "provider_id": "po_…",
  "settled_at": "2026-06-02T15:00:00Z",
  "failure_reason": null,
  "metadata": {},
  "created_at": "2026-06-01T00:00:00Z"
}

Endpoints

Method	Path	What
POST	/v1/payouts/batches/run	Force a payout run now.
GET	/v1/payouts/batches/{id}	Retrieve.
GET	/v1/payouts/batches	List + filter.
POST	/v1/payouts/batches/{id}/retry	Retry a failed batch.
GET	/v1/affiliates/{id}/commissions	List commissions for one affiliate.

Status

pending, processing, settled, failed, partial (some commissions settled, others didn’t — the failed ones return to eligible for the next batch).

Webhook events

payout_batch.created, payout_batch.settled, payout_batch.failed, commission.accrued, commission.eligible, commission.reversed.