Reports

Create a Transactions Report

Changed on
<Note icon="fa-regular fa-circle-info"> **Note – Report expiration date**

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.
</Note>

<Note icon="fa-regular fa-circle-info"> **Note – `BeforeDate` value restriction**

To 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.
</Note>

Generate a legacy Transactions Report

post/v2.01/{ClientId}/reports/transactions

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/reports/transactions
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

Request body

Tagstring

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

DownloadFormatstring

Possible values: CSV

The format of the report file.

CallbackURLstring

Max. length: 255 characters

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

Sortstring

Possible values: CreationDate:ASC, CreationDate:DESC

Default value: CreationDate:ASC

The sort direction based on transaction creation date.

Previewboolean

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

Columnsstring[]

Allowed values: The Columns listed in the <a href="/reports">Reports</a> article, which differ according to the report type.

The information to be included in the report.

Response

Success

Idstring

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

The unique identifier of the object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

ReportDateinteger nullable

Unix timestamp (UTC) of the date and time the report was generated.

Statusstring

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

Returned values: CSV

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

DownloadURLstring nullable

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

CallbackURLstring

Max. length: 255 characters

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

ReportTypestring

Returned values: TRANSACTIONS, WALLETS

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

Sortstring

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

Previewboolean

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

Columnsstring[]

Returned values: The Columns listed in the <a href="/reports">Reports</a> article, which differ according to the report type.

The information to be included in the report.

ResultCodestring

The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.

ResultMessagestring

The explanation of the result code.

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id create_transactions_report removed and replaced with reports_create_transactions_report