Export Csv export csv
Exports your company’s payment transactions as a CSV file, applying the same filters as the transactions list. Requires a company admin Bearer token with the transactions.view permission; a company admin’s export is always scoped to their own company and always uses the transactions column set, whatever report_type says. By default the CSV is built during the request and the response carries url, a signed download link that expires after 12 hours. With async=true the export runs in the background and the response carries job_id and status: processing instead. When start_date and end_date are omitted the export covers the last 30 days. A synchronous export that matches no payments responds 422.
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.
Which column set the CSV carries.
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