Create a Transactions Report

Note – Report expiration dateA report expires after 24 hours (i.e., you can no longer download it after this period). You can still generate a new report with the same filters and information easily.

Note – BeforeDate value restrictionTo ensure that data provided on each report are up-to-date, the BeforeDate parameter cannot be greater than the report creation date minus 5 minutes. If it is, BeforeDate will be automatically set according to this constraint.

Body parameters

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.

DownloadFormat

string

Possible values: CSVThe format of the report file.

CallbackURL

string

Max. length: 255 charactersThe URL to which the notification indicating that the report is ready to be downloaded will be sent.

Sort

string

Possible values: CreationDate:ASC, CreationDate:DESCDefault value: CreationDate:ASCThe sort direction based on transaction creation date.

Preview

boolean

Whether the report is limited to the first 10 lines (and therefore quicker to generate).

Filters

object

The filtering parameters to optimize the report.

Show properties

BeforeDate

Unix timestamp

Allowed values: Any date between today’s date and 36 months in the past.The date before which the transaction was created (based on the transaction’s CreationDate parameter).Caution: The time range between the BeforeDate and the AfterDate cannot exceed 6 months.

AfterDate

Unix timestamp

The date after which the transaction was created (based on the transaction’s CreationDate parameter).
Caution: The time range between the BeforeDate and the AfterDate cannot exceed 6 months.

Type

array

Allowed values: PAYIN, TRANSFER, CONVERSION, PAYOUTThe transaction types to be taken into account.

ResultCode

array

The transaction result codes to be taken into account.

Status

array

The transaction statuses to be taken into account.

Nature

array

Allowed values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe transaction natures to be taken into account.

REGULAR – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.
REPUDIATION – Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback).
REFUND – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).
SETTLEMENT – Transfer made to the repudiation wallet by the platform to settle a lost dispute.

WalletId

string

The unique identifier of the wallet that is to be taken into account.

AuthorId

string

The unique identifier of the user at the source of the transaction.

MinDebitedFundsAmount

integer

The debited funds amount above which the transactions are taken into account.

MinDebitedFundsCurrency

string

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the MinDebitedFundsAmount value.

MaxDebitedFundsAmount

integer

The debited funds amount below which the transactions are taken into account.

MaxDebitedFundsCurrency

string

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the MaxDebitedFundsAmount value.

MinFeesAmount

integer

The fees amount below which the transactions are taken into account.

MinFeesCurrency

string

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the MinFeesAmount value.

MaxFeesAmount

integer

The fees amount above which the transactions are taken into account.

MaxFeesCurrency

string

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the MaxFeesAmount value.

Columns

array

Allowed values: The Columns listed in the Reports article, which differ according to the report type.The information to be included in the report.

Responses

200

400 - AfterDate must be within past 36 months

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "3b84cf5d-1195-4753-9ae2-0922e35dbfd4",
    "Date": 1716558597.0,
    "errors": {
        "Filters.AfterDate": "This report type can only be done for the last 36 months."
    }
}

{
    "Id": "report_m_01JFA0JQQJ1X6W6VT6042SASTC",
    "CreationDate": 1734429204,
    "Tag": "Created using Mangopay API Postman Collection",
    "ReportDate": null,
    "Status": "PENDING",
    "DownloadFormat": "CSV",
    "DownloadURL": null,
    "CallbackURL": null,
    "ReportType": "TRANSACTIONS",
    "Sort": "CreationDate:ASC",
    "Preview": false,
    "Filters": {
        "BeforeDate": 1658317644,
        "AfterDate": 1655725644,
        "Type": [],
        "ResultCode": [],
        "Status": [],
        "Nature": [],
        "WalletId": null,
        "AuthorId": null,
        "MinDebitedFundsAmount": null,
        "MinDebitedFundsCurrency": null,
        "MaxDebitedFundsAmount": null,
        "MaxDebitedFundsCurrency": null,
        "MinFeesAmount": null,
        "MinFeesCurrency": null,
        "MaxFeesAmount": null,
        "MaxFeesCurrency": null
    },
    "Columns": [
        "Id",
        "Tag",
        "CreationDate",
        "ExecutionDate",
        "AuthorId",
        "CreditedUserId",
        "DebitedFundsAmount",
        "DebitedFundsCurrency",
        "CreditedFundsAmount",
        "CreditedFundsCurrency",
        "FeesAmount",
        "FeesCurrency",
        "Status",
        "ResultCode",
        "ResultMessage",
        "Type",
        "Nature",
        "CreditedWalletId",
        "DebitedWalletId"
    ],
    "ResultCode": null,
    "ResultMessage": null
}

{
    "Tag": "Created using Mangopay API Postman Collection",
    "DownloadFormat": "CSV",
    "CallbackURL": null,
    "Sort": "CreationDate:ASC",
    "Preview": false,
    "Filters": {
        "BeforeDate": 1658317644,
        "AfterDate": 1655725644,
        "Type": [],
        "ResultCode": [],
        "Status": [],
        "Nature": [],
        "WalletId": null,
        "AuthorId": null,
        "MinDebitedFundsAmount": null,
        "MinDebitedFundsCurrency": null,
        "MaxDebitedFundsAmount": null,
        "MaxDebitedFundsCurrency": null,
        "MinFeesAmount": null,
        "MinFeesCurrency": null,
        "MaxFeesAmount": null,
        "MaxFeesCurrency": null
    },
    "Columns": [
        "Id",
        "Tag",
        "CreationDate",
        "ExecutionDate",
        "AuthorId",
        "CreditedUserId",
        "DebitedFundsAmount",
        "DebitedFundsCurrency",
        "CreditedFundsAmount",
        "CreditedFundsCurrency",
        "FeesAmount",
        "FeesCurrency",
        "Status",
        "ResultCode",
        "ResultMessage",
        "Type",
        "Nature",
        "CreditedWalletId",
        "DebitedWalletId"
    ]
}

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Echo

Helpers

Platform account

Create a Transactions Report

Body parameters

Responses

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Echo

Helpers

Platform account

​Body parameters

​Responses

Body parameters

Responses