Create a Wallets Report

Note – Report expiration date

A report expires after 24 hours (i.e., you can no longer download it after this delay). You can still generate a new report with the same filters and information easily.

Body parameters

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.

DownloadFormat

string

Allowed values: CSV

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

CallbackURL

string

Max. length: 255 characters

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

Sort

string

Allowed values: CreationDate:ASC, CreationDate:DESC

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.

Columns

array

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

The information to be included in the report.

Responses

string

The unique identifier of the object.

CreationDate

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

timestamp

The date and time at which the report was generated (i.e., when its Status is no longer PENDING).

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

The URL at which the file can be downloaded.

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.

Columns

array

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

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "23ca4f5b-6d35-45d0-8bde-c8424885a2e9",
    "Date": 1715353491.0,
    "errors": {
        "Filters.AfterDate": "This report type can only be done for a date range of a maximum of 24 months."
    }
}

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

Body parameters

Responses

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

​Body parameters

​Responses

Body parameters

Responses