Reports
Mangopay provides the ability to generate reports so you can download a large amount of data in CSV format for accounting or analysis purposes.
Two types of report are available via the API:
| Transactions report | Provides the pay-ins, payouts, transfers, and conversions made on the platform. This includes all natures of transaction (regular, refund, repudiation, and settlement). The report period can’t exceed 6 months, and transactions can’t be more than 36 months past their creation date. |
|---|---|
| Wallets report | Provides all the wallets created on the platform, whether they are the end user’s, or the platform’s (repudiation and fees wallets). The report period can’t exceed 24 months by a wallet’s creation date. |
Report creation flow
When creating a report with the dedicated endpoints, its Status is PENDING at first, until it becomes ready for download. There is a short waiting time, (usually a few seconds) which depends on the size of the requested report.
When the report status becomes READY_FOR_DOWNLOAD, a notification is sent to the CallbackURL (if set) with the following format:
https://www.example.com?EventType=REPORT_READY_FOR_DOWNLOAD&ResourceId=
ReportId&Date=ReportDate
Using the ReportId, you can use the View a Report endpoint to get the DownloadURL, where the report is available for download.
A 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.
Setting up a transactions report
Columns
On the POST Create a Transactions Report endpoint, you can add the following values in the Columns parameter to choose which information should be included in the report.
| Column | Description |
|---|---|
| Alias | The partially hidden number of the card used for the transaction. |
| AuthorId | The unique identifier of the user at the source of the transaction. |
| BankAccountId | The unique identifier of the bank account to which the payout is made. |
| BankWireRef | Custom description to appear on the user’s bank statement along with the platform name. |
| CardId | The unique identifier of the card used for the transaction. |
| CardType | The type of the card among the following: CB_VISA_MASTERCARD, AMEX, MAESTRO, P24, IDEAL, BCMC. |
| Country | The country of the card (which is the same as the country of the issuer). |
| CreationDate | The date and time at which the transaction was created. |
| CreationDate:ISO | The date and time at which the transaction was created in the following format: dd/MM/yyyy HH:mm:ss. |
| CreditedFundsAmount | The amount of credited funds (CreditedFunds = DebitedFunds - Fees). |
| CreditedFundsCurrency | The currency of the credited funds. |
| CreditedUserId | The unique identifier of the user whose wallet is credited. |
| CreditedWalletId | The unique identifier of the credited wallet. |
| Culture | The language in which the redirection page is displayed. |
| DebitedFundsAmount | The amount of debited funds. |
| DebitedFundsCurrency | The currency of the debited funds. |
| DebitedWalletId | The unique identifier of the debited wallet. |
| DeclaredDebitedFundsAmount | The amount of the declared debited funds for a direct bank wire pay-in. |
| DeclaredDebitedFundsCurrency | The currency of the declared debited funds for a direct bank wire pay-in. |
| DeclaredFeesAmount | The amount of the declared fees for a direct bank wire pay-in. |
| DeclaredFeesCurrency | The currency of the declared fees for a direct bank wire pay-in. |
| ExecutionDate | The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. |
| ExecutionDate:ISO | The date and time at which the transaction status changed to SUCCEEDED, in the following format: dd/MM/yyyy HH:mm:ss. |
| ExecutionType | The type of execution for a pay-in: WEB, DIRECT, EXTERNAL_INSTRUCTION. |
| ExpirationDate | The date at which the card used for the transaction will expire. |
| FeesAmount | The amount of the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet). |
| FeesCurrency | The currency of the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet). |
| Id | The unique identifier of the transaction. |
| Nature | The nature of the transaction, providing more information about the context in which the transaction occurred: REGULAR, REPUDIATION, REFUND, SETTLEMENT. |
| PaymentType | The type of payment: CARD, BANK_WIRE, DIRECT_DEBIT, PAYPAL. |
| PreauthorizationId | The unique identifier of the Preauthorization object against which a preauthorized pay-in can be made. |
| ResultCode | The code indicating the result of the operation. |
| ResultMessage | The explanation of the result code. |
| Status | The status of the transaction (created, succeeded, or failed). |
| Tag | Custom data that can be added to the transaction. |
| Type | The type of the transaction: PAYIN, TRANSFER, PAYOUT. |
| WireReference | The reference which the end user must provide when making a direct bank wire pay-in. |
Filters
In order to optimize the report, you can take advantage of a series of filters available in the Create a Transactions Report endpoint documentation.
Thanks to the BeforeDate and AfterDate filters, you can define a time range based on the CreationDate of the transactions. The date range can’t exceed 6 months, and you can’t view transactions which occurred more than 36 months in the past.
Setting up a wallets report
Columns
On the POST Create a Wallets Report endpoint, you can add the following values in the Columns parameter to choose which information should be included in the report.
| Column | Description |
|---|---|
| Id | The unique identifier of the wallet. |
| Tag | Custom data that can be added to the wallet. |
| CreationDate | The date and time at which the wallet was created in a timestamp format. |
| CreationDate:ISO | The date and time at which the wallet was created in the following format: dd/MM/yyyy HH:mm:ss. |
| Owners | The Id of the user attached to the wallet. |
| Description | The description of the wallet. It can be a name, a type, anything that can help you clearly identify the wallet on the platform (and for your end users). |
| BalanceAmount | The current balance of the wallet. |
| BalanceCurrency | The currency of the balance of the wallet. |
| Currency | The currency of the wallet. |
| FundsType | The type of funds in the wallet, which can be DEFAULT, FEES, or CREDIT. |
Filters
In order to optimize the report, you can take advantage of a series of filters available in the POST Create a Wallets Report endpoint documentation.
Thanks to the BeforeDate and AfterDate filters, you can define a time range based on the CreationDate of the wallets. The date range can’t exceed 24 months.
Related resources
Endpoints
Was this page helpful?