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:52 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Per-merchant rollup of the transactions in the requested window.
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
merchantIdrequired
string (uuid)
The merchant the rollup belongs to.
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.
merchantNamerequired
string
The merchant's display name, or `null` when the name could not be resolved
(a merchant deleted after the transactions were taken, most commonly). The rollup is still
returned in that case so the amounts continue to reconcile.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) in the merchant's transaction currency.
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). This is
the figure that reconciles against what the merchant is owed for the window.
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.
transactionTypeCountsrequired
object
`transactionCount` broken down by transaction type, keyed by the
`TransactionType` member name (for example `Sale`, `Authorization`,
`Return`, `Void`). Types with no activity in the window are omitted rather than
carried as an explicit zero, so the keys present describe what the merchant actually did.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.
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.