View as Markdown

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.

`SurchargeNetworkPolicyDto`

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-network surcharge policy embedded in a merchant's configuration. Controls whether a given card network may be surcharged and, optionally, a network-specific rate override. Rates are decimal fractions (0.03 = 3%).

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

network required

string

The card network this policy applies to. Required, and it must be one of these spellings: Visa; Mastercard, Master Card or MC; Discover; Amex or American Express; JCB; Diners, Diners Club or Diners Club International; UnionPay, Union Pay, China Union Pay, China UnionPay or CUP; Interac. Case and surrounding spaces are ignored, and the name is stored and returned as sent. A configuration names each network once: two spellings of one network (Mastercard and MC) are the same network. nullablemax length 64

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.

isAllowed required

boolean

Whether surcharging is allowed on this network. 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.

customRate required

number (double)

Optional network-specific rate override (decimal fraction); null uses the default rate. Conditional: When CustomRate is not null. Range: 0 to 0.03. 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.