Reports

Columns

Name

Type

References

Description

Id [KEY]

String

Unique identifier for the object.

Created

Datetime

Time at which the object was created. Measured in seconds since the Unix epoch.

Error

String

If something should go wrong during the run, a message about the failure (populated when status=failed).

Livemode

Boolean

Always true: reports can only be run on live-mode data

Object

String

String representing the objects type. Objects of the same type share the same value.

ParametersIntervalEnd

Datetime

Ending timestamp of data to be included in the report run (exclusive).

ParametersIntervalStart

Datetime

Starting timestamp of data to be included in the report run.

ParametersColumns

String

The set of output columns requested for inclusion in the report run.

ParametersConnectedAccount

String

Connected account ID by which to filter the report run.

ParametersCurrency

String

Currency of objects to be included in the report run.

ParametersPayout

String

Payouts.Id

Payout ID by which to filter the report run.

ParametersReportingCategory

String

Category of balance transactions to be included in the report run.

ParametersTimezone

String

Defaults to Etc/UTC. The output timezone for all timestamps in the report.

Report_type

String

The ID of the report type to run, such as balance.summary.1

The allowed values are balance_change_from_activity.itemized.1, balance_change_from_activity.itemized.2, balance_change_from_activity.itemized.3, balance_change_from_activity.summary.1, payouts.itemized.1, payouts.itemized.2, payouts.itemized.3, payouts.summary.1, balance.summary.1, ending_balance_reconciliation.itemized.1, ending_balance_reconciliation.itemized.2, ending_balance_reconciliation.itemized.3, ending_balance_reconciliation.summary.1, ending_balance_reconciliation.itemized.4, payout_reconciliation.by_id.itemized.1, payout_reconciliation.by_id.itemized.2, payout_reconciliation.by_id.itemized.3, payout_reconciliation.by_id.itemized.4, payout_reconciliation.by_id.summary.1, payout_reconciliation.itemized.1, payout_reconciliation.itemized.2, payout_reconciliation.itemized.3, payout_reconciliation.itemized.4, payout_reconciliation.summary.1, payout_reconciliation.itemized.5.

ResultCreated

Datetime

Time at which the object was created. Measured in seconds since the Unix epoch.

ResultExpiresAt

Datetime

The time at which the file expires and is no longer available in epoch seconds.

ResultFilename

String

A filename for the file, suitable for saving to a filesystem.

ResultId

String

Unique identifier for the object.

ResultLinksData

String

Details about each object.

ResultLinksHas_more

Boolean

True if this list has another page of items after this one that can be fetched.

ResultLinksObject

String

String representing the objects type. Objects of the same type share the same value. Always has the value list.

ResultLinksUrl

String

The URL where this list can be accessed.

ResultObject

String

String representing the objects type. Objects of the same type share the same value.

ResultPurpose

String

The purpose of the uploaded file.

The allowed values are account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, identity_document, pci_document, tax_document_user_upload.

ResultSize

Integer

The size in bytes of the file object.

ResultTitle

String

A user friendly title for the document.

ResultType

String

The type of the file returned (e.g., csv, pdf, jpg, or png).

ResultUrl

String

The URL from which the file can be downloaded using your live secret API key.

Status

String

Status of this report run. This will be pending when the run is initially created. When the run finishes, this will be set to succeeded and the result field will be populated. Rarely, we may encounter an error, at which point this will be set to failed and the error field will be populated.

Succeeded_at

Timestamp

Timestamp at which this run successfully finished (populated when status=succeeded). Measured in seconds since the Unix epoch.

Last updated