TransactionStatisticsRequestDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The population a transaction-statistics aggregate describes: the same filter, time bounds and merchant scope the transaction continuation list accepts, and nothing about paging.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
merchantId
required |
string (uuid) | Optional merchant to restrict the aggregate to. When omitted, the result covers every
merchant the caller is entitled to see. A merchant outside the caller's scope yields an empty
result rather than an error, because the caller is not entitled to learn whether it exists.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
minCreationTime
required |
string (date-time) | Inclusive lower bound on the transaction's creation time, in UTC.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
maxCreationTime
required |
string (date-time) | Exclusive upper bound on the transaction's creation time, in UTC.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
filter
required |
FilterGroup FilterGroup | The filter tree, in the same vocabulary the transaction continuation list accepts, including
its virtual fields (`PaymentMethod`, `DisplayGuid`, `EntryMode`,
`SettlementBatchId` and the rest), which are resolved server-side exactly as the list
resolves them.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
Fields of FilterGroup:
This body has no documented fields. | ||||||||||||||||||
This model has no documented fields.