Export Csv export csv
Exports the current company’s transactions that match the filters as a CSV file. By default the file is built during the request and the response carries a signed download url that expires after 12 hours. With async=true the export runs in the background and the response returns a job_id with status: processing instead. Returns 422 when no transactions match or a date bound cannot be read. Requires a company admin Bearer token with the payment_accounts.view permission.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Run the export in a worker and answer immediately with a job id. Omit or send false to build the CSV in the request and receive a signed URL.
Accepted but ignored. A company-scoped export is always the transactions column set.
transactions, transactions_detailed Start of the exported range, as MM/DD/YYYY or MM/DD/YYYY HH:MM:SS. Any other format is rejected with a 422 naming the accepted ones.
End of the exported range, in the same formats as start_date. A date with no time of day covers that whole day.
IANA timezone the date bounds are expressed in. The bounds are converted to UTC before the range is applied.
Filter by payment status.
Filter by payment integration class.
Filter by currency code.
Filter by the payment's billing country, as an ISO 3166-1 alpha-2 code. Accepted values are listed by the filter_options operation.
Filter by the ActiveMerchant gateway class that processed the payment.
Filter by the source of the originating order.
Filter by whether the payment was live or a test transaction.
test, live