v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
MERCHANTS

Get a merchant's properties

get/v3/merchants/{mId}/properties

Path parameters

mIdstring required

Merchant Id

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Response

defaultCurrencystring
tipsEnabledboolean
receiptPropertiesstring
summaryHourinteger
signatureThresholdinteger
hasDefaultEmployeeboolean
tipRateDefaultinteger
onPaperTipSignaturesboolean
autoLogoutboolean
orderTitle'NONE' | 'MANUAL' | 'AUTOMATIC'
orderTitleMaxinteger
resetOnReportingTimeboolean
notesOnOrdersboolean
deleteOrdersboolean
removeTaxEnabledboolean
groupLineItemsboolean
alternateInventoryNamesboolean
autoPrintboolean
infoleaseSuppressBillingboolean
infoleaseSuppressPlanBillingboolean
shippingAddressstring
marketingEnabledboolean
supportPhonestring
supportEmailstring
manualCloseoutboolean
manualCloseoutPerDeviceboolean
autoCloseoutTimezonestring
showCloseoutOrdersboolean
sendCloseoutEmailboolean
stayInCategoryboolean
localestring

The locale of the merchant.

timezonestring
vatboolean

Whether this merchant is in a VAT country

vatTaxNamestring

The VAT tax name that is shown on receipts

appBillingSystemstring

Temporary while we are switching US billing systems

abaAccountNumberstring

The ABA Account Number. Supplied by First Data.

ddaAccountNumberstring

The Masked DDA Account Number. Supplied by First Data.

trackStockboolean
updateStockboolean
allowClockOutWithOpenOrdersboolean
logInClockInPromptboolean
pinLengthinteger
cashBackEnabledboolean

Whether cash back is enabled for this merchant

cashBackOptionsstring

List of cash back possible cash back amounts

maxCashBackinteger

The maximum amount of cash back that the customer can select.

hierarchystring

Merchant hierarchy (Business, Bank, Agent, Corp, Chain). Supplied by First Data.

hasConsentedboolean

Whether or not merchant has consented to infolease billing

merchantBoardingStatusstring

This is used to identify if the merchant is self-boarded

printedFirstDataReceiptLogoEnabledboolean

Whether we display the First Data receipt logo

merchantPrivacyPolicyUrlstring

Merchant-specified privacy policy url

disablePrintTaxesPaymentOnReceiptsboolean

Whether we display the taxes table on receipts

limpModeAllowed2boolean

Per the new V2 TAMPER_EXPERIENCE (see feature flag) if this is true then setting the SRED_DISABLED merchant setting to true will result in the terminal parameter DENY_COMPROMISED_TX becoming false which enables a not provisioned (tampered) device with TransArmor SRED keys to take card payments without PIN. If this is false then setting SRED_DISABLED merchant to true setting will have no effect.

orderChangeReasonSettingboolean