Wallets report | Mangopay docs

The Wallets report lists user wallets, their owners, descriptions and tags, and their balances at the time of report creation.

You can access this report in the Dashboard in Dashboard (Legacy) > Reporting > + (right side).

The Wallets report is only available in the legacy Dashboard. It also uses a different endpoint and generation flow.

Columns

The Wallets report has the following columns and columns used by default.

Column	Description	Included by default
Id	The unique identifier of the wallet.	Yes
Tag	Custom data that can be added to the wallet.	Yes
CreationDate	The date and time at which the wallet was created in a timestamp format.	Yes
CreationDate:ISO	The date and time at which the wallet was created in the following format: dd/MM/yyyy HH:mm:ss.	No
Owners	The Id of the user attached to the wallet.	Yes
Description	The description of the wallet. It can be a name, a type, anything that can help you clearly identify the wallet on the platform (and for your end users).	Yes
BalanceAmount	The current balance of the wallet.	Yes
BalanceCurrency	The currency of the balance of the wallet.	Yes
Currency	The currency of the wallet.	Yes
FundsType	The type of funds in the wallet, which can be DEFAULT, FEES, or CREDIT.	Yes

Generate via API

Set up callback URL (optional)

If downloading large quantities of data, you may wish to define a URL on which to be notified that the report is ready. In the Wallets report, you can do this in the CallbackURL parameter of the POST Create a Wallets Report endpoint.

Define filters and columns

In the POST Create a Wallets Report endpoint, use the Filters parameter to filter the data to be returned in the report.

The BeforeDate and AfterDate filters refer to the CreationDate of the wallets. This range can’t exceed 24 months.

If no Filters are specified, the report contains all wallets created in the last 1 month.

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 Wallets Report endpoint.

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. It also shows the filters and columns set by default if not sent.

Download when ready

The report is ready for download when its status changes from PENDING to READY_FOR_DOWNLOAD. This event triggers a notification to your CallbackURL (defined in Step 1) with the following format:

https://www.example.com?EventType=REPORT_READY_FOR_DOWNLOAD&ResourceId=ReportId&Date=ReportDate

Using the ReportId as the path parameter, call the legacy GET View a Report endpoint to retrieve the DownloadURL value where you can download the report.

Repeat process as needed

The Wallets report DownloadURL value is valid for 24 hours. After this, the 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.