SurchargeEffectiveStatePolicyDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
One state's row in the effective state-policy view: the platform's seeded rule, the merchant's own override, and the outcome of merging the two. Returned when you read a merchant's effective surcharge state policies. Read-only: nothing here is stored, and the merchant half is edited through `SurchargeStatePolicyDto`.
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 | ||||||
|---|---|---|---|---|---|---|---|---|
stateCode
required |
string | Two-letter US state or territory code, uppercase.
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.
| ||||||
hasMerchantOverride
required |
boolean | Whether the merchant has an entry of their own for this state. Reported separately from
`merchantRestrictionType` because a null restriction cannot distinguish "no
entry" from "an entry that never recorded one".
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.
| ||||||
merchantRestrictionType
required |
SurchargeStateRestrictionType SurchargeStateRestrictionType | The merchant's configured restriction for this state, or `null` when the merchant has no
entry for it (in which case the platform layer alone governs). Check
`hasMerchantOverride` to tell that apart from an entry with no restriction recorded.
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.
| ||||||
merchantCapRate
required |
number (double) | The merchant's configured cap for this state (decimal fraction), if any.
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.
| ||||||
platformRestrictionType
required |
SurchargeStateRestrictionType SurchargeStateRestrictionType | The platform-seeded restriction governing this state on the evaluation date, or `null` when
the platform seeds no rule for it.
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.
| ||||||
platformCapRate
required |
number (double) | The platform-seeded cap for this state (decimal fraction), if any.
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.
| ||||||
platformCitation
required |
string | The statute the platform rule cites, for display beside the row. Rationale text only; nothing
branches on it.
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.
| ||||||
effectiveIsProhibited
required |
boolean | Whether surcharging is prohibited in this state by the merged outcome. Reflects the enforcement
gate: with platform rules unenforced, only the merchant layer can produce a prohibition.
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.
| ||||||
prohibitionSource
required |
SurchargeStateRuleSource SurchargeStateRuleSource | Which layer produced `effectiveIsProhibited`.
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.
| ||||||
effectiveCapRate
required |
number (double) | The merged cap (decimal fraction), or `null` when neither layer imposes one.
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.
| ||||||
capSource
required |
SurchargeStateRuleSource SurchargeStateRuleSource | Which layer produced `effectiveCapRate`.
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.
| ||||||
merchantEntryIsIneffective
required |
boolean | Whether the merchant's entry for this state is inert: it exists, but the merged outcome is
identical to what the platform layer produces alone, so removing it would change nothing. The
usual cause is an entry trying to relax a platform prohibition, which the merge ignores by
design. Computed server-side so the UI does not have to re-derive the merge to detect it.
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.