Sign in

v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
Reporting

Create a Report

Generate a reporting service report

This endpoint generates a report from Mangopay's Reporting Service, which is replacing the legacy report types (read the guide).

There are 2 reports (indicated by ReportType) that may be useful to all platforms: USER_WALLET_TRANSACTIONS and COLLECTED_FEES.

There are 4 ReportType that are designed to support platforms using Echo, Mangopay solution for integrations working with third-party PSPs: ECHO_INTENT, ECHO_INTENT_ACTION, ECHO_SETTLEMENT, ECHO_SPLIT.

Each ReportType has different available Columns and Filters.

<Note icon="fa-regular fa-circle-info"> **Note – Report expires after 31 days**

A Reporting Service report expires after 31 days, at which point it can no longer be downloaded. On expiry, the report's Status becomes EXPIRED and the DownloadURL becomes null.

You can generate a new report with the same filters and dates. </Note>

post/v2.01/{ClientId}/reporting/reports

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

Headers

Authorizationstring required

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Request body

OR
OR
OR
OR
OR

Response

Success

Idstring

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

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

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

ReportDateinteger nullable

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

Statusstring

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

The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.

ResultMessagestring

The explanation of the result code.

DownloadFormatstring

Returned values: CSV

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

DownloadURLstring nullable

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

ReportTypestring

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.
Sortstring

Possible values: CreationDate:ASC, CreationDate:DESC

Default value: CreationDate:DESC

The sort direction based on transaction creation date.

DateRangeBystring nullable

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.

AfterDateinteger

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.

BeforeDateinteger

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.

FiltersCreateAReportResponseFilters

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