WinkPG Docs

View as Markdown

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:52 UTC.

`TransactionDecisionNote`

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

A single, system-emitted explanation of a decision made about a transaction. Stored append-only in the top-level `Transaction.DecisionNotes` collection.

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

category required

TransactionDecisionNoteCategory TransactionDecisionNoteCategory

The subsystem that made the decision.

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.

`ConvenienceFee`	The convenience-fee evaluator (first consumer).
`Surcharge`	The surcharge eligibility pipeline. Records why a surcharge was not applied to a transaction on an enabled merchant (e.g. debit/prepaid card, restricted state, unsupported network), so the veto reason is queryable/displayable rather than buried in the /SurchargeResult snapshot. The code is a SurchargeIneligibilityReason value name.
`FraudReview`	The manual fraud-review hold. Records that a transaction was parked for human disposition and how that hold ended, so the timeline explains a gap between screening and authorization rather than leaving an operator to infer it from /FraudReviewData. The code is one of ReviewHeld, ReviewApproved, ReviewDeclined, or ReviewExpired.

outcome required

TransactionDecisionNoteOutcome TransactionDecisionNoteOutcome

The decision's effect on the transaction.

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.

`Applied`	The thing was applied (e.g. a fee was assessed).
`Suppressed`	The thing was deliberately not applied (e.g. a fee was waived/suppressed).
`Adjusted`	The thing was applied at a modified value (e.g. a capped/percentage amount).
`Blocked`	The transaction was blocked by the decision.
`Info`	Purely informational; no effect on amounts or flow.

severity required

TransactionDecisionNoteSeverity TransactionDecisionNoteSeverity

Display severity (styling only).

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.

`Info`	Neutral/informational styling.
`Warning`	Attention styling (e.g. an expected fee that did not apply).

createdAt required

string (date-time)

UTC timestamp the note was recorded.

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.

code required

string

The discriminated reason within the `category` (e.g. `"SuppressedChannel"`). Owned by the consuming subsystem; resolved to copy with `category` at render time. 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.

amountDelta required

number (double)

Signed amount impact where meaningful (e.g. the waived/assessed fee). Currency is implied by the transaction. Null when not applicable. 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.

occurredOnStage required

string

Optional pipeline stage the decision occurred on, for ordering/diagnostics. 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.