​
Description

The Report object is a tool that enables you to download a large amount of data in CSV format for accounting or analysis purposes. Reports are available for transactions and wallets.
Note – Replaced by Reporting ServiceThe legacy Report endpoints are being replaced by Mangopay’s Reporting Service, which underpins the Dashboard’s report features.The legacy Transactions report data is available in the service’s User Wallet Transactions report. An equivalent of the legacy Wallets report is planned in future.

​
Attributes

​
Id
string
The unique identifier of the object.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
Tag
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.
​
ReportDate
Unix timestamp
The date and time at which the report was generated (i.e., when its Status is no longer PENDING).
​
Status
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).
​
DownloadFormat
string
Allowed values: CSVThe format in which the report is going to be downloaded.
​
DownloadURL
string
The URL at which the file can be downloaded.
​
CallbackURL
string
Max. length: 255 charactersThe URL to which the notification indicating that the report is ready to be downloaded will be sent.
​
ReportType
string
The type of the report, indicating whether it lists transactions or wallets.
​
Sort
string
Returned values: CreationDate:ASC, CreationDate:DESCIndicates the direction in which to sort the list.
​
Preview
boolean
Whether the report is limited to the first 10 lines (and therefore quicker to generate).
​
Filters
object
The filtering parameters to optimize the report. The available filters differ depending on the value set for the ReportType parameter.
​
Columns
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.
​
ResultCode
array
The transaction result codes to be taken into account.
​
ResultMessage
string
The explanation of the result code.

Guide

Learn more about reporting