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-26 23:26 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The result of a surcharge-eligibility quote. A PCI-safe response carrying the eligibility verdict,
the resolved rate and computed amount, the total including the surcharge, the ineligibility reason
code when not eligible, and the disclosure copy the integrator renders verbatim (the merchant's own
wording when they have configured any, otherwise the platform default).
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
eligiblerequired
boolean
Whether the transaction may be surcharged.
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.
surchargeRaterequired
number (double)
The applied surcharge rate as a decimal fraction (0.03 = 3%); null when ineligible.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.
surchargeAmountrequired
number (double)
The computed surcharge amount, in the transaction currency; null when ineligible.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.
baseAmountrequired
number (double)
The base transaction amount the quote was computed against, in the transaction currency.
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.
totalWithSurchargerequired
number (double)
The base amount plus the computed surcharge, in the transaction currency; equals
`baseAmount` when ineligible.
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.
ineligibilityReasonrequired
string
The ineligibility reason code (the `SurchargeIneligibilityReason` name, e.g.
DebitCard, NonUsIssuedCard), or null when eligible.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.
requiresDisclosurerequired
boolean
Whether the caller must present a surcharge disclosure to the cardholder before payment.
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.
disclosureTextrequired
string
The ready-to-render disclosure text (rate stated plus the does-not-exceed-cost-of-acceptance
statement), matching what the Virtual Terminal and Hosted Payment Page show the same cardholder.
Non-null only when `eligible` 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.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.