The Report object
The Reportobject gives the possibility to download huge lists of transactions to CSV format for accounting or analysis purposes. This can be done either from the API or Dashboard.
You can choose certain filters including:
- A date range (
BeforeDateandAfterDate) - note that the range can’t be more than 6 months, and must be < 13 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
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.
Parameters
Idstring:
Maximum length is 255 characters
The item's ID
CreationDatetimestamp
When the item was created
Tagstring:
Maximum length is 255 characters
Custom data that you can add to this item
ReportDatetimestamp
The date when the report was executed
DownloadURLstring:
Maximum length is 255 characters
The URL to download the report
CallbackURLstring:
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)
DownloadFormatDownloadFormat:
CSV
The file format for the report download
The format of the report download
ReportTypeReportType:
TRANSACTIONS
The type of report
The type of report
SortColumnAndDirection:
The column to sort against and direction, separated by a :
The column to sort against and direction
Previewbool:
true, false
Whether the report should be limited to the first 10 lines (and therefore quicker to execute)
FiltersFilters:
View Sub-parameters
An object of various filters for the report
Filters.BeforeDatetimestamp
To return only resources that have CreationDate BEFORE this date
Filters.AfterDatetimestamp
To return only resources that have CreationDate AFTER this date
Filters.Typelist
The type of the transaction
Filters.Statuslist
The status of the transaction
Filters.Naturelist
The nature of the transaction
Filters.MinDebitedFundsAmountint
The minimum amount of DebitedFunds
Filters.MinDebitedFundsCurrencyCurrencyIso:
EUR, GBP, PLN, CHF, NOK, SEK, DKK, USD (beta), CAD (beta), AUD (beta), XXX
ISO 4217 format
The currency for the minimum amount of DebitedFunds
Filters.MaxDebitedFundsAmountint
The maximum amount of DebitedFunds
Filters.MaxDebitedFundsCurrencyCurrencyIso:
EUR, GBP, PLN, CHF, NOK, SEK, DKK, USD (beta), CAD (beta), AUD (beta), XXX
ISO 4217 format
The currency for the maximum amount of DebitedFunds
Filters.MinFeesAmountint
The minimum amount of Fees
Filters.MinFeesCurrencyCurrencyIso:
EUR, GBP, PLN, CHF, NOK, SEK, DKK, USD (beta), CAD (beta), AUD (beta), XXX
ISO 4217 format
The currency for the minimum amount of Fees
Filters.MaxFeesAmountint
The maximum amount of Fees
Filters.MaxFeesCurrencyCurrencyIso:
EUR, GBP, PLN, CHF, NOK, SEK, DKK, USD (beta), CAD (beta), AUD (beta), XXX
ISO 4217 format
The currency for the maximum amount of Fees
Filters.AuthorIdstring:
Maximum length is 255 characters
A user's ID
Filters.WalletIdstring:
Maximum length is 255 characters
The ID of a wallet
Columnslist
A list of columns/infos to show in the report - you can choose from: Alias, AuthorId, BankAccountId, BankWireRef, CardId, CardType, Country, CreationDate, CreditedFundsAmount, CreditedFundsCurrency, CreditedUserId, CreditedWalletId, Culture, DebitedFundsAmount, DebitedFundsCurrency, DebitedWalletId, DeclaredDebitedFundsAmount, DeclaredDebitedFundsCurrency, DeclaredFeesAmount, DeclaredFeesCurrency, ExecutionDate, ExecutionType, ExpirationDate, FeesAmount, FeesCurrency, Id, Nature, PaymentType, PreauthorizationId, ResultCode, ResultMessage, Status, Tag, Type, WireReference
ResultCodestring:
Maximum length is 255 characters
The result code
ResultMessagestring:
Maximum length is 255 characters
A verbal explanation of the ResultCode