This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:57 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
A transaction summary aggregate together with the UTC window it was computed over.
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
startDateUtcrequired
string (date-time)
The inclusive UTC start of the window the aggregate covers. This is the request's bound
canonicalised to UTC, not the raw value, so it shows how the input was interpreted.
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.
endDateUtcrequired
string (date-time)
The exclusive UTC end of the window the aggregate covers. This is the request's bound
canonicalised to UTC, not the raw value, so it shows how the input was interpreted.
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.
The rollup rows, ordered by descending gross amount, then by merchant id or payment type so
the order is stable across identical requests. Empty when nothing in the window is visible
to the caller.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 PaymentTypeTransactionSummaryDto:
Field
Type
Description
paymentTyperequired
string
The payment-type bucket, drawn from the same granular vocabulary the transaction dashboard
reports (for example `Visa`, `MasterCard`, `Amex`, `Debit`, `Ebt`,
`Check`, `Ach`, `ApplePay`, `Generic`). Buckets with no activity in the
window are omitted.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.
transactionCountrequired
integer (int32)
Number of approved transactions contributing to this rollup, counting both the sale side and
the credit side. Declined and in-flight transactions are excluded.
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.
grossAmountrequired
number (double)
Sum of the approved sale-side amounts (authorization, sale, force, capture, capture-all and
repeat sale) for this payment type.
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.
netAmountrequired
number (double)
`grossAmount` less the approved credit-side amounts (returns and voids) for this
payment type.
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.
This body has no documented fields.
This model has no documented fields.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.