Report Run

An asynchronous request to generate a report for one payout.

  • Report Run ID. Store it to check status or download the report.

  • When the run was created.

  • When processing finished, if available.

  • values
    • 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_code before starting another run.

  • Whether the run belongs to live mode. Test mode runs return false.

  • Report 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.

  • Inputs for the selected report type. All currently supported types require payout_id.

    Properties: 1
  • Format of the downloaded report.

    values
    • csv

      Comma-separated file with a header row.

    • json

      JSON object with report details, column names, and rows.

  • The selected columns or the report type's default columns, in output order.

  • File information returned when the run succeeds. Use the Report Run ID to download the file.

    Properties: 2
  • Reason the run failed, when available.