POST
/
v2.01
/
{ClientId}
/
reporting
/
reports
{
    "Tag": "Created using the Mangopay API Postman collection",
    "DownloadFormat": "CSV",
    "ReportType": "USER_WALLET_TRANSACTIONS",
    "AfterDate": 1740787200,
    "BeforeDate": 1743465599,
    "Filters": {
        "UserId": "user_m_01JSM1ZG3MAWR272S99ZKE2WSP",
        "Currency": "EUR"
    }
}
{
    "Id": "report_01JVVQFJETHHP9M9S18RN6N8JZ",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1747908544,
    "ReportDate": null,
    "Status": "PENDING",
    "ResultCode": null,
    "ResultMessage": null,
    "DownloadFormat": "CSV",
    "DownloadURL": null,
    "ReportType": "USER_WALLET_TRANSACTIONS",
    "Sort": "CreationDate:DESC",
    "AfterDate": 1740787200,
    "BeforeDate": 1743465599,
    "Filters": {
        "UserId": "user_m_01JSM1ZG3MAWR272S99ZKE2WSP",
        "Currency": "EUR"
    },
    "Columns": [
        "ClientId",
        "TransactionId",
        "CreationDate",
        "ExecutionDate",
        "AuthorId",
        "CreditedUserId",
        "DebitedFundsAmount",
        "DebitedFundsCurrency",
        "CreditedFundsAmount",
        "CreditedFundsCurrency",
        "FeesAmount",
        "FeesCurrency",
        "Type",
        "Nature",
        "CreditedWalletId",
        "DebitedWalletId",
        "BankAccountId",
        "PreauthorizationId",
        "BankWireRef",
        "CardId",
        "CardAlias",
        "CardType",
        "CardCountry",
        "CardExpirationDate",
        "Culture",
        "DeclaredDebitedFundsAmount",
        "DeclaredDebitedFundsCurrency",
        "DeclaredFeesAmount",
        "DeclaredFeesCurrency",
        "ExecutionType",
        "PaymentType",
        "WireReference"
    ]
}

This endpoint generates a report from Mangopay’s Reporting Service, which is replacing the legacy report types.

Two types of report are available, specified in the ReportType:

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

Note – Report expires after 31 days

A 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

​
Tag
string

Max. length: 255 characters

Custom data that you can add to this object.

For reports, this parameter can be useful to give the report a name.

​
DownloadFormat
string
required

Possible values: CSV

The format of the report file.

​
ReportType
string
required

The type of the report:

  • 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.
​
Sort
string

Possible values: CreationDate:ASC, CreationDate:DESC

Default value: CreationDate:ASC

The sort direction based on transaction creation date.

​
AfterDate
Unix timestamp
required

Possible values: Any past date and time up 24 months ago that is earlier than the BeforeDate by less than 12 months

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

​
BeforeDate
Unix timestamp
required

Possible values: Any past date and time up 24 months ago that is later than the AfterDate by less than 12 months

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

​
Filters
object

Possible values: Currency, UserId, WalletId

The filers to apply.

If the ReportType is COLLECTED_FEES, only the Currency filter can be used. If the currency is not specified, the report contains data on all currencies.

If the ReportType is USER_WALLET_TRANSACTIONS, each filter can be used on its own or in combination, in which case the report data satisfies both filters.

  • UserId and Currency – Report contains all transactions (credited or debited) in the currency where UserId is the AuthorId
  • UserId and WalletId – Report contains all transactions (credited or debited) in all currencies where the UserId is specified as the DebitedWalletId or CreditedWalletId. If the WalletId is not a wallet owned by the UserId, then the report will be empty.

The Currency and WalletId cannot be used together.

If no Filters are specified, the report contains all transactions crediting or debiting all user wallets.

Caution: The WalletId and UserId values are not validated before the request is launched, so if both are used but don’t correspond (the user doesn’t own the wallet), then the report will be empty.

​
Columns
array

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.

​
Responses

{
    "Id": "report_01JVVQFJETHHP9M9S18RN6N8JZ",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1747908544,
    "ReportDate": null,
    "Status": "PENDING",
    "ResultCode": null,
    "ResultMessage": null,
    "DownloadFormat": "CSV",
    "DownloadURL": null,
    "ReportType": "USER_WALLET_TRANSACTIONS",
    "Sort": "CreationDate:DESC",
    "AfterDate": 1740787200,
    "BeforeDate": 1743465599,
    "Filters": {
        "UserId": "user_m_01JSM1ZG3MAWR272S99ZKE2WSP",
        "Currency": "EUR"
    },
    "Columns": [
        "ClientId",
        "TransactionId",
        "CreationDate",
        "ExecutionDate",
        "AuthorId",
        "CreditedUserId",
        "DebitedFundsAmount",
        "DebitedFundsCurrency",
        "CreditedFundsAmount",
        "CreditedFundsCurrency",
        "FeesAmount",
        "FeesCurrency",
        "Type",
        "Nature",
        "CreditedWalletId",
        "DebitedWalletId",
        "BankAccountId",
        "PreauthorizationId",
        "BankWireRef",
        "CardId",
        "CardAlias",
        "CardType",
        "CardCountry",
        "CardExpirationDate",
        "Culture",
        "DeclaredDebitedFundsAmount",
        "DeclaredDebitedFundsCurrency",
        "DeclaredFeesAmount",
        "DeclaredFeesCurrency",
        "ExecutionType",
        "PaymentType",
        "WireReference"
    ]
}
{
    "Tag": "Created using the Mangopay API Postman collection",
    "DownloadFormat": "CSV",
    "ReportType": "USER_WALLET_TRANSACTIONS",
    "AfterDate": 1740787200,
    "BeforeDate": 1743465599,
    "Filters": {
        "UserId": "user_m_01JSM1ZG3MAWR272S99ZKE2WSP",
        "Currency": "EUR"
    }
}