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
SurchargeStageOutcomeA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
An entry in the surcharge evaluation audit trail recording a single contributor's verdict.
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 contributorName
required string
Name of the contributor that produced this outcome.
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.
order
required integer (int32)
The contributor's execution order in the pipeline.
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.
passed
required boolean
Whether this contributor passed (did not veto) the surcharge.
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.
reason
required string
Human-readable description of the contributor's verdict.
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.
reasonCode
required string
Stable string reason code (e.g. `nameof(SurchargeIneligibilityReason.DebitCard)`) when this
contributor vetoed; `null` when `passed` is true.
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.
Next steps