Columns
The User Wallet Transactions report has the following available columns and columns used by default.Column | Description | Included by default |
---|---|---|
ClientId | Unique identifier associated with the API key | Yes |
TransactionId | Unique identifier of the transaction | Yes |
CreationDate | Unix timestamp of the date and time at which the transaction was created | Yes |
CreationDate:ISO | ISO format of the date and time at which the transaction was created | No |
ExecutionDate | Unix timestamp of the date and time at which the transaction was executed | Yes |
ExecutionDate:ISO | ISO format of the date and time at which the transaction was executed | No |
AuthorId | Unique identifier of the user at the source of the transaction | Yes |
CreditedUserId | The unique identifier of the credited user | Yes |
DebitedFundsAmount | Amount of the debited funds in the currency of the debited amount | Yes |
DebitedFundsCurrency | Currency of the debited amount | Yes |
CreditedFundsAmount | Amount of the credited funds in the currency of the credited amount | Yes |
CreditedFundsCurrency | Currency of the credited amount | Yes |
FeesAmount | Amount of the fees in the currency of the fees | Yes |
FeesCurrency | Currency of the fees | Yes |
Type | Type of the transaction: PAYIN, TRANSFER, CONVERSION, PAYOUT | Yes |
Nature | Nature of the transaction: REGULAR, REPUDIATION, REFUND, SETTLEMENT | Yes |
CreditedWalletId | Unique identifier of the credited wallet | Yes |
DebitedWalletId | Unique identifier of the debited wallet | Yes |
BankAccountId | Unique identifier of the bank account | Yes |
PreauthorizationId | Unique identifier of the preauthorization | Yes |
BankWireRef | For payouts, custom description to appear on the user’s bank statement along with the platform name | Yes |
CardId | Unique identifier of the card | Yes |
CardAlias | The card number, partially obfuscated | Yes |
CardType | The type of the card | Yes |
CardCountry | The country of the card | Yes |
CardExpirationDate | The expiry date of the card | Yes |
Culture | The language in which the payment page is to be displayed | Yes |
DeclaredDebitedFundsAmount | Amount of the declared funds of the pay-in bank wire | Yes |
DeclaredDebitedFundsCurrency | Currency of the declared funds of the pay-in bank wire | Yes |
DeclaredFeesAmount | Amount of the declared fees of the pay-in bank wire | Yes |
DeclaredFeesCurrency | Currency of the declared fees of the pay-in bank wire | Yes |
ExecutionType | Execution type of the pay-in | Yes |
PaymentType | Payment type of the pay-in | Yes |
WireReference | The reference bank wire transfer (classic or to virtual IBAN) | Yes |
Generate via API
1
Set up webhooks
The API endpoint for the User Wallet Transactions report uses webhooks to notify your chosen URL that a report is ready for download.The time it takes for a report to be generated depends on the quantity of data. If exporting large amounts of data via API, ensure you have these webhook event types set up to know when to fetch the report:
REPORT_GENERATED
– Indicates that a report is ready for download at theDownloadURL
REPORT_FAILED
– Indicates that a report was not generated successfully
2
Define filters and columns
On the User Wallet Transactions report, the
Currency
, UserId
, and WalletId
filters are available.You can use them alone or in combination, in which case the report data satisfies both filters:UserId
andCurrency
– Report contains all transactions (credited or debited) in the currency whereUserId
is theAuthorId
UserId
andWalletId
– Report contains all transactions (credited or debited) in all currencies where theUserId
is specified as theDebitedWalletId
orCreditedWalletId
. Caution: If theWalletId
is not a wallet owned by theUserId
, then the report will be empty.
Currency
and WalletId
cannot be used together.If no Filters
are specified, the report contains all transactions crediting or debiting all user wallets.The columns set by default are listed above. You can customize this in the Columns
parameter by sending the full list of columns you wish to see in the report.3
Run the report
Run the report by calling the POST Create a Report endpoint with the The API response shows the
ReportType
set to USER_WALLET_TRANSACTIONS
.Send your desired date period in the AfterDate
and BeforeDate
fields, which refers to the transaction CreationDate
. Ensure that the difference between them is no more than 12 months and the AfterDate
is not more than 24 months ago.Send your defined filters in the Filters
parameter and, if not using the default columns, the full list of columns you wish to include in the Columns
parameter.USER_WALLET_TRANSACTIONS
Status
as PENDING
, indicating that the report is being generated.USER_WALLET_TRANSACTIONS
4
Download when ready
The report is ready for download when its status changes from
PENDING
to GENERATED
, which triggers the REPORT_GENERATED
webhook.Call the GET View a Report endpoint to retrieve the DownloadURL
value where you can download the report.If the Status
changes to FAILED
, triggering the REPORT_FAILED
webhook, then more information about why the report could not be generated is available in the ResultCode
and ResultMessage
.5
Repeat process as needed
The User Wallet Transactions report is valid for 31 days. After this, its
Status
changes to EXPIRED
at it is no longer available for download.You can re-generate another report with the same parameters and update the date range for the latest period.Note – You can schedule reports in the DashboardThe Dashboard features a scheduling feature that enables you to automatically generate the same report daily, weekly, monthly, or quarterly.
Legacy transactions report
There is a legacy Transactions report that is available via the legacy POST Create a Transactions Report endpoint and the legacy Dashboard. Instead of webhooks, the legacy Transactions report uses aCallbackURL
in the same way as the Wallets report.
The BeforeDate
and AfterDate
filters allow you to 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. Other Filters
are available.
The User Wallet Transactions report described above replaces this legacy report and provides the same data.
The columns of the legacy Transactions report are listed below.
Column | Description | Included by default |
---|---|---|
Alias | The partially hidden number of the card used for the transaction. | No |
AuthorId | The unique identifier of the user at the source of the transaction. | Yes |
BankAccountId | The unique identifier of the bank account to which the payout is made. | No |
BankWireRef | Custom description to appear on the user’s bank statement along with the platform name. | No |
CardId | The unique identifier of the card used for the transaction. | No |
CardType | The type of the card among the following: CB_VISA_MASTERCARD, AMEX, MAESTRO, P24, IDEAL, BCMC. | No |
Country | The country of the card (which is the same as the country of the issuer). | No |
CreationDate | The date and time at which the transaction was created. | Yes |
CreationDate:ISO | The date and time at which the transaction was created in the following format: dd/MM/yyyy HH:mm:ss. | No |
CreditedFundsAmount | The amount of credited funds (CreditedFunds = DebitedFunds - Fees). | Yes |
CreditedFundsCurrency | The currency of the credited funds. | Yes |
CreditedUserId | The unique identifier of the user whose wallet is credited. | Yes |
CreditedWalletId | The unique identifier of the credited wallet. | Yes |
Culture | The language in which the redirection page is displayed. | No |
DebitedFundsAmount | The amount of debited funds. | Yes |
DebitedFundsCurrency | The currency of the debited funds. | Yes |
DebitedWalletId | The unique identifier of the debited wallet. | Yes |
DeclaredDebitedFundsAmount | The amount of the declared debited funds for a direct bank wire pay-in. | No |
DeclaredDebitedFundsCurrency | The currency of the declared debited funds for a direct bank wire pay-in. | No |
DeclaredFeesAmount | The amount of the declared fees for a direct bank wire pay-in. | No |
DeclaredFeesCurrency | The currency of the declared fees for a direct bank wire pay-in. | No |
ExecutionDate | The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. | Yes |
ExecutionDate:ISO | The date and time at which the transaction status changed to SUCCEEDED, in the following format: dd/MM/yyyy HH:mm:ss. | No |
ExecutionType | The type of execution for a pay-in: WEB, DIRECT, EXTERNAL_INSTRUCTION. | No |
ExpirationDate | The date at which the card used for the transaction will expire. | No |
FeesAmount | The amount of the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet). | Yes |
FeesCurrency | The currency of the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet). | Yes |
Id | The unique identifier of the transaction. | Yes |
Nature | The nature of the transaction, providing more information about the context in which the transaction occurred: REGULAR, REPUDIATION, REFUND, SETTLEMENT. | Yes |
PaymentType | The payment type of the pay-in. | Yes |
PreauthorizationId | The unique identifier of the Preauthorization object against which a preauthorized pay-in can be made. | No |
ResultCode | The code indicating the result of the operation. | Yes |
ResultMessage | The explanation of the result code. | Yes |
Status | The status of the transaction (created, succeeded, or failed). | Yes |
Tag | Custom data that can be added to the transaction. | Yes |
Type | The type of the transaction: PAYIN, TRANSFER, PAYOUT. | Yes |
WireReference | The reference which the end user must provide when making a direct bank wire pay-in. | No |