View a Report

GET

/v2.01/:ClientId/reporting/reports/:ReportingId

GET

/v2.01/:ClientId/reporting/reports/:ReportingId

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

200Retrieved

1 {
2   "Id": "report_01JVVQFJETHHP9M9S18RN6N8JZ",
3   "Tag": "Created using the Mangopay API Postman collection",
4   "CreationDate": 1747908544,
5   "ReportDate": 1747908545,
6   "Status": "GENERATED",
7   "ResultCode": "000000",
8   "ResultMessage": "Success",
9   "DownloadFormat": "CSV",
10   "DownloadURL": "https://reporting-sandbox-downloads.mangopay.com/reporting/user-wallet-transactions-b87d078d-ec6a-41aa-8719-4dc86f341e60-user-id-user_m_01JSM1ZG3MAWR272S99ZKE2WSP-wallet-id-wlt_m_01JSM21JYR8CFM43XREZQS1ZXH.csv?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6IioiLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjE3NTA1NTA0MDB9fX1dfQ__&Signature=TkzN3liwlGu4kLWNWZ2-FRWzwvzYNK2jQAgOmm6MBSl6qiSYOamgGGy~aNCTOWM8sBDgVCveau7W9rqxNajXsJKoVfJbNZYNyDnJlYZt24KMiq0SeBIQ0nLTukr1q-eYOpB7cjVikGetikKNldNUeDYdB3-dqIHUecNpBvRkw9Zoa72cfheznwsrA3XwuHcWpwHdcFHXpz89OD10Fbr75mRKrIqmzb5ecGFRXDjmtBl3UD~iFXyPusDV8UiBAuM6bRinHTenq9Mff4j1~MgTjmSnG7ZSwKsxHG50CJ-G5hhiWtAPgptbwck~2C7Lv7L1Hk1h7u59ZPI0IOh8cXMSKA__&Key-Pair-Id=K16WIKTSLTS2C2",
11   "ReportType": "USER_WALLET_TRANSACTIONS",
12   "Sort": "CreationDate:DESC",
13   "DateRangeBy": "ExecutionDate",
14   "AfterDate": 1740787200,
15   "BeforeDate": 1743465599,
16   "Filters": {
17     "UserId": "user_m_01JSM1ZG3MAWR272S99ZKE2WSP",
18     "WalletId": "wlt_m_01JSM21JYR8CFM43XREZQS1ZXH"
19   },
20   "Columns": [
21     {
22       "Name": "ClientId",
23       "IsDefault": true
24     },
25     {
26       "Name": "TransactionId",
27       "IsDefault": true
28     },
29     {
30       "Name": "CreationDate",
31       "IsDefault": true
32     },
33     {
34       "Name": "ExecutionDate",
35       "IsDefault": true
36     },
37     {
38       "Name": "AuthorId",
39       "IsDefault": true
40     },
41     {
42       "Name": "CreditedUserId",
43       "IsDefault": true
44     },
45     {
46       "Name": "DebitedFundsAmount",
47       "IsDefault": true
48     },
49     {
50       "Name": "DebitedFundsCurrency",
51       "IsDefault": true
52     },
53     {
54       "Name": "CreditedFundsAmount",
55       "IsDefault": true
56     },
57     {
58       "Name": "CreditedFundsCurrency",
59       "IsDefault": true
60     },
61     {
62       "Name": "FeesAmount",
63       "IsDefault": true
64     },
65     {
66       "Name": "FeesCurrency",
67       "IsDefault": true
68     },
69     {
70       "Name": "Type",
71       "IsDefault": true
72     },
73     {
74       "Name": "Nature",
75       "IsDefault": true
76     },
77     {
78       "Name": "CreditedWalletId",
79       "IsDefault": true
80     },
81     {
82       "Name": "DebitedWalletId",
83       "IsDefault": true
84     },
85     {
86       "Name": "BankAccountId",
87       "IsDefault": true
88     },
89     {
90       "Name": "PreauthorizationId",
91       "IsDefault": true
92     },
93     {
94       "Name": "BankWireRef",
95       "IsDefault": true
96     },
97     {
98       "Name": "CardId",
99       "IsDefault": true
100     },
101     {
102       "Name": "CardAlias",
103       "IsDefault": true
104     },
105     {
106       "Name": "CardType",
107       "IsDefault": true
108     },
109     {
110       "Name": "CardCountry",
111       "IsDefault": true
112     },
113     {
114       "Name": "CardExpirationDate",
115       "IsDefault": true
116     },
117     {
118       "Name": "Culture",
119       "IsDefault": true
120     },
121     {
122       "Name": "DeclaredDebitedFundsAmount",
123       "IsDefault": true
124     },
125     {
126       "Name": "DeclaredDebitedFundsCurrency",
127       "IsDefault": true
128     },
129     {
130       "Name": "DeclaredFeesAmount",
131       "IsDefault": true
132     },
133     {
134       "Name": "DeclaredFeesCurrency",
135       "IsDefault": true
136     },
137     {
138       "Name": "ExecutionType",
139       "IsDefault": true
140     },
141     {
142       "Name": "PaymentType",
143       "IsDefault": true
144     },
145     {
146       "Name": "WireReference",
147       "IsDefault": true
148     }
149   ]
150 }

