| Field | Type | Required | Description | Example |
|---|---|---|---|---|
balanceId |
String | ✔️ | Provide the ID of the related balance. | bal_gVMhHKqSSRYJyPsuoPNFH |
from |
String | ✔️ | The start date of the report, in YYYY-MM-DD format. The from date is'inclusive', and in Central European Time. This means a report with for example from=2024-01-01 willinclude transactions from 2024-01-01 0:00:00 CET and onwards. |
2024-01-01 |
until |
String | ✔️ | The end date of the report, in YYYY-MM-DD format. The until date is 'exclusive', and in Central European Time.This means a report with for example until=2024-02-01 will include transactions up until2024-01-31 23:59:59 CET. |
2024-02-01 |
grouping |
Optional<BalanceReportGrouping> | ➖ | You can retrieve reports in two different formats. With the status-balances format, transactions are groupedby status (e.g. pending, available), then by transaction type, and then by other sub-groupings whereavailable (e.g. payment method). With the transaction-categories format, transactions are grouped bytransaction type, then by status, and then again by other sub-groupings where available. |
status-balances |
testmode |
Optional<Boolean> | ➖ | You can enable test mode by setting the testmode query parameter to true.Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. |
|
idempotencyKey |
Optional<String> | ➖ | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | 123e4567-e89b-12d3-a456-426 |