Skip to main content
POST
Note – Report expiration dateA report expires after 24 hours (i.e., you can no longer download it after this delay). You can still generate a new report with the same filters and information easily.

Body parameters

string
Max. length: 255 charactersCustom data that you can add to this object.For reports, this parameter can be useful to give the report a name.
string
Possible values: CSVThe format of the report file.
string
Max. length: 255 charactersThe URL to which the notification indicating that the report is ready to be downloaded will be sent.
string
Possible values: CreationDate:ASC, CreationDate:DESCDefault value: CreationDate:ASCThe sort direction based on transaction creation date.
boolean
Whether the report is limited to the first 10 lines (and therefore quicker to generate).
object
The filtering parameters to optimize the report.
array
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

string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
Unix timestamp
The date and time at which the object was created.
string
Max. length: 255 charactersCustom data that you can add to this object.For reports, this parameter can be useful to give the report a name.
Unix timestamp | null
The date and time at which the report was generated.
string
Returned values: PENDING, READY_FOR_DOWNLOAD, FAILED, EXPIREDThe 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).
string
Returned values: CSVThe format in which the report is going to be downloaded.
string | null
The URL at which the report file can be downloaded when the Status is GENERATED.
string
Max. length: 255 charactersThe URL to which the notification indicating that the report is ready to be downloaded will be sent.
string
The type of the report, indicating whether it lists transactions or wallets.
string
The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date.
boolean
Whether the report is limited to the first 10 lines (and therefore quicker to generate).
object
The filtering parameters to optimize the report.
array
Returned values: The Columns listed in the Reports article, which differ according to the report type.The information to be included in the report.
array
The transaction result codes to be taken into account.
string
The explanation of the result code.