Create a Transactions Report
Generate a legacy Transactions Report
Note – Report expiration date
A report expires after 24 hours (i.e., you can no longer download it after this period). You can still generate a new report with the same filters and information easily.
Note – BeforeDate
value restriction
To ensure that data provided on each report are up-to-date, the BeforeDate
parameter cannot be greater than the report creation date minus 5 minutes.
If it is, BeforeDate
will be automatically set according to this constraint.
Body parameters
Max. length: 255 characters
Custom data that you can add to this object.
For reports, this parameter can be useful to give the report a name.
Possible values: CSV
The format of the report file.
Max. length: 255 characters
The URL to which the notification indicating that the report is ready to be downloaded will be sent.
Possible values: CreationDate:ASC
, CreationDate:DESC
Default value: CreationDate:ASC
The sort direction based on transaction creation date.
Whether the report is limited to the first 10 lines (and therefore quicker to generate).
The filtering parameters to optimize the report.
Allowed values: The Columns
listed in the Reports article, which differ according to the report type.
The information to be included in the report.
Responses
200
200
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
The date and time at which the object was created.
Max. length: 255 characters
Custom data that you can add to this object.
For reports, this parameter can be useful to give the report a name.
The date and time at which the report was generated.
Returned values: PENDING
, READY_FOR_DOWNLOAD
, FAILED
, EXPIRED
The status of the report:
PENDING
– The report is being generated.READY_FOR_DOWNLOAD
– The report has been created, and can be downloaded.FAILED
– The report cannot be generated.EXPIRED
– The report was created, but is no longer available for download (it can be re-run to be downloaded again with fresh data).
Returned values: CSV
The format in which the report is going to be downloaded.
The URL at which the report file can be downloaded when the Status
is GENERATED
.
Max. length: 255 characters
The URL to which the notification indicating that the report is ready to be downloaded will be sent.
The type of the report, indicating whether it lists transactions or wallets.
The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date.
Whether the report is limited to the first 10 lines (and therefore quicker to generate).
The filtering parameters to optimize the report.
Returned values: The Columns
listed in the Reports article, which differ according to the report type.
The information to be included in the report.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
400 - AfterDate must be within past 36 months
400 - AfterDate must be within past 36 months