ReportType
) that may be useful to all platforms: USER_WALLET_TRANSACTIONS
and COLLECTED_FEES
.
There are 4 ReportType
that are designed to support platforms using Echo, Mangopay solution for integrations working with third-party PSPs: ECHO_INTENT
, ECHO_INTENT_ACTION
, ECHO_SETTLEMENT
, ECHO_SPLIT
.
Each ReportType
has different available Columns
and Filters
.
Note – Report expires after 31 daysA Reporting Service report expires after 31 days, at which point it can no longer be downloaded. On expiry, the report’s
Status
becomes EXPIRED
and the DownloadURL
becomes null
.You can generate a new report with the same filters and dates.Body parameters
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.
Possible values:
CSV
The format of the report file.Possible 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 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: transactions of all types (pay-ins, transfers, refunds, payouts, etc.) that have a positive or negative fees amount.
ECHO_INTENT
– Summary of all intents declared during the selected period, detailing the total funds expected to enter the platform’s escrow 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 expected money movements to be escrowed.ECHO_SPLIT
– Summary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.
Possible values:
CreationDate:ASC
, CreationDate:DESC
Default value: CreationDate:DESC
The sort direction based on transaction creation date.Possible values: Any past date and time up 24 months ago that is earlier than the
BeforeDate
by less than 12 monthsThe date and time after which the report’s transaction was created, based on the transaction’s CreationDate
.Possible values: Any past date and time up 24 months ago that is later than the
AfterDate
by less than 12 monthsThe date and time before which the report’s transaction was created, based on the transaction’s CreationDate
.The filers to apply. Each
ReportType
has different available filters:The
Currency
filter is available. If not specified, the report contains data on all currencies.Responses
200 - Response parameters
200 - Response parameters
Max length: 128 characters (see data formats for details)The unique identifier of the object.
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.
The date and time at which the object was created.
The date and time at which the report was generated.
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).
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
Returned values:
CSV
The format in which the report is going to be downloaded.The URL at which the report file can be downloaded when the
Status
is GENERATED
.Possible 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 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: transactions of all types (pay-ins, transfers, refunds, payouts, etc.) that have a positive or negative fees amount.
ECHO_INTENT
– Summary of all intents declared during the selected period, detailing the total funds expected to enter the platform’s escrow 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 expected money movements to be escrowed.ECHO_SPLIT
– Summary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.
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.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.The filters sent in the request. Different filters are available for each
ReportType
.400 - WalletId and Currency filters can't be combined
400 - WalletId and Currency filters can't be combined
400 - Max. 12 months between AfterDate and BeforeDate
400 - Max. 12 months between AfterDate and BeforeDate
Invalid Column for ReportType
Invalid Column for ReportType