Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
Create a Wallets Report
{
"Tag": "Created using Mangopay API Postman Collection",
"DownloadFormat": "CSV",
"CallbackURL": null,
"Sort": "CreationDate:ASC",
"Preview": false,
"Filters": {
"BeforeDate": 1658838931,
"AfterDate": 1656246931,
"OwnerId": null,
"Currency": null,
"MinBalanceAmount": null,
"MinBalanceCurrency": null,
"MaxBalanceAmount": null,
"MaxBalanceCurrency": null
},
"Columns": [
"Id",
"Tag",
"CreationDate",
"Owners",
"Description",
"BalanceAmount",
"BalanceCurrency",
"Currency",
"FundsType"
]
}
{
"Id": "report_m_01JFA0QC7K9CJ339JX4KV08CMW",
"CreationDate": 1734429356,
"Tag": "Created using Mangopay API Postman Collection",
"ReportDate": null,
"Status": "PENDING",
"DownloadFormat": "CSV",
"DownloadURL": null,
"CallbackURL": null,
"ReportType": "WALLETS",
"Sort": "CreationDate:ASC",
"Preview": false,
"Filters": {
"BeforeDate": 1658838931,
"AfterDate": 1656246931,
"OwnerId": null,
"Currency": null,
"MinBalanceAmount": null,
"MinBalanceCurrency": null,
"MaxBalanceAmount": null,
"MaxBalanceCurrency": null
},
"Columns": [
"Id",
"Tag",
"CreationDate",
"Owners",
"Description",
"BalanceAmount",
"BalanceCurrency",
"Currency",
"FundsType"
],
"ResultCode": null,
"ResultMessage": null
}
Note – Report expiration date
A report expires after 24 hours (i.e., you can no longer download it after this delay). You can still generate a new report with the same filters and information easily.
Body parameters
Max. length: 255 characters
Custom data that you can add to this object.
For reports, this parameter can be useful to give the report a name.
Allowed values: CSV
The format in which the report is going to be downloaded.
Max. length: 255 characters
The URL to which the notification indicating that the report is ready to be downloaded will be sent.
Allowed values: CreationDate:ASC, CreationDate:DESC
The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date.
Whether the report is limited to the first 10 lines (and therefore quicker to generate).
The filtering parameters to optimize the report.
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.
Responses
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 reports, this parameter can be useful to give the report a name.
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).
Returned values: CSV
The format in which the report is going to be downloaded.
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.
The type of the report, indicating whether it lists transactions or wallets.
The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date.
Whether the report is limited to the first 10 lines (and therefore quicker to generate).
The filtering parameters to optimize the report.
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.
Returned 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.
Returned 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.
Returned 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.
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "23ca4f5b-6d35-45d0-8bde-c8424885a2e9",
"Date": 1715353491.0,
"errors": {
"Filters.AfterDate": "This report type can only be done for a date range of a maximum of 24 months."
}
}
{
"Id": "report_m_01JFA0QC7K9CJ339JX4KV08CMW",
"CreationDate": 1734429356,
"Tag": "Created using Mangopay API Postman Collection",
"ReportDate": null,
"Status": "PENDING",
"DownloadFormat": "CSV",
"DownloadURL": null,
"CallbackURL": null,
"ReportType": "WALLETS",
"Sort": "CreationDate:ASC",
"Preview": false,
"Filters": {
"BeforeDate": 1658838931,
"AfterDate": 1656246931,
"OwnerId": null,
"Currency": null,
"MinBalanceAmount": null,
"MinBalanceCurrency": null,
"MaxBalanceAmount": null,
"MaxBalanceCurrency": null
},
"Columns": [
"Id",
"Tag",
"CreationDate",
"Owners",
"Description",
"BalanceAmount",
"BalanceCurrency",
"Currency",
"FundsType"
],
"ResultCode": null,
"ResultMessage": null
}
{
"Tag": "Created using Mangopay API Postman Collection",
"DownloadFormat": "CSV",
"CallbackURL": null,
"Sort": "CreationDate:ASC",
"Preview": false,
"Filters": {
"BeforeDate": 1658838931,
"AfterDate": 1656246931,
"OwnerId": null,
"Currency": null,
"MinBalanceAmount": null,
"MinBalanceCurrency": null,
"MaxBalanceAmount": null,
"MaxBalanceCurrency": null
},
"Columns": [
"Id",
"Tag",
"CreationDate",
"Owners",
"Description",
"BalanceAmount",
"BalanceCurrency",
"Currency",
"FundsType"
]
}
Was this page helpful?
{
"Tag": "Created using Mangopay API Postman Collection",
"DownloadFormat": "CSV",
"CallbackURL": null,
"Sort": "CreationDate:ASC",
"Preview": false,
"Filters": {
"BeforeDate": 1658838931,
"AfterDate": 1656246931,
"OwnerId": null,
"Currency": null,
"MinBalanceAmount": null,
"MinBalanceCurrency": null,
"MaxBalanceAmount": null,
"MaxBalanceCurrency": null
},
"Columns": [
"Id",
"Tag",
"CreationDate",
"Owners",
"Description",
"BalanceAmount",
"BalanceCurrency",
"Currency",
"FundsType"
]
}
{
"Id": "report_m_01JFA0QC7K9CJ339JX4KV08CMW",
"CreationDate": 1734429356,
"Tag": "Created using Mangopay API Postman Collection",
"ReportDate": null,
"Status": "PENDING",
"DownloadFormat": "CSV",
"DownloadURL": null,
"CallbackURL": null,
"ReportType": "WALLETS",
"Sort": "CreationDate:ASC",
"Preview": false,
"Filters": {
"BeforeDate": 1658838931,
"AfterDate": 1656246931,
"OwnerId": null,
"Currency": null,
"MinBalanceAmount": null,
"MinBalanceCurrency": null,
"MaxBalanceAmount": null,
"MaxBalanceCurrency": null
},
"Columns": [
"Id",
"Tag",
"CreationDate",
"Owners",
"Description",
"BalanceAmount",
"BalanceCurrency",
"Currency",
"FundsType"
],
"ResultCode": null,
"ResultMessage": null
}