POST
/
v2.01
/
{ClientId}
/
reports
/
transactions
{
    "Tag": "Created using Mangopay API Postman Collection",
    "DownloadFormat": "CSV",
    "CallbackURL": null,
    "Sort": "CreationDate:ASC",
    "Preview": false,
    "Filters": {
        "BeforeDate": 1658317644,
        "AfterDate": 1655725644,
        "Type": [],
        "ResultCode": [],
        "Status": [],
        "Nature": [],
        "WalletId": null,
        "AuthorId": null,
        "MinDebitedFundsAmount": null,
        "MinDebitedFundsCurrency": null,
        "MaxDebitedFundsAmount": null,
        "MaxDebitedFundsCurrency": null,
        "MinFeesAmount": null,
        "MinFeesCurrency": null,
        "MaxFeesAmount": null,
        "MaxFeesCurrency": null
    },
    "Columns": [
        "Id",
        "Tag",
        "CreationDate",
        "ExecutionDate",
        "AuthorId",
        "CreditedUserId",
        "DebitedFundsAmount",
        "DebitedFundsCurrency",
        "CreditedFundsAmount",
        "CreditedFundsCurrency",
        "FeesAmount",
        "FeesCurrency",
        "Status",
        "ResultCode",
        "ResultMessage",
        "Type",
        "Nature",
        "CreditedWalletId",
        "DebitedWalletId"
    ]
}

{
    "Id": "report_m_01JFA0JQQJ1X6W6VT6042SASTC",
    "CreationDate": 1734429204,
    "Tag": "Created using Mangopay API Postman Collection",
    "ReportDate": null,
    "Status": "PENDING",
    "DownloadFormat": "CSV",
    "DownloadURL": null,
    "CallbackURL": null,
    "ReportType": "TRANSACTIONS",
    "Sort": "CreationDate:ASC",
    "Preview": false,
    "Filters": {
        "BeforeDate": 1658317644,
        "AfterDate": 1655725644,
        "Type": [],
        "ResultCode": [],
        "Status": [],
        "Nature": [],
        "WalletId": null,
        "AuthorId": null,
        "MinDebitedFundsAmount": null,
        "MinDebitedFundsCurrency": null,
        "MaxDebitedFundsAmount": null,
        "MaxDebitedFundsCurrency": null,
        "MinFeesAmount": null,
        "MinFeesCurrency": null,
        "MaxFeesAmount": null,
        "MaxFeesCurrency": null
    },
    "Columns": [
        "Id",
        "Tag",
        "CreationDate",
        "ExecutionDate",
        "AuthorId",
        "CreditedUserId",
        "DebitedFundsAmount",
        "DebitedFundsCurrency",
        "CreditedFundsAmount",
        "CreditedFundsCurrency",
        "FeesAmount",
        "FeesCurrency",
        "Status",
        "ResultCode",
        "ResultMessage",
        "Type",
        "Nature",
        "CreditedWalletId",
        "DebitedWalletId"
    ],
    "ResultCode": null,
    "ResultMessage": null
}
Note – Report expiration dateA report expires after 24 hours (i.e., you can no longer download it after this period). You can still generate a new report with the same filters and information easily.
Note – BeforeDate value restrictionTo ensure that data provided on each report are up-to-date, the BeforeDate parameter cannot be greater than the report creation date minus 5 minutes. If it is, BeforeDate will be automatically set according to this constraint.

​
Body parameters

