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

SettlementRunOutcomesDto

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

Result payload for `GetRecentSettlementOutcomesAsync`: the terminal (non-Pending) settlement batches for a merchant inside a recent 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
merchantId required string (uuid) The merchant the outcomes belong 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.
queriedAtUtc required string (date-time) The instant the lookback window was measured back from, taken once before the read.
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.
windowStartUtc required string (date-time) The start of the window: `QueriedAtUtc` minus the applied lookback. Every item's `CompletedAtUtc` is at or after this instant.
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 SettlementRunOutcomeDto array of SettlementRunOutcomeDto Terminal outcomes that completed inside the window, newest `CompletedAtUtc` first. 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 SettlementRunOutcomeDto:

Field Type Description
settlementBatchId required string (uuid) The settlement batch document id, for linking to batch detail.
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.
runId required string (uuid) The settlement run this batch belonged 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.
processorKey required string Lower-cased processor key the batch was produced for. Null for legacy rows and for synthetic rows written before a processor could be resolved. 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.
openBatchId required string The gateway batch id this run settled. Null when the run failed before one existed. 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.
status required SettlementBatchStatus SettlementBatchStatus The batch's terminal status. Never `Pending`.
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.
Pending Batch created, awaiting processor submission.
Completed Batch successfully settled with the processor.
Failed Batch settlement failed.
PartiallyCompleted Some transactions settled, others rejected by the processor.
NothingToSettle No transactions were eligible to settle for this (merchant, processor) group. A successful no-op outcome, distinct from Failed (a genuine fault) and from Completed (a real settle). Recorded so a settlement run leaves a history row for every targeted (merchant, processor) even when zero transactions are loaded. The short explanation is carried in SettlementBatch.ErrorMessage as the per-batch outcome detail.
OperatorActionRequired The batch could not be settled automatically and is parked for operator action. Distinct from Failed: a Failed closed batch is re-attempted on the next run (transient fault), whereas an OperatorActionRequired batch is deliberately excluded from automatic retry because blindly re-submitting it would just re-fail. Two causes park a batch here: a non-transient duplicate-batch-number processor rejection (the same processor BatchNumber will keep colliding until an operator bumps it), and exhaustion of SettlementConsts.MaxSettlementRetries transient retries. The batch's transactions are moved to SettlementStatus.SettlementOnHold so they stop auto-retrying; the reason is carried in SettlementBatch.ErrorMessage. The operator UI (follow-up story) lists these and can retry with a bumped processor BatchNumber.
TerminalContention The batch was not submitted because a concurrent settlement run already held the terminal lock for the same (Fiserv MerchID, TermID) pair (UMF Appendix M 42.1: only one batch at a time per terminal). Distinct from Failed: nothing went wrong, this run simply deferred to the run that already owned the terminal. The next scheduled run retries normally.
errorMessage required string The persisted operator-facing reason (`SettlementBatch.ErrorMessage`). Already sanitized at write time: raw exception text stays in the structured logs. 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.
completedAtUtc required string (date-time) When the batch reached its terminal state, falling back to its creation time when the batch has no recorded completion time. The lookback window and the newest-first order both use this value.
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.
triggerType required SettlementTriggerType SettlementTriggerType 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.
Auto
Manual
correlationId required string (uuid) 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.
instanceId required string 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.