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

OpenBatchesSummaryDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

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)
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.
lastUpdatedUtc required string (date-time)
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.
processors required array of ProcessorOpenBatchGroupDto array of ProcessorOpenBatchGroupDto One group per processor the merchant's unsettled transactions resolve to. Settlement close fans out per (merchant, processor) and produces one `SettlementBatch` per processor, so the preview is grouped by processor first to mirror that fan-out; each group carries its own payment-type breakdown, totals, and batch identifiers. 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 ProcessorOpenBatchGroupDto:

Field Type Description
processorKey required string Lower-cased processor key (the same key the settlement close fans out on, derived from the transaction's `ProcessorKey`). Empty for the unassigned group (see `isUnassigned`). 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.
processorName required string Friendly processor name resolved from the merchant's active processor profiles, when one matches `processorKey`; otherwise `null` (callers fall back to the key). 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.
isUnassigned required boolean True when this group holds transactions that carry no `ProcessorKey`. Such rows are intentionally excluded from every per-processor settlement close (the per-processor scoping invariant), so they cannot be closed from this view; the group is surfaced read-only so an operator can see that orphaned transactions exist.
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.
isProcessorInactive required boolean True when this processor has unsettled transactions but no <em>active</em> processor profile on the merchant (e.g. the profile was deactivated after the transactions were authorized). The settlement close fans out only over active processor keys, so such a batch cannot be closed from this view; it is surfaced read-only and routed to targeted re-settle / recovery.
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.
openBatchId required string Representative open (gateway) batch id for this processor's current open batch. Passed back on a manual close to scope the run to this processor's batch. 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.
processorBatchId required string Representative processor batch id for this processor's open batch, when assigned. 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.
paymentTypes required array of PaymentTypeOpenBatchSummaryDto array of PaymentTypeOpenBatchSummaryDto Per-payment-type breakdown within this processor's open batch. 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.
totals required OpenBatchTotalsDto OpenBatchTotalsDto Processor-level rollup (count and net amount) across this group's payment types.
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.
lastUpdatedUtc required string (date-time) When this group's projection was computed (UTC).
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.