Export

Progress and outcome of a CSV export. Store id to retrieve it and request its download link.

id
Type: string
required

Export ID used in the retrieve and download-link paths.
created_at
Type: stringFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
updated_at
Type: stringFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
export_name
Type: string
required
in_progress
Type: boolean
required

Whether the export is still being processed.
percent_complete
Type: integer
min:
0
max:
100
required

Reported processing progress.
uploaded
Type: boolean
required

Whether the completed file is available for download.
success
Type: boolean | null

Whether the export completed successfully. May be absent while processing; false indicates failure.
count
Type: integer | nullFormat: int64

Number of exported payment records when available.
outcome_code
Type: string | null

Outcome code when the export finishes; inspect this if success is false.
columns_mode
Type: stringenum
values
- default
  
  Uses the export template's default columns.
- all
  
  Includes all available columns.
- custom
  
  Includes the requested columns.
delivery_mode
Type: stringenum
values
- download
  
  File is available through a temporary download link.
- email
  
  File is delivered by email.
- both
  
  File is available for download and delivered by email.
delivery_email
Type: string | nullFormat: email
started_at
Type: string | nullFormat: date-time

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
completed_at
Type: string | nullFormat: date-time

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
canceled_at
Type: string | nullFormat: date-time

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

ReportingUnifiedPaymentsFilters

Export download link