Add Tender Media
post
/config/sim/v1/sales/tenderMedia
Add a Tender Media record for the current organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that Identifies that who made the change
Tender Media Object
Root Schema : TenderMediaCURequestBody
Type:
Show Source
object-
belowThresholdPrintClassObjNum:
integer
Object number of the Print Class for the Tender Media when the check total amount is less than the RVC Order Routing Threshold Amount, in this case it will override the Print Class of the Tender Media.Example:
1 -
consumerDisplayName:
object NameTranslatedString
name of the Tender Media
-
creditCardOptions:
object creditCardOptions
An object containing the credit card options associated with the Tender / Media
-
dataExtensions:
object dataExtensions
An array of data extensions for the tender / media
-
effGrpObjNum:
integer
Effectivity Group object numberExample:
1 -
exemptTaxes:
string
A string value of 0s and 1s of length 64 representing tax ratesExample:
0000000000000000000000000000000000000000000000000000000000000000 -
externalReference1:
string
An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32Example:
ExternalReference1 -
externalReference2:
string
An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32Example:
ExternalReference2 -
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
holdType:
integer
the Hold Type for the tender 0 ??? Fire Order 1 ??? Keep Hold Status 2 ??? Hold OrderExample:
1 -
interfaceOptions:
object interfaceOptions
An object containing the interface link and options associated with the Tender / Media
-
keyType:
integer
The Key Type for this Tender/Media. 1 ??? Payment 2 ??? Service Total 3 ??? Pickup 4 ??? Loan. The default value for keyType is 1.Example:
1 -
mainLevelPopup:
integer
The Main Level that becomes active after pressing this Tender/Media. Enable Transaction Default to return the transaction to the default Main Level, select 0-Stay Down to retain the current transaction levels, or select a level 1-8 to become active.Example:
1 - menuLevels: object menuLevels
-
miscOptions:
object miscOptions
An array of miscellaneous options associated with the tender media
-
name(required):
object NameTranslatedString
name of the Tender Media
-
nlu:
integer
A unique NLU number (0-255) for this Tender/Media recordExample:
1 -
objectNum(required):
integer
Object number of the tender mediaExample:
1 -
opsOptions:
string
A string value of 0s and 1s of length 128 representing POS client behavior optionsExample:
11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000 -
paymentChargeTipOptions:
string
A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the payment charge tip options associated with Tender MediaExample:
11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000 -
printClassObjNum:
integer
Object number of the Print Class for the Tender Media.Example:
1 -
printOptions:
string
A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the print options associated with Tender MediaExample:
11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000 -
privilegeGroup:
integer
Select a privilege group (0-3) to restrict this Tender/Media to only employees who are assigned to the same privilege group. Set to 0 to allow all employees to use the tender.Example:
1 -
reportGroupObjnum:
integer
Object number of the Report Group to which this Tender/Media record belongs.Example:
1 -
srmPaymentType:
integer
The SRM Payment Type for the Tender/Media 0 ??? None 1 ??? ARG 2 ??? CRE 3 ??? DEB 4 ??? AUT 5 ??? PKGExample:
1 -
subLevelPopup:
integer
The Sub Level that becomes active after pressing this Tender/Media. Enable Transaction Default to return the transaction to the default Sub Level, select 0-Stay Down to retain the current transaction levels, or select a level 1-8 to become activeExample:
1 -
svcObjNum:
integer
Object Number of the service charge to post charged tips. Use this field with Charge Payment keys (Credit Cards and Room Charges).Example:
1 -
tmSLUNum:
integer
Object number the Screen Lookup key on which to show the Tender/Media.Applicable only for keyType = 2 / 3 / 4Example:
1 -
transDefaultMainLevel:
boolean
return the transaction to the default transaction Main Level after pressing this Tender/MediaExample:
false -
transDefaultSubLevel:
boolean
return the transaction to the default transaction Sub Level after pressing this Tender/Media.Example:
false
Nested Schema : NameTranslatedString
Type:
objectname of the Tender Media
Example:
{
"en-US":"Order Device 1",
"es-MX":"Dispositivo de pedido 1"
}Nested Schema : creditCardOptions
Type:
objectAn object containing the credit card options associated with the Tender / Media
Show Source
-
baseLimit:
number
The amount that can be charged on a credit card before sending an authorization request to a credit card processor.Example:
0 -
caOfflineLimit:
number
The limit for which credit cards are considered to have a good authorization when the credit card service is offline. You must also select Use CA Offline Base Limit when CA Offline in the RVC Parameters moduleExample:
0 -
estimatedTipPercent:
number
The percentage amount (above the check amount) to authorize. Use this field to obtain an authorization that includes the potential tip amount. Override this setting at the revenue center by selecting Do Not Estimate Tips of Credit Card Authorizations.Example:
0 -
initialAuthAmt:
number
A charge amount to be authorized before sales begin. Enter 0.00 to prompt for an amount. This field is used at sites that require a credit card to have a certain amount available, so the workstation operator can begin a tab.Example:
0 -
noSignatureLimit:
number
the amount to be charged on a credit card before a voucher includes a signature line.Example:
0 -
offlineEstTipPercent:
number
The percentage amount (above the check amount) to authorize. Use this field to obtain an authorization that includes the potential tip amount. Override this setting at the revenue center by selecting Do Not Estimate Tips of Credit Card Authorizations.Example:
0 -
options:
string
A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the credit card options associated with Tender MediaExample:
11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000 -
preambles:
object preambles
An array of preambles defined for the tender/ media.
-
quickServiceLimit:
number
The amount that is checked by the system to determine if credit card vouchers are printed or not if Quick Service Transactions are enabled for an RVC (RVC Parameters Option 18 Enable Quick Service Transactions),. If the check total on the transaction is higher than the number in this field, a credit card voucher prints.Example:
0 -
secondLimit:
number
The amount above the initial authorization that must be exceeded before a second authorization is required. You must also select the credit card option Use Amount Secondary Floor Limits in the RVC Parameters moduleExample:
0 -
secondLimitPercent:
number
The percentage above the initial authorization amount that must be exceeded before a second authorization is required. You must also select the credit card option Use Percent Secondary Floor Limits in the RVC Parameters module.Example:
0 -
unAuthorizedAuthThreshold:
number
The limit for which credit cards are considered to have a good authorization when the workstation is offline. When this limit is exceeded, only employees with the Role privilege to exceed the threshold can pay transactions.Example:
0
Nested Schema : dataExtensions
Type:
objectAn array of data extensions for the tender / media
Show Source
-
columnName:
string
Name of the extention fieldExample:
Extention Column 1 -
value:
string
Value of the extention fieldExample:
Value 1
Nested Schema : interfaceOptions
Type:
objectAn object containing the interface link and options associated with the Tender / Media
Show Source
-
interfaceLinkNum:
integer
Object number of the interfaceExample:
1 -
options:
string
A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the interface options associated with Tender MediaExample:
11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000
Nested Schema : miscOptions
Type:
objectAn array of miscellaneous options associated with the tender media
Show Source
-
defaultTipPercent:
integer
The percentage amount to which the tip screen (on Signature Capture pads) defaults when using the Tender/Media.Example:
1 -
haloCode:
integer
the High Amount Lock Out value for the Tender/Media. The value must contain all zeroes except for the first digit.Example:
1 -
options:
string
A string value of 0s and 1s of length 128 representing Miscellaneous optionsExample:
11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000
Nested Schema : preambles
Type:
objectAn array of preambles defined for the tender/ media.
Show Source
-
end:
string
the end range of a preamble number for the credit card. If the preamble record defines a range (3050 to 3090), this field represents the end range (3090*). The end field, if specified, will only have numeric characters followed by a single * character. The length of start and end fields should be same. Value of start field has to be strictly lower than value of end field.Example:
3090* -
length:
integer
the number of digits in the credit card number that is associated with the preamble record. If the length field is specified, then both start and end fields' length before * should be less than or equal to the specified value of length field.Example:
4 -
start:
string
a preamble number for the credit card. If the preamble record defines a range (3050 to 3090), this field represents the begin range (3050*). The start field cannot be empty, and will only have numeric characters followed by a single * character.Example:
3050*
Response
Supported Media Types
- application/json
200 Response
A collection of Tender Media objects of the organization
Root Schema : TenderMediaResponse
Type:
Show Source
object-
effGrpObjNum(required):
integer
Effectivity Group object numberExample:
1 -
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
objectNum(required):
integer
Object number of the tender mediaExample:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html