Retrieve a report from the Reporting Service

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.

ReportingIdstringRequired

The unique identifier of the Reporting Service report.

Response

Success

Idstring

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

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

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

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

ResultCodestring

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessagestring

The explanation of the result code.

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.

ReportTypestring

Returned values: COLLECTED_FEES, USER_WALLET_TRANSACTIONS, ECHO_INTENT, ECHO_INTENT_ACTION, ECHO_SETTLEMENT, ECHO_SPLIT

The type of the report. Each ReportType has different available Columns and Filters.

Useful for all platforms:

USER_WALLET_TRANSACTIONS – All successful transactions crediting or debiting user wallets: pay-ins, transfers, conversions, and payouts, as well as refunds of all types and repudiations (from chargebacks).
COLLECTED_FEES– Detail of transactions crediting or debiting the fees wallet: successful transactions of all types (pay-ins, transfers, refunds, payouts, etc.) that have a positive or negative fees amount.

Useful for platforms using Echo, Mangopay’s solution for integrations working with third-party PSPs:

ECHO_INTENT – Summary of all intents declared during the selected period, detailing the total funds expected to enter the platform’s technical wallets.
ECHO_INTENT_ACTION – Summary of all operations related to intents processed during the selected period, detailing the expected money movements to be escrowed — including payments, refunds, refund reversals, and chargebacks.
ECHO_SETTLEMENT – Summary of all settlement files uploaded during the selected period to initiate the reconciliation process, confirming the funds expected on the techncial wallet.
ECHO_SPLIT – Summary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.

Sortstring

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

DateRangeBystring or null

Possible values: CreationDate, ExecutionDate

Default value: CreationDate

The date to which BeforeDate and AfterDate apply. The DateRangeBy property can only be sent on USER_WALLET_TRANSACTIONS and COLLECTED_FEES reports. It is returned null for other types.

The ExecutionDate value is likely to be more useful, because this is the date and time that the transaction Status became SUCCEEDED. Note also that these reports only contain successful transactions.

AfterDateinteger

Possible values: Any date and time (before the BeforeDate) between the present and 24 months ago.

The date and time after which the report’s transaction was created, based on the transaction’s CreationDate.

Note: The period between the AfterDate and the BeforeDate cannot exceed 12 months.

BeforeDateinteger

Possible values: Any date and time (after the AfterDate) between the present and 24 months ago.

The date and time before which the report’s transaction was created, based on the transaction’s CreationDate.

Note: The period between the AfterDate and the BeforeDate cannot exceed 12 months.

Filtersobject

The filters sent in the request. Different filters are available for each ReportType.

Columnslist of objects

Possible values: The columns listed in the Reports guide, which differ according to the report type.

Default values: The default columns listed in the Reports guide, which differ according to the report type.

The data columns to be included in the report.