Payouts

Payouts

A Payout is a payment SparkLoop has made (or is preparing to make) to your account for partner-network referral commissions. Payouts are account-scoped; this resource exposes only your account's partner-network payouts — affiliate commissions and other adjustments are not returned, by list or by UUID.

List payouts

GET https://api.sparkloop.app/v3/payouts

Paginated, newest first.

Query Parameters

Name	Type	Description
expand	String	details (per-publication breakdown of what this payout pays for), unpaid_details (confirmations deferred to a future payout).

200: OK

{
  "payouts": [
    <Payout Object>
  ],
  "meta": {
    "per_page": 50,
    "page": 1,
    "total_pages": 1,
    "total_payouts": 9
  }
}

Get payout

GET https://api.sparkloop.app/v3/payouts/:uuid

Path Parameters

Name	Type	Description
uuid*	String	The payout's UUID.

Query Parameters

Name	Type	Description
expand	String	details, unpaid_details.

200: OK

{
  "payout": <Payout Object>
}

404: Not Found

{
  "error": "Resource not found."
}