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

IdstringOptional

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateintegerOptional

Unix timestamp (UTC) of the date and time the object was created.

ReportDateinteger or nullOptional

Unix timestamp (UTC) of the date and time the report was generated.

StatusstringOptional

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).
ResultCodestringOptional

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessagestringOptional
The explanation of the result code.
DownloadFormatstringOptional

Returned values: CSV

The format in which the report is going to be downloaded.

DownloadURLstring or nullOptional

The URL at which the report file can be downloaded when the Status is GENERATED.

ReportTypestringOptional

Returned 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 funds expected on the techncial wallet.
  • ECHO_SPLIT – Summary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.
SortstringOptional
The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date.
DateRangeBystring or nullOptional

Possible values: CreationDate, ExecutionDate

Default value: CreationDate

The date to which BeforeDate and AfterDate apply. The DateRangeBy property can only be sent on USER_WALLET_TRANSACTIONS and COLLECTED_FEES reports. It is returned null for other types.

The ExecutionDate value is likely to be more useful, because this is the date and time that the transaction Status became SUCCEEDED. Note also that these reports only contain successful transactions.

AfterDateintegerOptional

Possible values: Any date and time (before the BeforeDate) between the present and 24 months ago.

The date and time after which the report's transaction was created, based on the transaction's CreationDate.

Note: The period between the AfterDate and the BeforeDate cannot exceed 12 months.

BeforeDateintegerOptional

Possible values: Any date and time (after the AfterDate) between the present and 24 months ago.

The date and time before which the report's transaction was created, based on the transaction's CreationDate.

Note: The period between the AfterDate and the BeforeDate cannot exceed 12 months.

FiltersobjectOptional

The filters sent in the request. Different filters are available for each ReportType.

Columnslist of objectsOptional

Possible values: The columns listed in the Reports guide, which differ according to the report type.

Default values: The default columns listed in the Reports guide, which differ according to the report type.

The data columns to be included in the report.