Exports

Exports are processed asynchronously. Queue an export job and receive the file by email once processing is complete.

GET/api/export/charges

Export Charges

Queues a charges export job that will be processed asynchronously. Send x-api-key and x-token on every request.

Authorizations

Name
x-api-key
Type
string (header)
Description
Required Project API key sent in x-api-key header.
Name
x-token
Type
string (header)
Description
Required Session token sent in x-token header.

Query Parameters

Name
date_range
Type
string
Description
Filter charges by date range. Available options: today, yesterday, current_month, last_seven_days, last_four_weeks, last_month, all (default).

The export is processed asynchronously. You'll receive the file via email once processing is complete.

Request

GET

/api/export/charges

curl --request GET "https://my.domain.io/api/export/charges?date_range=all" \
  --header 'x-api-key: <api-key>' \
  --header 'x-token: <api-key>'

Properties Response

Export queued.

Name
code
Type
integer
Description
Status code of the response. Example: 202.
Name
content
Type
object
Description
Export job details.
Name
content.job_id
Type
string
Description
Unique identifier for the export job.
Name
content.date_range
Type
string
Description
The date range filter applied to the export.
Name
content.kind
Type
string
Description
Export type (charges).
Name
message
Type
string
Description
Response message.
Name
timestamp
Type
string (date-time)
Description
Response timestamp.

202

{
  "code": 202,
  "content": {
    "job_id": "ylha4p50euonl2nrwbvl33pj",
    "date_range": "all",
    "kind": "charges"
  },
  "message": "Charges export queued",
  "timestamp": "2026-01-01T19:43:02.492155Z"
}

GET/api/export/withdrawals

Export Withdrawals

Queues a withdrawals export job that will be processed asynchronously. Send x-api-key and x-token on every request.