The legacy Report object
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 Service
The 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
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 wallets, you can use this parameter to identify the corresponding end user in your platform.
The date and time at which the report was generated (i.e., when its Status is no longer PENDING).
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).
Possible values: CSV
The format of the report file.
The URL at which the file can be downloaded.
Max. length: 255 characters
The URL to which the notification indicating that the report is ready to be downloaded will be sent.
Possible values: COLLECTED_FEES, USER_WALLET_TRANSACTIONS, ECHO_INTENT, ECHO_INTENT_ACTION, ECHO_SETTLEMENT, ECHO_SPLIT.
The type of the report. Each ReportType has different available Columns and Filters.
Useful for all platforms:
USER_WALLET_TRANSACTIONS– All successful transactions crediting or debiting user wallets: pay-ins, transfers, conversions, and payouts, as well as refunds of all types and repudiations (from chargebacks).COLLECTED_FEES– Detail of transactions crediting or debiting the fees wallet: successful transactions of all types (pay-ins, transfers, refunds, payouts, etc.) that have a positive or negative fees amount.
Useful for platforms using Echo, Mangopay’s solution for integrations working with third-party PSPs:
ECHO_INTENT– Summary of all intents declared during the selected period, detailing the total funds expected to enter the platform’s technical wallets.ECHO_INTENT_ACTION– Summary of all operations related to intents processed during the selected period, detailing the expected money movements to be escrowed — including payments, refunds, refund reversals, and chargebacks.ECHO_SETTLEMENT– Summary of all settlement files uploaded during the selected period to initiate the reconciliation process, confirming the expected money movements to be escrowed.ECHO_SPLIT– Summary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.
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.
properties
The date before which the wallet was created (based on the wallet’s CreationDate parameter).
Caution: The time range between the BeforeDate and the AfterDate cannot exceed 24 months.
The date after which the wallet was created (based on the wallet’s CreationDate parameter).
Caution: The time range between the BeforeDate and the AfterDate cannot exceed 24 months.
The unique identifier of the user owning the wallet.
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the wallets to take into account.
The balance amount above which the wallets are taken into account.
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the MinBalanceAmount value.
The balance amount below which the wallets are taken into account.
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the MaxBalanceAmount value.
Allowed values: The Columns listed in the Reports article, which differ according to the report type.
The information to be included in the report.
The transaction result codes to be taken into account.
The explanation of the result code.