View a Report

<?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);
}  

const mangopayInstance = require('mangopay4-nodejs-sdk')
const mangopay = new mangopayInstance({
  clientId: 'your-client-id',
  clientApiKey: 'your-api-key',
})

let myReport = {
  Id: '192900155',
}

const viewReport = async (reportId) => {
  return await mangopay.Reports.get(reportId)
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

viewReport(myReport.Id)  

require 'mangopay'

MangoPay.configure do |client|
    client.preproduction = true
    client.client_id = 'your-client-id'
    client.client_apiKey = 'your-api-key'
    client.log_file = File.join(Dir.pwd, 'mangopay.log')
end

def viewReport(reportId)
    begin
        response = MangoPay::Report.fetch(reportId)
        puts response
        return response
    rescue MangoPay::ResponseError => error
        puts "Failed to fetch Report: #{error.message}"
        puts "Error details: #{error.details}"
        return false
    end
end

myReport = {
    Id: '195000676'
}

viewReport(myReport[:Id])  

from pprint import pprint
import mangopay

mangopay.client_id='your-client-id'
mangopay.apikey='your-api-key'

from mangopay.api import APIRequest
handler = APIRequest(sandbox=True)

from mangopay.resources import Report

report_id = 'report_m_01HR4RQ4KX66A4K52AJC3C1Z2R'

try:
    view_report = Report.get(report_id)
    pprint(view_report._data)
except Report.DoesNotExist:
    print('Report {} does not exist.'.format(report_id))  

using MangoPay.SDK;
using Newtonsoft.Json;

class Program
{
    static async Task Main(string[] args)
    {
        MangoPayApi api = new MangoPayApi();

        api.Config.ClientId = "your-client-id";
        api.Config.ClientPassword = "your-api-key";

        var reportId = "report_m_01J55Z0TCA6998ZRGR2Y9AKDTZ";

        var viewReport = await api.Reports.GetAsync(reportId);

        string prettyPrint = JsonConvert.SerializeObject(viewReport, Formatting.Indented);
        Console.WriteLine(prettyPrint);
    }
}

{
    "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"
}

GET

v2.01

{ClientId}

reports

{ReportId}

<?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);
}  

const mangopayInstance = require('mangopay4-nodejs-sdk')
const mangopay = new mangopayInstance({
  clientId: 'your-client-id',
  clientApiKey: 'your-api-key',
})

let myReport = {
  Id: '192900155',
}

const viewReport = async (reportId) => {
  return await mangopay.Reports.get(reportId)
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

viewReport(myReport.Id)  

require 'mangopay'

MangoPay.configure do |client|
    client.preproduction = true
    client.client_id = 'your-client-id'
    client.client_apiKey = 'your-api-key'
    client.log_file = File.join(Dir.pwd, 'mangopay.log')
end

def viewReport(reportId)
    begin
        response = MangoPay::Report.fetch(reportId)
        puts response
        return response
    rescue MangoPay::ResponseError => error
        puts "Failed to fetch Report: #{error.message}"
        puts "Error details: #{error.details}"
        return false
    end
end

myReport = {
    Id: '195000676'
}

viewReport(myReport[:Id])  

from pprint import pprint
import mangopay

mangopay.client_id='your-client-id'
mangopay.apikey='your-api-key'

from mangopay.api import APIRequest
handler = APIRequest(sandbox=True)

from mangopay.resources import Report

report_id = 'report_m_01HR4RQ4KX66A4K52AJC3C1Z2R'

try:
    view_report = Report.get(report_id)
    pprint(view_report._data)
except Report.DoesNotExist:
    print('Report {} does not exist.'.format(report_id))  

using MangoPay.SDK;
using Newtonsoft.Json;

class Program
{
    static async Task Main(string[] args)
    {
        MangoPayApi api = new MangoPayApi();

        api.Config.ClientId = "your-client-id";
        api.Config.ClientPassword = "your-api-key";

        var reportId = "report_m_01J55Z0TCA6998ZRGR2Y9AKDTZ";

        var viewReport = await api.Reports.GetAsync(reportId);

        string prettyPrint = JsonConvert.SerializeObject(viewReport, Formatting.Indented);
        Console.WriteLine(prettyPrint);
    }
}

{
    "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"
}

Path parameters

string

required

The unique identifier of the legacy report.

Responses

200

string

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

Unix timestamp

The date and time at which the object was created.

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.

Unix timestamp | null

The date and time at which the report was generated.

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

string

Returned values: CSVThe format in which the report is going to be downloaded.

string | null

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

string

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

string

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

string

The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date.

boolean

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

object

The filtering parameters to optimize the report.

Show properties

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.

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.

array

The transaction types to be taken into account.

array

The transaction result codes to be taken into account.

array

The transaction statuses to be taken into account.

array

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

string

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

string

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

integer

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

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.

integer

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

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.

integer

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

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.

integer

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

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.

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.

array

The transaction result codes to be taken into account.

string

The explanation of the result code.

{
    "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 

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);
}  

const mangopayInstance = require('mangopay4-nodejs-sdk')
const mangopay = new mangopayInstance({
  clientId: 'your-client-id',
  clientApiKey: 'your-api-key',
})

let myReport = {
  Id: '192900155',
}

const viewReport = async (reportId) => {
  return await mangopay.Reports.get(reportId)
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

viewReport(myReport.Id)  

require 'mangopay'

MangoPay.configure do |client|
    client.preproduction = true
    client.client_id = 'your-client-id'
    client.client_apiKey = 'your-api-key'
    client.log_file = File.join(Dir.pwd, 'mangopay.log')
end

def viewReport(reportId)
    begin
        response = MangoPay::Report.fetch(reportId)
        puts response
        return response
    rescue MangoPay::ResponseError => error
        puts "Failed to fetch Report: #{error.message}"
        puts "Error details: #{error.details}"
        return false
    end
end

myReport = {
    Id: '195000676'
}

viewReport(myReport[:Id])  

from pprint import pprint
import mangopay

mangopay.client_id='your-client-id'
mangopay.apikey='your-api-key'

from mangopay.api import APIRequest
handler = APIRequest(sandbox=True)

from mangopay.resources import Report

report_id = 'report_m_01HR4RQ4KX66A4K52AJC3C1Z2R'

try:
    view_report = Report.get(report_id)
    pprint(view_report._data)
except Report.DoesNotExist:
    print('Report {} does not exist.'.format(report_id))  

using MangoPay.SDK;
using Newtonsoft.Json;

class Program
{
    static async Task Main(string[] args)
    {
        MangoPayApi api = new MangoPayApi();

        api.Config.ClientId = "your-client-id";
        api.Config.ClientPassword = "your-api-key";

        var reportId = "report_m_01J55Z0TCA6998ZRGR2Y9AKDTZ";

        var viewReport = await api.Reports.GetAsync(reportId);

        string prettyPrint = JsonConvert.SerializeObject(viewReport, Formatting.Indented);
        Console.WriteLine(prettyPrint);
    }
}

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

Path parameters

Responses

​Path parameters

​Responses

Path parameters

Responses