The Report object
The Report
object gives the possibility to download huge lists of transactions or wallets to CSV format for accounting or analysis purposes. This can be done either from the API or Dashboard.
You can choose certain filters including:
Transactions
- A date range (
BeforeDate
andAfterDate
) - note that the range can’t be more than 6 months, and must be < 36 months ago - Min/Max
DebitedFunds
- Min/Max
Fees
- A
WalletId
- A
UserId
- A transaction
Type
(PAYIN, PAYOUT or TRANSFER) - A transaction
Status
(CREATED, SUCCEEDED or FAILED) - A transaction
Nature
(REGULAR, REFUND, REPUDIATION or SETTLEMENT) - A
ResultCode
Wallets
- A date range (
BeforeDate
andAfterDate
) - note that the range can’t be more than 24 months, but with no limitations on historical data. - Min/Max
BalanceAmount
- A wallet
Currency
- A wallet
CreationDate
- A wallet
Owner
In each case, you can specify multiple values if you wish.
You also get to choose what datas you want to see (Columns
) for each transaction - eg you might just be interested in seeing CreationDate
, AuthorId
, DebitedFunds
and CardType
for example.
A report can be requested and then we’ll update it’s Status
as soon as it’s ready to download - the wait time is normally only a couple of seconds though. We’ll also ping a particular URL (CallbackURL
) if you specified one - just like for hook notifications.
Note that reports expire after 24 hours (ie they’ll be no longer available) but you can “rerun” the same report from the Dashboard very easily.
To ensure that data provided on each report are up-to-date, BeforeDate
cannot be greater than report creation date minus 5 minutes. If it is, BeforeDate
will be automatically set according to this constraint.
Parameters
Tag
string:
Maximum length is 255 characters
Custom data that you can add to this item
ReportDate
timestamp
The date when the report was executed
DownloadURL
string:
Maximum length is 255 characters
The URL to download the report
CallbackURL
string:
Maximum length is 255 characters
A URL that we will ping when the report is ready to download (works in a similar way to the hooks)
DownloadFormat
DownloadFormat:
CSV
The file format for the report download
The format of the report download
ReportType
ReportType:
TRANSACTIONS, WALLETS
The type of report
The type of report
Sort
ColumnAndDirection:
CreationDate:ASC / CreationDate:DESC
The column to sort against and direction
Preview
bool:
true, false
Whether the report should be limited to the first 10 lines (and therefore quicker to execute)
Filters
Filters:
View Sub-parameters
An object of various filters for the report
Filters.BeforeDate
timestamp
To return only resources that have CreationDate BEFORE this date
Filters.AfterDate
timestamp
To return only resources that have CreationDate AFTER this date
Filters.Type
list
The type of the transaction
Filters.Status
list
The status of the transaction
Filters.Nature
list
The nature of the transaction
Filters.MinDebitedFundsAmount
int
The minimum amount of DebitedFunds
Filters.MinDebitedFundsCurrency
Currency:
AED, AUD, CAD, CHF, CZK, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR
The currency for the minimum amount of DebitedFunds
Filters.MaxDebitedFundsAmount
int
The maximum amount of DebitedFunds
Filters.MaxDebitedFundsCurrency
Currency:
AED, AUD, CAD, CHF, CZK, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR
The currency for the maximum amount of DebitedFunds
Filters.MinFeesAmount
int
The minimum amount of Fees
Filters.MinFeesCurrency
Currency:
AED, AUD, CAD, CHF, CZK, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR
The currency for the minimum amount of Fees
Filters.MaxFeesAmount
int
The maximum amount of Fees
Filters.MaxFeesCurrency
Currency:
AED, AUD, CAD, CHF, CZK, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR
The currency for the maximum amount of Fees
Filters.AuthorId
string:
Maximum length is 255 characters
A user's ID
Filters.WalletId
string:
Maximum length is 255 characters
The ID of a wallet
Columns
list
A list of columns/infos to show in the report - you can choose from: Alias, AuthorId, BankAccountId, BankWireRef, CardId, CardType, Country, CreationDate,CreationDate:ISO,CreditedFundsAmount, CreditedFundsCurrency, CreditedUserId, CreditedWalletId, Culture, DebitedFundsAmount, DebitedFundsCurrency, DebitedWalletId, DeclaredDebitedFundsAmount, DeclaredDebitedFundsCurrency, DeclaredFeesAmount, DeclaredFeesCurrency, ExecutionDate,ExecutionDate:ISO ExecutionType, ExpirationDate,ExpirationDate:ISO, FeesAmount, FeesCurrency, Id, Nature, PaymentType, PreauthorizationId, ResultCode, ResultMessage, Status, Tag, Type, WireReference
ResultCode
string:
Maximum length is 255 characters
The result code
ResultMessage
string:
Maximum length is 255 characters
A verbal explanation of the ResultCode