Platform fees report | Mangopay docs

The Collected Fees report lists all transactions crediting or debiting your platform’s Fees Wallet: successful pay-ins, transfers, refunds, and payouts where your platform has set a positive or negative FEES amount.

The Collected Fees report provides historical data from January 1 of the previous calendar year (N-1) through to the present (N). The maximum period of data the report can contain is 1 year.

You can access this report in the Dashboard in Reports > Fees wallets tab. Contact your platform’s Dashboard admin if you don’t see the Reports feature in the side navigation.

In the Dashboard, as well as running reports manually, you can schedule reports to be generated automatically at regular intervals, such as daily, weekly, monthly, and quarterly.

Columns

The Collected Fees report has the following available columns and columns used by default.

Column	Description	Included by default
ClientId	Unique identifier associated with the API key	Yes
TransactionId	Unique identifier of the transaction	Yes
CreationDate	Unix timestamp of the date and time at which the transaction was created	Yes
CreationDate:ISO	ISO format of the date and time at which the transaction was created	No
ExecutionDate	Unix timestamp of the date and time at which the transaction was executed	Yes
ExecutionDate:ISO	ISO format of the date and time at which the transaction was executed	No
AuthorId	Unique identifier of the user at the source of the transaction	Yes
DebitedWalletId	Unique identifier of the debited wallet	Yes
CreditedWalletId	Unique identifier of the credited wallet	Yes
CreditedFundsCurrency	Currency of the credited amount	Yes
CreditedFundsAmount	Amount of the credited funds in the currency of the credited amount	Yes
DebitedFundsCurrency	Currency of the debited amount	Yes
DebitedFundsAmount	Amount of the debited funds in the currency of the debited amount	Yes
FeesAmount	Amount of the fees in the currency of the fees	Yes
FeesCurrency	Currency of the fees	Yes
Type	Type of the transaction: PAYIN, TRANSFER, CONVERSION, PAYOUT	Yes
Nature	Nature of the transaction: REGULAR, REPUDIATION, REFUND, SETTLEMENT	Yes
PaymentType	Payment type of the pay-in	Yes
Tag	Custom data added to the object	Yes

Generate via API

Set up webhooks

The API endpoint for the Collected Fees report uses webhooks to notify your chosen URL that a report is ready for download.

The time it takes for a report to be generated depends on the quantity of data. If exporting large amounts of data via API, ensure you have these webhook event types set up to know when to fetch the report:

REPORT_GENERATED – Indicates that a report is ready for download at the DownloadURL
REPORT_FAILED – Indicates that a report was not generated successfully

Define filters and columns

The Collected Fees report can be filtered by:

Currency – Filter the report to the Fees Wallet of one currency.

If the currency filter is not sent, the report contains data on all currencies.

The columns set by default are listed above. You can customize this in the Columns parameter by sending the full list of columns you wish to see in the report.

Run the report

Run the report by calling the POST Create a Report endpoint with the ReportType set to COLLECTED_FEES.

Send your desired date period in the AfterDate and BeforeDate fields, which refers to the transaction CreationDate. Ensure that the difference between them is no more than 12 months and the AfterDate is not earlier than January 1 of the previous calendar year (N-1).

Send your defined filters in the Filters parameter and, if not using the default columns, the full list of columns you wish to include in the Columns parameter. The API response shows the Status as PENDING, indicating that the report is being generated.

Download when ready

The report is ready for download when its status changes from PENDING to GENERATED, which triggers the REPORT_GENERATED webhook.

Call the GET View a Report endpoint to retrieve the DownloadURL value where you can download the report.

If the Status changes to FAILED, triggering the REPORT_FAILED webhook, then more information about why the report could not be generated is available in the ResultCode and ResultMessage.

Repeat process as needed

The Collected Fees report is valid for 31 days. After this, its Status changes to EXPIRED at it is no longer available for download.

You can re-generate another report with the same parameters and update the date range for the latest period.

Note – You can schedule reports in the Dashboard

The Dashboard features a scheduling feature that enables you to automatically generate the same report daily, weekly, monthly, or quarterly.