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.
|
Fields of LineItemDefaults:
| Field |
Type |
Description |
|---|
defaultTaxType
required |
string
|
Default tax type pre-filled on new line items (e.g., "Sales", "VAT", "GST").
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.
| defaultUnitOfMeasure
required |
string
|
Default unit of measure pre-filled on new line items (e.g., "EA", "HR", "GAL", "FT").
nullablemax length 30
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.
| defaultCommodityCode
required |
string
|
Default commodity code pre-filled on new line items. Used for merchants with uniform product types.
nullablemax length 25
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 pre-filled on new line items. Expressed as a percentage (e.g., 8.25) or decimal (e.g., 0.0825).
Falls back to `defaultTaxRate` if not set.
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.
|
This body has no documented fields. |
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.
|
Fields of Level3LineItem:
| Field |
Type |
Description |
|---|
id
required |
string (uuid)
|
The unique identifier for the line item.
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.
| productCode
required |
string
|
The product code. Maximum length is 25 characters.
Conditional: When ProductCode is not null. Max length: 25.
nullablemax length 25
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.
| commodityCode
required |
string
|
The commodity code. Maximum length is 25 characters.
Conditional: When CommodityCode is not null. Max length: 25.
nullablemax length 25
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.
| description
required |
string
|
The description of the item. Maximum length is 25 characters.
Conditional: When Description is not null. Max length: 25.
nullablemax length 25
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.
| upc
required |
string
|
The Universal Product Code (UPC). Maximum length is 25 characters.
Conditional: When Upc is not null. Max length: 25.
nullablemax length 25
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.
| invoiceNumber
required |
string
|
The invoice number. Maximum length is 25 characters.
Conditional: When InvoiceNumber is not null. Max length: 25.
nullablemax length 25
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.
| taxType
required |
string
|
The tax type.
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.
| quantity
required |
number (double)
|
The quantity of the item. Must be non-negative.
Conditional: When Quantity 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.
| unitOfMeasure
required |
string
|
The unit of measure. Maximum length is 30 characters.
Conditional: When UnitOfMeasure is not null. Max length: 30.
nullablemax length 30
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.
| unitPrice
required |
number (double)
|
The unit price of the item. Must be positive.
Conditional: When UnitPrice 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.
| discountAmount
required |
number (double)
|
The discount amount. Must be non-negative.
Conditional: When DiscountAmount 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.
| totalAmount
required |
number (double)
|
The total amount for the line item. Must be positive.
Conditional: When TotalAmount 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.
| taxAmount
required |
number (double)
|
The tax amount. Must be non-negative.
Conditional: When TaxAmount 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.
| taxRate
required |
number (double)
|
The tax rate. Must be non-negative.
Conditional: When TaxRate 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.
| extendedAmount
required |
number (double)
|
The extended amount. Must be non-negative.
Conditional: When ExtendedAmount 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.
| freightAmount
required |
number (double)
|
The freight amount. Must be non-negative.
Conditional: When FreightAmount 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.
| dutyAmount
required |
number (double)
|
The duty amount. Must be non-negative.
Conditional: When DutyAmount 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.
| taxIncluded
required |
boolean
|
Value indicating whether tax is included in the price.
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.
| wicFoodCategoryCode
required |
string
|
The USDA WIC food category code for the item (e.g. the 2-digit category in the WIC
Authorized Product List). Optional; only populated for eWIC line items. Maximum length
is 25 characters.
Conditional: When WicFoodCategoryCode is not null. Max length: 25.
nullablemax length 25
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.
| wicSubcategoryCode
required |
string
|
The USDA WIC food subcategory code for the item, where the category is further
subdivided. Optional; only populated for eWIC line items. Maximum length is 25 characters.
Conditional: When WicSubcategoryCode is not null. Max length: 25.
nullablemax length 25
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.
| wicBenefitType
required |
WicBenefitType
WicBenefitType |
The coarse eWIC benefit mechanism this line redeems against. See
`WicBenefitType`. Optional; only populated
for eWIC line items.
Conditional: When WicBenefitType is not null.
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.
Unspecified |
Benefit mechanism not specified. Default for line items that carry other eWIC data (e.g. a category code) without an explicit mechanism classification. | FoodBenefit |
Standard fixed-quantity food benefit, redeemed by USDA food category/subcategory against the cardholder's remaining prescribed balance for that category. | CashValueBenefit |
Cash Value Benefit (CVB) / Cash Value Voucher (CVV): a dollar-denominated benefit for fruits and vegetables, redeemed against a remaining dollar balance rather than a fixed quantity. | InfantFormula |
Infant formula. Handled distinctly from standard food benefits because of contract-brand restrictions and manufacturer rebate accounting. |
| voucherReference
required |
string
|
The processor-issued voucher / benefit reference this line redeems against. Optional;
only populated for eWIC line items. Maximum length is 25 characters. Format is not
enforced here because it is processor-specific (the initial eWIC processor is selected
later in the epic).
Conditional: When VoucherReference is not null. Max length: 25.
nullablemax length 25
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.
| wicUnitOfMeasure
required |
string
|
The WIC-specific unit of measure for the item, which can differ from the generic
`unitOfMeasure` (WIC programs prescribe benefits in program-specific units).
Optional; only populated for eWIC line items. Maximum length is 30 characters.
Conditional: When WicUnitOfMeasure is not null. Max length: 30.
nullablemax length 30
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.
| wicEligibleQuantity
required |
number (double)
|
The quantity of this line that is WIC-eligible, which can be less than the cart-line
`quantity` when only part of the purchased quantity falls within the
cardholder's benefit. Must be non-negative. Optional; only populated for eWIC line items.
Conditional: When WicEligibleQuantity 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.
| wicEligibleAmount
required |
number (double)
|
The amount of this line that is WIC-eligible, which can be less than the cart-line
`totalAmount` when only part of the line is covered by the benefit. Must be
non-negative. Optional; only populated for eWIC line items.
Conditional: When WicEligibleAmount 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 body has no documented fields. |