enable
required |
boolean
|
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.
|
applyLevel2DefaultsToApi
required |
boolean
|
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.
|
applyLevel3DefaultsToApi
required |
boolean
|
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.
|
applyLevel2DefaultsToVt
required |
boolean
|
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.
|
applyLevel3DefaultsToVt
required |
boolean
|
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.
|
applyLevel2DefaultsToHpp
required |
boolean
|
Whether Level 2 defaults apply to Hosted Payment Page transactions.
`null` means "follow `applyLevel2DefaultsToApi`", which is the behaviour every
merchant document written before this toggle existed already had: hosted page transactions were
bucketed under the API toggle.
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.
|
applyLevel3DefaultsToHpp
required |
boolean
|
Whether Level 3 defaults apply to Hosted Payment Page transactions.
`null` means "follow `applyLevel3DefaultsToApi`". See
`applyLevel2DefaultsToHpp` for why.
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.
|
defaultMerchantZip
required |
string
|
Default merchant zip code for L2 enhanced data. When set, takes priority over the merchant's contact address zip.
nullablemax length 10
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.
|
defaultTaxRate
required |
number (double)
|
Default tax rate for L2/L3 enhanced data. Takes priority over the VT tax field's default rate.
Expressed as a percentage (e.g., 8.25 for 8.25%) or as a decimal (e.g., 0.0825).
nullablemin 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.
|
defaultShipFromZip
required |
string
|
Default ship-from zip code for L3 enhanced data. When set, takes priority over the merchant's contact address zip.
nullablemax length 10
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.
|
defaultDestinationCountryCode
required |
string
|
Default destination country code for L3 enhanced data (ISO 3166-1 alpha-3, e.g., "USA").
nullablemax length 3
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.
|
defaultDutyAmount
required |
number (double)
|
Default duty amount for L3 enhanced data. Set to 0.00 for domestic-only merchants.
nullablemin 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.
|
defaultFreightAmount
required |
number (double)
|
Default freight/shipping amount for L3 enhanced data.
nullablemin 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.
|
defaultDiscountAmount
required |
number (double)
|
Default header-level discount amount for L3 enhanced data.
nullablemin 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.
|
defaultLineItemValues
required |
LineItemDefaults
LineItemDefaults |
Default field values applied to every new line item added in the Virtual Terminal.
Conditional: When DefaultLineItemValues is not null.
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.
|
defaultLineItem
required |
Level3LineItem
Level3LineItem |
A template line item that auto-populates as the first line item on new transactions.
Useful for single-product merchants (parking, subscriptions, recurring services).
When null, no template line item is added.
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.
|