Skip to main content
GET
Export Csv export csv

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

async
boolean

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.

report_type
enum<string>

Which column set the CSV carries.

Available options:
transactions,
transactions_detailed
start_date
string

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_date
string

End of the exported range, in the same formats as start_date. A date with no time of day covers that whole day.

timezone
string

IANA timezone the date bounds are expressed in. The bounds are converted to UTC before the range is applied.

status
string

Filter by payment status.

integration
string

Filter by payment integration class.

currency
string

Filter by currency code.

country_code
string

Filter by the payment's billing country, as an ISO 3166-1 alpha-2 code. Accepted values are listed by the filter_options operation.

gateway
string

Filter by the ActiveMerchant gateway class that processed the payment.

order_source
string

Filter by the source of the originating order.

type
enum<string>

Filter by whether the payment was live or a test transaction.

Available options:
test,
live

Response

Success

job_id
string

Background job id. Present only when async=true.

status
string

Always processing when present. Present only when async=true.

url
string

Signed URL of the generated CSV, valid for 12 hours. Present only for a synchronous export.

meta
object