Skip to main content

Documentation

Merchant Configuration Fields

Each entry in Config.merchants and Config.activeMerchant is a MerchantConfig:

Field

Type

Description

id

int

Internal ID used with switchMerchant and MERCHANT_ID

terminalId

String

Terminal ID shown on receipts

merchantId

String

Merchant ID

merchantNameAndLocation

String

Merchant name and location shown on receipts

merchantAddress

String

Street address shown on receipts

merchantCity

String

City shown on receipts

currencyCode

String

ISO 4217 alpha-3 currency code

currencyNum

String

ISO 4217 numeric-3 currency code

countryCode

String

Country code(ISO 4217 numeric-3)

merchantPassword

String

Merchant PIN code

mailMerchant

boolean

Whether merchant receipts are emailed

smsMerchant

boolean

Whether merchant receipts are sent by SMS

mailMerchantAddress

String

Email address for merchant receipt delivery

printMerchantReceipt

boolean

Whether to print the merchant copy

emailMerchantReceipt

boolean

Whether to email the merchant receipt

emailEodReceipt

boolean

Whether to email the EOD receipt

cardholderEmailEnabled

boolean

Whether to offer email receipts to cardholders

cardholderSmsEnabled

boolean

Whether to offer SMS receipts to cardholders

dbaName

String

DBA (Doing Business As) name for partners

dbaCity

String

DBA city for partners

sponsoredMerchantId

String

Sponsored merchant ID for partner arrangements

preauth

boolean

Whether pre-authorisation is supported

moto

boolean

Whether MOTO transactions are supported

amexSupportEnabled

boolean

Whether American Express cards are accepted

dccSupported

boolean

Whether Dynamic Currency Conversion is supported

tipEnabled

boolean

Whether tipping is enabled

tipPrompted

boolean

Whether tip is prompted automatically

receiptMerchantLine3receiptMerchantLine6

String

Extra lines printed on the merchant receipt

MerchantResult (from getAvailableMerchants)

A lighter representation returned by getAvailableMerchants:

Field

Type

Description

id

int

Merchant ID for use with switchMerchant

terminalId

String

Terminal ID

merchantId

String

Merchant ID

merchantName

String

Merchant display name

currencyCode

String

ISO 4217 alpha currency code