View a Report

GET

/v2.01/:ClientId/reports/:ReportId

GET

/v2.01/:ClientId/reports/:ReportId

$ curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/reports/{ReportId} \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "Id": "report_m_01JFA0JQQJ1X6W6VT6042SASTC",
3   "CreationDate": 1734429204,
4   "Tag": "Created using Mangopay API Postman Collection",
5   "ReportDate": 1734429204,
6   "Status": "READY_FOR_DOWNLOAD",
7   "DownloadFormat": "CSV",
8   "DownloadURL": "https://downloads.sandbox.mangopay.com/85565d93430945388122986252982648.csv?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6IioiLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjE3MzQ1MTU2MDR9fX1dfQ__&Signature=YvcEtwjbs2hR4mOb2UuGICdh082lFrCjS1XtwJ~Zem7~vDc8bPPo-2kBA-Neb0Hs7V9gApR5mJ9B6RPOgDzKKdBEVD4iBS066eNYIymuW2fY5IXjfuzFgv0id5yi2ynFcmX02sgSgd9WGChYpUTBH36R-McNbAPG3viOu8FZ5LM9IWR44qnMwrM-8IWXPBpg9yh7uZy6ehDjJpoi9tswNnzt445vpORRMF3clMl~tRel59EcsMV73c-~B1Qvd9inBa6msh6eww~kkcP5FE~MCr4oQ-DsX0lZPAXLoSOJNbhOotNqKgwlBrYwAT1gLV510kUlbJy~4bPDmmsgbSqETw__&Key-Pair-Id=K21K4XKUJZ74AO",
9   "CallbackURL": null,
10   "ReportType": "TRANSACTIONS",
11   "Sort": "CreationDate:ASC",
12   "Preview": false,
13   "Filters": {
14     "BeforeDate": 1658317644,
15     "AfterDate": 1655725644,
16     "Type": [],
17     "ResultCode": [],
18     "Status": [],
19     "Nature": [],
20     "WalletId": null,
21     "AuthorId": null,
22     "MinDebitedFundsAmount": null,
23     "MinDebitedFundsCurrency": null,
24     "MaxDebitedFundsAmount": null,
25     "MaxDebitedFundsCurrency": null,
26     "MinFeesAmount": null,
27     "MinFeesCurrency": null,
28     "MaxFeesAmount": null,
29     "MaxFeesCurrency": null
30   },
31   "Columns": [
32     "Id",
33     "Tag",
34     "CreationDate",
35     "ExecutionDate",
36     "AuthorId",
37     "CreditedUserId",
38     "DebitedFundsAmount",
39     "DebitedFundsCurrency",
40     "CreditedFundsAmount",
41     "CreditedFundsCurrency",
42     "FeesAmount",
43     "FeesCurrency",
44     "Status",
45     "ResultCode",
46     "ResultMessage",
47     "Type",
48     "Nature",
49     "CreditedWalletId",
50     "DebitedWalletId"
51   ],
52   "ResultCode": "000000",
53   "ResultMessage": "Success"
54 }

Retrieve a legacy report

Authentication

AuthorizationBearer

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.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

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

ReportIdstringRequired

The unique identifier of the legacy report.

Response

Success

Idstring

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

The unique identifier of the object.

CreationDateinteger

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

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

ReportDateinteger or null

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

DownloadFormatstring

Returned values: CSV

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

DownloadURLstring or null

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

CallbackURLstring

Max. length: 255 characters

The URL to which the notification indicating that the report is ready to be downloaded will be sent.

ReportTypestring

Returned values: TRANSACTIONS, WALLETS

The type of the report, indicating whether it lists transactions or wallets.

Sortstring

The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date.

Previewboolean

Whether the report is limited to the first 10 lines (and therefore quicker to generate).

Filtersobject

The filtering parameters to optimize the report.

Columnslist of strings

Returned values: The Columns listed in the Reports article, which differ according to the report type.

The information to be included in the report.

ResultCodelist of strings

The transaction result codes to be taken into account.

ResultMessagestring

The explanation of the result code.