WinkPG Docs
View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

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.

API reference Models

TransactionSummaryResultDtoOfMerchantTransactionSummaryDto

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
startDateUtc required 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.
endDateUtc required 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.
items required array of MerchantTransactionSummaryDto array of MerchantTransactionSummaryDto 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 MerchantTransactionSummaryDto:

Field Type Description
merchantId required 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.
merchantName required 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.
transactionCount required 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.
grossAmount required 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.
netAmount required 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.
transactionTypeCounts required 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 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.