TransactionStatisticsDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Count and total amount over every transaction matching a filter, grouped by transaction type, by payment type and by result code.
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 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
transactionCount
required |
integer (int64) | The number of matching transactions folded into the three groupings.
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.
| ||||||||||||
totalAmount
required |
number (double) | The sum of the matching transactions' totals.
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.
| ||||||||||||
truncated
required |
boolean | Whether the scan stopped at `MaxScannedTransactions`
before the filtered set ran out, in which case every figure is over a prefix of that set.
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.
| ||||||||||||
byTransactionType
required |
array of TransactionStatisticsBucketDto array of TransactionStatisticsBucketDto | Count and total per transaction type, keyed by the `TransactionType` member name
(`Sale`, `Authorization`, `Return`, ...), ordered by descending count.
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.
| ||||||||||||
Fields of each TransactionStatisticsBucketDto: This body has no documented fields. | ||||||||||||||
byPaymentType
required |
array of TransactionStatisticsBucketDto array of TransactionStatisticsBucketDto | Count and total per payment method, keyed by the `PaymentMethodsGranular` member name
(`Visa`, `MasterCard`, `Check`, `AlternativePayment`, ...), resolved by
the same rule every transaction read surface uses, ordered by descending count.
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.
| ||||||||||||
Fields of each TransactionStatisticsBucketDto:
This body has no documented fields. | ||||||||||||||
byResultCode
required |
array of TransactionStatisticsBucketDto array of TransactionStatisticsBucketDto | Count and total per gateway result, keyed by the `ResultCode` member name (`Ok`,
`Declined`, ...), ordered by descending count. A transaction that recorded no response
at all falls in the bucket keyed `NoResultKey`.
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.
| ||||||||||||
Fields of each TransactionStatisticsBucketDto:
This body has no documented fields. | ||||||||||||||
This model has no documented fields.