Siren

Export Payouts

Exports selected payouts as CSV data and optionally marks them as paid.

Last updated: April 9, 2026

Export Payouts

POST /siren/v1/payouts/export

Exports selected payouts as CSV data and optionally marks them as paid. The CSV is returned in the JSON response body (not as a file download), allowing the client to trigger a download.

Request Body

FieldTypeRequiredDescription
idsinteger[]YesArray of payout IDs to export
markAsPaidbooleanNoWhether to mark exported payouts as paid (default: true)

CSV Columns

The exported CSV includes Payout ID, Collaborator Email, Collaborator Name, Collaborator ID, Currency, and Value (converted to float from integer cents). If a collaborator record has been deleted, their email and name columns show <deleted>.

Example

{
  "ids": [20, 21, 22],
  "markAsPaid": true
}
{
  "success": true,
  "csv": "Payout ID,Collaborator Email,Collaborator Name,Collaborator ID,Currency,Value\n20,jane@example.com,Jane Doe,3,USD,30.00\n21,bob@example.com,Bob Smith,7,USD,20.00",
  "filename": "payouts_export_2026-04-06_120000.csv",
  "exported": 2,
  "marked": 2
}

Each payout marked as paid broadcasts a PayoutPaid event.