​
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.For reports, this parameter can be useful to give the report a name.
​
DownloadFormat
string
Possible values: CSVThe format of the report file.
​
CallbackURL
string
Max. length: 255 charactersThe URL to which the notification indicating that the report is ready to be downloaded will be sent.
​
Sort
string
Possible values: CreationDate:ASC, CreationDate:DESCDefault value: CreationDate:ASCThe sort direction based on transaction creation date.
​
Preview
boolean
Whether the report is limited to the first 10 lines (and therefore quicker to generate).
​
Filters
object
The filtering parameters to optimize the report.
​
Columns
array
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

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.For reports, this parameter can be useful to give the report a name.
​
ReportDate
Unix timestamp | null
The date and time at which the report was generated.
​
Status
string
Returned values: PENDING, READY_FOR_DOWNLOAD, FAILED, EXPIREDThe 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).
​
DownloadFormat
string
Returned values: CSVThe format in which the report is going to be downloaded.
​
DownloadURL
string | null
The URL at which the report file can be downloaded when the Status is GENERATED.
​
CallbackURL
string
Max. length: 255 charactersThe URL to which the notification indicating that the report is ready to be downloaded will be sent.
​
ReportType
string
The type of the report, indicating whether it lists transactions or wallets.
​
Sort
string
The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date.
​
Preview
boolean
Whether the report is limited to the first 10 lines (and therefore quicker to generate).
​
Filters
object
The filtering parameters to optimize the report.
​
Columns
array
Returned values: The Columns listed in the Reports article, which differ according to the report type.The information to be included in the report.
​
ResultCode
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
​
ResultMessage
string
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": "3b84cf5d-1195-4753-9ae2-0922e35dbfd4",
    "Date": 1716558597.0,
    "errors": {
        "Filters.AfterDate": "This report type can only be done for the last 36 months."
    }
}

{
    "Id": "report_m_01JFA0JQQJ1X6W6VT6042SASTC",
    "CreationDate": 1734429204,
    "Tag": "Created using Mangopay API Postman Collection",
    "ReportDate": null,
    "Status": "PENDING",
    "DownloadFormat": "CSV",
    "DownloadURL": null,
    "CallbackURL": null,
    "ReportType": "TRANSACTIONS",
    "Sort": "CreationDate:ASC",
    "Preview": false,
    "Filters": {
        "BeforeDate": 1658317644,
        "AfterDate": 1655725644,
        "Type": [],
        "ResultCode": [],
        "Status": [],
        "Nature": [],
        "WalletId": null,
        "AuthorId": null,
        "MinDebitedFundsAmount": null,
        "MinDebitedFundsCurrency": null,
        "MaxDebitedFundsAmount": null,
        "MaxDebitedFundsCurrency": null,
        "MinFeesAmount": null,
        "MinFeesCurrency": null,
        "MaxFeesAmount": null,
        "MaxFeesCurrency": null
    },
    "Columns": [
        "Id",
        "Tag",
        "CreationDate",
        "ExecutionDate",
        "AuthorId",
        "CreditedUserId",
        "DebitedFundsAmount",
        "DebitedFundsCurrency",
        "CreditedFundsAmount",
        "CreditedFundsCurrency",
        "FeesAmount",
        "FeesCurrency",
        "Status",
        "ResultCode",
        "ResultMessage",
        "Type",
        "Nature",
        "CreditedWalletId",
        "DebitedWalletId"
    ],
    "ResultCode": null,
    "ResultMessage": null
}

{
    "Tag": "Created using Mangopay API Postman Collection",
    "DownloadFormat": "CSV",
    "CallbackURL": null,
    "Sort": "CreationDate:ASC",
    "Preview": false,
    "Filters": {
        "BeforeDate": 1658317644,
        "AfterDate": 1655725644,
        "Type": [],
        "ResultCode": [],
        "Status": [],
        "Nature": [],
        "WalletId": null,
        "AuthorId": null,
        "MinDebitedFundsAmount": null,
        "MinDebitedFundsCurrency": null,
        "MaxDebitedFundsAmount": null,
        "MaxDebitedFundsCurrency": null,
        "MinFeesAmount": null,
        "MinFeesCurrency": null,
        "MaxFeesAmount": null,
        "MaxFeesCurrency": null
    },
    "Columns": [
        "Id",
        "Tag",
        "CreationDate",
        "ExecutionDate",
        "AuthorId",
        "CreditedUserId",
        "DebitedFundsAmount",
        "DebitedFundsCurrency",
        "CreditedFundsAmount",
        "CreditedFundsCurrency",
        "FeesAmount",
        "FeesCurrency",
        "Status",
        "ResultCode",
        "ResultMessage",
        "Type",
        "Nature",
        "CreditedWalletId",
        "DebitedWalletId"
    ]
}