Report Run
An asynchronous request to generate a report for one payout.
- idType: stringrequired
Report Run ID. Store it to check status or download the report.
- objectenumconst:report_runrequired
- createdType: stringFormat: date-time
_at requiredWhen the run was created.
- completedType: stringFormat: date-time
_at When processing finished, if available.
- statusType: stringenumrequiredvalues
- pending
The report is not ready. Retrieve the run again to check progress.
- succeeded
The report is ready. Use the download endpoint with this run ID.
- failed
The run ended without a file. Check
failure_codebefore starting another run.
- pending
- livemodeType: booleanrequired
Whether the run belongs to live mode. Test mode runs return
false. - reportType: enum
_type requiredReport type and version.
values- payout
_reconciliation .by _id .summary .1 Totals and movement counts grouped by movement type for one payout.
- payout
_reconciliation .by _id .itemized .1 Individual balance movements and their contributions to one payout.
- payout
_settlement .by _id .itemized .1 Itemized settlement details, including funding allocations. Requires additional access.
- payout
- parametersType:requiredProperties: 1
Inputs for the selected report type. All currently supported types require
payout_id. - formatType: enumrequired
Format of the downloaded report.
values- csv
Comma-separated file with a header row.
- json
JSON object with report details, column names, and rows.
- csv
- columnsType: array of stringrequired
The selected columns or the report type's default columns, in output order.
- resultType:Properties: 2
File information returned when the run succeeds. Use the Report Run ID to download the file.
- failureType: string
_code Reason the run failed, when available.

