View a Report

Retrieve a legacy report

Path parameters

ReportId · string · required

The unique identifier of the legacy report.

Responses

200

Id · string

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

CreationDate · Unix timestamp

The date and time at which the object was created.

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.

ReportDate · Unix timestamp | null

The date and time at which the report was generated.

Status · string

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

DownloadFormat · string

Returned values: CSV

The format in which the report is going to be downloaded.

DownloadURL · string | null

The URL at which the report file can be downloaded when the Status is GENERATED.

CallbackURL · string

Max. length: 255 characters

The URL to which the notification indicating that the report is ready to be downloaded will be sent.

ReportType · string

The type of the report, indicating whether it lists transactions or wallets.

Sort · string

The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending 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

Returned 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

The 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

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT

The 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

Returned 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

Returned 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

Returned 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

Returned 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

Returned values: The Columns listed in the Reports article, which differ according to the report type.

The information to be included in the report.

ResultCode · array

The transaction result codes to be taken into account.

ResultMessage · string

The explanation of the result code.

200

{
    "Id": "report_m_01JFA0JQQJ1X6W6VT6042SASTC",
    "CreationDate": 1734429204,
    "Tag": "Created using Mangopay API Postman Collection",
    "ReportDate": 1734429204,
    "Status": "READY_FOR_DOWNLOAD",
    "DownloadFormat": "CSV",
    "DownloadURL": "https://downloads.sandbox.mangopay.com/85565d93430945388122986252982648.csv?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6IioiLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjE3MzQ1MTU2MDR9fX1dfQ__&Signature=YvcEtwjbs2hR4mOb2UuGICdh082lFrCjS1XtwJ~Zem7~vDc8bPPo-2kBA-Neb0Hs7V9gApR5mJ9B6RPOgDzKKdBEVD4iBS066eNYIymuW2fY5IXjfuzFgv0id5yi2ynFcmX02sgSgd9WGChYpUTBH36R-McNbAPG3viOu8FZ5LM9IWR44qnMwrM-8IWXPBpg9yh7uZy6ehDjJpoi9tswNnzt445vpORRMF3clMl~tRel59EcsMV73c-~B1Qvd9inBa6msh6eww~kkcP5FE~MCr4oQ-DsX0lZPAXLoSOJNbhOotNqKgwlBrYwAT1gLV510kUlbJy~4bPDmmsgbSqETw__&Key-Pair-Id=K21K4XKUJZ74AO",
    "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": "000000",
    "ResultMessage": "Success"
}

PHP

<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

try {
    $reportId = '192900155';

    $response = $api->Reports->Get($reportId);

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}