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
Copy
<?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 {
$response = $api->Reports->GetAll();
print_r($response);
} catch(MGPResponseException $e) {
print_r($e);
} catch(MGPException $e) {
print_r($e);
}
Copy
[
{
"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__",
"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"
},
{
"Id": "report_m_01JFA0QC7K9CJ339JX4KV08CMW",
"CreationDate": 1734429356,
"Tag": "Created using Mangopay API Postman Collection",
"ReportDate": 1734429356,
"Status": "READY_FOR_DOWNLOAD",
"DownloadFormat": "CSV",
"DownloadURL": "https://downloads.sandbox.mangopay.com/fd9f07b1c84a444aaca68eca2f597495.csv?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6IioiLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjE3MzQ1MTU3NTZ9fX1dfQ__&Signature=PL0gj96VDkO43AtYkWJyoO7nj1wAFH7axqTwIVLWq3JHN1dadvBoQHaZb~P8tg3PFV3JSjv5MRu62JnHKFzlOAxW6-rpY7zN2MtsNTy9X32c63crC7MqxfZMNze4xkedbmQ~afsFfO6JAncwa40osf28x-1E64K7NrXjGxGO2RykEpwoyJz2g01qY8yjEONYmc0HEdg3lp1OBpLF~Ep3IRQkWLuLfIPbogGsj~NxbTgjQOqM7l~A7KHY5VOgHi-9fR4dd2uI4f-84BbTxmtcv0Uz~um5GhzsjejOV0TEziGVXvxtTEXK7h4cHVHm9YfR4G0jOZi9oRgkW0WYCIz31Q__",
"CallbackURL": null,
"ReportType": "WALLETS",
"Sort": "CreationDate:ASC",
"Preview": false,
"Filters": {
"BeforeDate": 1658838931,
"AfterDate": 1656246931,
"OwnerId": null,
"Currency": null,
"MinBalanceAmount": null,
"MinBalanceCurrency": null,
"MaxBalanceAmount": null,
"MaxBalanceCurrency": null
},
"Columns": [
"Id",
"Tag",
"CreationDate",
"Owners",
"Description",
"BalanceAmount",
"BalanceCurrency",
"Currency",
"FundsType"
],
"ResultCode": "000000",
"ResultMessage": "Success"
}
]
Legacy reports
List all Reports
List all legacy reports
GET
/
v2.01
/
{ClientId}
/
reports
Copy
<?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 {
$response = $api->Reports->GetAll();
print_r($response);
} catch(MGPResponseException $e) {
print_r($e);
} catch(MGPException $e) {
print_r($e);
}
Copy
[
{
"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__",
"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"
},
{
"Id": "report_m_01JFA0QC7K9CJ339JX4KV08CMW",
"CreationDate": 1734429356,
"Tag": "Created using Mangopay API Postman Collection",
"ReportDate": 1734429356,
"Status": "READY_FOR_DOWNLOAD",
"DownloadFormat": "CSV",
"DownloadURL": "https://downloads.sandbox.mangopay.com/fd9f07b1c84a444aaca68eca2f597495.csv?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6IioiLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjE3MzQ1MTU3NTZ9fX1dfQ__&Signature=PL0gj96VDkO43AtYkWJyoO7nj1wAFH7axqTwIVLWq3JHN1dadvBoQHaZb~P8tg3PFV3JSjv5MRu62JnHKFzlOAxW6-rpY7zN2MtsNTy9X32c63crC7MqxfZMNze4xkedbmQ~afsFfO6JAncwa40osf28x-1E64K7NrXjGxGO2RykEpwoyJz2g01qY8yjEONYmc0HEdg3lp1OBpLF~Ep3IRQkWLuLfIPbogGsj~NxbTgjQOqM7l~A7KHY5VOgHi-9fR4dd2uI4f-84BbTxmtcv0Uz~um5GhzsjejOV0TEziGVXvxtTEXK7h4cHVHm9YfR4G0jOZi9oRgkW0WYCIz31Q__",
"CallbackURL": null,
"ReportType": "WALLETS",
"Sort": "CreationDate:ASC",
"Preview": false,
"Filters": {
"BeforeDate": 1658838931,
"AfterDate": 1656246931,
"OwnerId": null,
"Currency": null,
"MinBalanceAmount": null,
"MinBalanceCurrency": null,
"MaxBalanceAmount": null,
"MaxBalanceCurrency": null
},
"Columns": [
"Id",
"Tag",
"CreationDate",
"Owners",
"Description",
"BalanceAmount",
"BalanceCurrency",
"Currency",
"FundsType"
],
"ResultCode": "000000",
"ResultMessage": "Success"
}
]
Query parameters
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.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.Responses
200
200
The list of reports created by the platform.
Show properties
Show properties
The Report object created by the platform.
Show properties
Show properties
Max length: 128 characters (see data formats for details)The unique identifier of the object.
The date and time at which the object was created.
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.
The date and time at which the report was generated.
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).
Returned values:
CSVThe format in which the report is going to be downloaded.Max. length: 255 charactersThe URL to which the notification indicating that the report is ready to be downloaded will be sent.
The type of the report, indicating whether it lists transactions or wallets.
The sorting direction of the CreationDate column. By default, the generated report is sorted by ascending creation date.
The filtering parameters to optimize the report.
Show properties
Show properties
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.The date after which the transaction was created (based on the transaction’s
Caution: The time range between the
CreationDate parameter).Caution: The time range between the
BeforeDate and the AfterDate cannot exceed 6 months.The transaction types to be taken into account.
The transaction result codes to be taken into account.
The transaction statuses to be taken into account.
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.
The unique identifier of the wallet that is to be taken into account.
The unique identifier of the user at the source of the transaction.
The debited funds amount above which the transactions are taken into account.
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.The debited funds amount below which the transactions are taken into account.
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.The fees amount below which the transactions are taken into account.
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.The fees amount above which the transactions are taken into account.
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.Returned values: The
Columns listed in the Reports article, which differ according to the report type.The information to be included in the report.The transaction result codes to be taken into account.
The explanation of the result code.
Copy
[
{
"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__",
"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"
},
{
"Id": "report_m_01JFA0QC7K9CJ339JX4KV08CMW",
"CreationDate": 1734429356,
"Tag": "Created using Mangopay API Postman Collection",
"ReportDate": 1734429356,
"Status": "READY_FOR_DOWNLOAD",
"DownloadFormat": "CSV",
"DownloadURL": "https://downloads.sandbox.mangopay.com/fd9f07b1c84a444aaca68eca2f597495.csv?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6IioiLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjE3MzQ1MTU3NTZ9fX1dfQ__&Signature=PL0gj96VDkO43AtYkWJyoO7nj1wAFH7axqTwIVLWq3JHN1dadvBoQHaZb~P8tg3PFV3JSjv5MRu62JnHKFzlOAxW6-rpY7zN2MtsNTy9X32c63crC7MqxfZMNze4xkedbmQ~afsFfO6JAncwa40osf28x-1E64K7NrXjGxGO2RykEpwoyJz2g01qY8yjEONYmc0HEdg3lp1OBpLF~Ep3IRQkWLuLfIPbogGsj~NxbTgjQOqM7l~A7KHY5VOgHi-9fR4dd2uI4f-84BbTxmtcv0Uz~um5GhzsjejOV0TEziGVXvxtTEXK7h4cHVHm9YfR4G0jOZi9oRgkW0WYCIz31Q__",
"CallbackURL": null,
"ReportType": "WALLETS",
"Sort": "CreationDate:ASC",
"Preview": false,
"Filters": {
"BeforeDate": 1658838931,
"AfterDate": 1656246931,
"OwnerId": null,
"Currency": null,
"MinBalanceAmount": null,
"MinBalanceCurrency": null,
"MaxBalanceAmount": null,
"MaxBalanceCurrency": null
},
"Columns": [
"Id",
"Tag",
"CreationDate",
"Owners",
"Description",
"BalanceAmount",
"BalanceCurrency",
"Currency",
"FundsType"
],
"ResultCode": "000000",
"ResultMessage": "Success"
}
]
Copy
<?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 {
$response = $api->Reports->GetAll();
print_r($response);
} catch(MGPResponseException $e) {
print_r($e);
} catch(MGPException $e) {
print_r($e);
}
Was this page helpful?
⌘I