SurchargeStatePolicyDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Data-transfer representation of a per-state surcharge policy embedded in a merchant's configuration. Expresses how a US state restricts surcharging and, where the state imposes a numeric ceiling, the cap itself. Rates are decimal fractions (0.02 = 2%).
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 code (e.g. "CO", "NY").
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.
| ||||||
restrictionType
required |
SurchargeStateRestrictionType SurchargeStateRestrictionType | How the state restricts surcharging.
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.
| ||||||
capRate
required |
number (double) | Optional state-imposed maximum rate (decimal fraction). Null means the state applies no numeric
cap beyond network rules.
Conditional: When CapRate is not null. Must be >= 0.
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.