Echo reports | Mangopay docs

Mangopay Echo provides 4 report types that give your platform full visibility on your declared intents, the payment lifecycle, reconciliation in settlements, and the subsequent splits to sellers.

You can access these reports in the Dashboard in Reports > Fees wallets tab. Contact your platform’s Dashboard admin if you don’t see the Reports feature in the side navigation.

In the Dashboard, as well as running reports manually, you can schedule reports to be generated automatically at regular intervals, such as daily, weekly, monthly, and quarterly.

Types and columns

Intents

Name	Echo Intent
Description	Summary of all intents declared during the selected period, detailing the total funds expected to enter the platform’s technical wallets.
Data available from	January 1 of the previous calendar year (N-1)
Max date range	1 year

Columns

Column	Description	Included by default
Id	Unique identifier of the intent	Yes
Status	Status of the intent	Yes
Amount	Amount of the debited funds in the currency of the debited amount	Yes
Currency	Currency of the debited amount	Yes
FeesAmount	Amount of the fees in the currency of the fees	Yes
FeesCurrency	Currency of the fees	Yes
Type	Type of the intent: PAYIN, REFUND, DISPUTE	Yes
PaymentMethod	Payment method of the intent	Yes
BuyerId	Unique identifier of the user at the source of the transaction	Yes
SellerId	Unique identifier of the user(s) at the destination of the transaction	Yes

Intent actions

Name	Echo Intent Action
Description	Summary of all operations related to intents processed during the selected period, detailing the expected money movements to be escrowed — including payments, refunds (and reversals), and disputes.
Data available from	January 1 of the previous calendar year (N-1)
Max date range	1 year

Columns

Column	Description	Included by default
IntentId	Unique identifier of the intent	Yes
Id	Unique identifier of the intent action (capture, refund, dispute, cancel)	Yes
ExternalProcessingDate	Unix timestamp of the date and time at which the intent was executed	Yes
ExternalProviderReference	Unique identifier of the intent in the external provider system	Yes
ExternalMerchantReference	Unique identifier of the intent in the merchant system	Yes
Status	Status of the intent action	Yes
Amount	Amount of the debited funds in the currency of the debited amount	Yes
Currency	Currency of the debited amount	Yes
FeesAmount	Amount of the fees in the currency of the fees	Yes
FeesCurrency	Currency of the fees	Yes
Type	Type of the intent: PAYIN, REFUND, DISPUTE	Yes
PaymentMethod	Payment method of the intent	Yes
BuyerId	Unique identifier of the user at the source of the transaction	Yes
SellerId	Unique identifier of the user(s) at the destination of the transaction	Yes

Settlements

Name	Echo Settlement
Description	Summary of all settlement files uploaded during the selected period to initiate the reconciliation process, confirming the funds expected on the techncial wallet.
Data available from	January 1 of the previous calendar year (N-1)
Max date range	1 year

Columns

Column	Description	Included by default
Id	Unique identifier of the settlement	Yes
CreationDate	Unix timestamp of the date and time at which the settlement was created	Yes
CreationDate:ISO	ISO format of the date and time at which the settlement was created	No
FileName	Name of settlement file	Yes
SettlementCurrency	Currency of the settlement	Yes
Status	Status of the settlement	Yes
SettledTransactionCount	Total number of intents that have been reconciled	Yes
UnsettledTransactionCount	Total number of intents that haven’t been reconciled	Yes
SettledAmount	Total amount of intents that have been reconciled	Yes
DeclaredAmount	Total amount of intents that have been declared	Yes
DeficitAmount	The difference between `DeclaredAmount` and `SettledAmount	Yes

Splits

Name	Echo Splits
Description	Summary of all splits related to intents during the selected period, detailing the transfer of funds to the declared destination.
Data available from	January 1 of the previous calendar year (N-1)
Max date range	1 year

Columns

Column	Description	Included by default
Id	Unique identifier of the split	Yes
IntentId	Unique identifier of the intent	Yes
AuthorId	Unique identifier of the user at the source of the split	Yes
Amount	Amount of the credited funds in the currency of the credited amount	Yes
Currency	Currency of the credited amount	Yes
FeesAmount	Amount of the fees in the currency of the fees	Yes
FeesCurrency	Currency of the fees	Yes
Status	Status of the split	Yes
Description	Description of the split	Yes
CreditedWalletId	Unique identifier of the credited wallet	Yes
DebitedWalletId	Unique identifier of the debited wallet	Yes
Scheduled	Whether or not `TransferDate` was sent in the intent or split	Yes
CreationDate	Unix timestamp of the date and time at which the split was created	Yes
CreationDate:ISO	ISO format of the date and time at which the split was created	No
ExecutionDate	Unix timestamp of the date and time at which the split was executed	Yes
ExecutionDate:ISO	ISO format of the date and time at which the split was executed	No

Generate via API

Set up webhooks

The API endpoint for the Echo reports uses webhooks to notify your chosen URL that a report is ready for download.

The time it takes for a report to be generated depends on the quantity of data. If exporting large amounts of data via API, ensure you have these webhook event types set up to know when to fetch the report:

REPORT_GENERATED – Indicates that a report is ready for download at the DownloadURL
REPORT_FAILED – Indicates that a report was not generated successfully

Define filters and columns

The available sub-parameters of the Filters parameter for the Echo reports depend on the type, which is defined in the ReportType field.

Intents and actions

Settlements

Splits

All available columns are set by default on the Echo reports. You can customize this in the Columns parameter by sending the full list of columns you wish to see in the report.

Run the report

Run the report by calling the POST Create a Report endpoint and setting the relevant ReportType.

Send your desired date period in the AfterDate and BeforeDate fields, which refer to the object CreationDate for Echo reports. Ensure that the difference between them is no more than 12 months and the AfterDate is not earlier than January 1 of the previous calendar year (N-1).

Send your defined filters in the Filters parameter and, if not using the default columns, the full list of columns you wish to include in the Columns parameter.

The API response shows the Status as PENDING, indicating that the report is being generated.

Download when ready

The report is ready for download when its status changes from PENDING to GENERATED, which triggers the REPORT_GENERATED webhook.

Call the GET View a Report endpoint to retrieve the DownloadURL value where you can download the report.

If the Status changes to FAILED, triggering the REPORT_FAILED webhook, then more information about why the report could not be generated is available in the ResultCode and ResultMessage.

Repeat process as needed

All Echo reports are valid for 31 days. After this, the Status changes to EXPIRED at it is no longer available for download.

You can re-generate another report with the same parameters and update the date range for the latest period.