SurchargeQuoteRequestDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Request for the authenticated, merchant-scoped surcharge-eligibility quote endpoint. A direct API integrator supplies a BIN prefix (never a full PAN), the transaction amount, the cardholder state, and the presentment channel; the platform evaluates surcharge eligibility and returns a `SurchargeQuoteResultDto`.
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 quote is for.
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.
| ||||||||||||||
binPrefix
required |
string | The card BIN prefix: 6 to 8 digits only. A full PAN (or any value longer than 8 digits) is
rejected at validation. Used to resolve the card brand, funding source, and issuer country.
nullablepattern ^[0-9]{6,8}$
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.
| ||||||||||||||
amount
required |
number (double) | The base transaction amount a surcharge would apply to, in the transaction currency.
greater than 0
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.
| ||||||||||||||
cardholderState
required |
string | The cardholder billing state code (2-letter, e.g. CO), or null when unknown. Governs the
per-state cap / prohibition. Merchant-state rules are applied authoritatively at auth time.
Conditional: When CardholderState is not empty.
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.
| ||||||||||||||
channel
required |
TransactionSource TransactionSource | The presentment channel the quote is for. Defaults to `Api`, the
natural channel for a direct integrator; surcharge eligibility is channel-restricted.
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.