List all Reports - Mangopay docs

// GET has no body parameters

[
    {
        "Id": "report_01JW6854FGRG1JVVSEWZP4B20C",
        "ReportType": "COLLECTED_FEES",
        "Status": "GENERATING",
        "LastUpdated": 1748261573,
        "CreationDate": 1748261573,
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": null,
        "ResultMessage": null
    },
    {
        "Id": "report_01JVYRQHQ7G5VKGA6SM0EEVVA5",
        "ReportType": "USER_WALLET_TRANSACTIONS",
        "Status": "GENERATED",
        "LastUpdated": 1748010518,
        "CreationDate": 1748010518,
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": "000000",
        "ResultMessage": "Success"
    },
        {
        "Id": "report_01JR92549WWKAP2G1WW0DRAC80",
        "ReportType": "USER_WALLET_TRANSACTIONS",
        "Status": "EXPIRED",
        "LastUpdated": 1746739535,
        "CreationDate": 1744060977,
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": "000000",
        "ResultMessage": "Success"
    }
]

GET

v2.01

{ClientId}

reporting

reports

// GET has no body parameters

[
    {
        "Id": "report_01JW6854FGRG1JVVSEWZP4B20C",
        "ReportType": "COLLECTED_FEES",
        "Status": "GENERATING",
        "LastUpdated": 1748261573,
        "CreationDate": 1748261573,
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": null,
        "ResultMessage": null
    },
    {
        "Id": "report_01JVYRQHQ7G5VKGA6SM0EEVVA5",
        "ReportType": "USER_WALLET_TRANSACTIONS",
        "Status": "GENERATED",
        "LastUpdated": 1748010518,
        "CreationDate": 1748010518,
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": "000000",
        "ResultMessage": "Success"
    },
        {
        "Id": "report_01JR92549WWKAP2G1WW0DRAC80",
        "ReportType": "USER_WALLET_TRANSACTIONS",
        "Status": "EXPIRED",
        "LastUpdated": 1746739535,
        "CreationDate": 1744060977,
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": "000000",
        "ResultMessage": "Success"
    }
]

Query parameters

Status

string

Possible values: PENDING, GENERATING, GENERATED, EXPIRED, FAILEDThe status of the report:

PENDING – The report generation request was accepted but is not yet being processed.
GENERATING – The report is being generated.
GENERATED – The report is ready for download at the DownloadURL
EXPIRED – The report has expired and is no longer available for download.
FAILED – Report generation was not successful.

BeforeDate

Unix timestamp

The date before which the report was created (based on the report’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

AfterDate

Unix timestamp

The date after which the report was created (based on the report’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

per_page

integer

Min. value: 1; max. value: 100Default value: 10Indicates the number of items returned for each page of the pagination.

page

integer

Start value: 1Default value: 1Indicates the index of the page for the pagination.

Responses

200

Array (Reports)

array

The list of reports created by the platform.

Show properties

Object (reports)

object

Key data about the Reporting Service report object created by the platform.

Show properties

string

Max length: 128 characters (see data formats for details)The unique identifier of the object.

ReportType

string

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

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

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.

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.

[
    {
        "Id": "report_01JW6854FGRG1JVVSEWZP4B20C",
        "ReportType": "COLLECTED_FEES",
        "Status": "GENERATING",
        "LastUpdated": 1748261573,
        "CreationDate": 1748261573,
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": null,
        "ResultMessage": null
    },
    {
        "Id": "report_01JVYRQHQ7G5VKGA6SM0EEVVA5",
        "ReportType": "USER_WALLET_TRANSACTIONS",
        "Status": "GENERATED",
        "LastUpdated": 1748010518,
        "CreationDate": 1748010518,
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": "000000",
        "ResultMessage": "Success"
    },
        {
        "Id": "report_01JR92549WWKAP2G1WW0DRAC80",
        "ReportType": "USER_WALLET_TRANSACTIONS",
        "Status": "EXPIRED",
        "LastUpdated": 1746739535,
        "CreationDate": 1744060977,
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": "000000",
        "ResultMessage": "Success"
    }
]

// GET has no body parameters

View a Report The legacy Report object

​Query parameters

​Responses

Query parameters

Responses