1. Configuration and Content API Guide
  2. Tasks
  3. Sales
  4. Tender Media

Update Tender Media

post

/config/sim/v1/sales/updateTenderMedia

Updates a Tender Media record for the current organization.

Request

Supported Media Types
Header Parameters
Body ()
Tender Media Object
Root Schema : TenderMediaCURequestBody
Type: object
Show Source
  • 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
  • NameTranslatedString
    name of the Tender Media
  • creditCardOptions
    An object containing the credit card options associated with the Tender / Media
  • dataExtensions
    An array of data extensions for the tender / media
  • Effectivity Group object number
    Example: 1
  • A string value of 0s and 1s of length 64 representing tax rates
    Example: 0000000000000000000000000000000000000000000000000000000000000000
  • Unique hierarchy unit value
    Example: 1
  • the Hold Type for the tender 0 ??? Fire Order 1 ??? Keep Hold Status 2 ??? Hold Order
    Example: 1
  • interfaceOptions
    An object containing the interface link and options associated with the Tender / Media
  • The Key Type for this Tender/Media. 1 ??? Payment 2 ??? Service Total 3 ??? Pickup 4 ??? Loan
    Example: 1
  • 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
    An object containing the menu levels on which the Tender / Media is active
  • miscOptions
    An array of miscellaneous options associated with the tender media
  • NameTranslatedString
    name of the Tender Media
  • A unique NLU number (0-255) for this Tender/Media record
    Example: 1
  • Object number of the tender media
    Example: 1
  • A string value of 0s and 1s of length 128 representing POS client behavior options
    Example: 11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000
  • 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 Media
    Example: 11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000
  • Object number of the Print Class for the Tender Media.
    Example: 1
  • A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the print options associated with Tender Media
    Example: 11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000
  • 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
  • Object number of the Report Group to which this Tender/Media record belongs.
    Example: 1
  • The SRM Payment Type for the Tender/Media 0 ??? None 1 ??? ARG 2 ??? CRE 3 ??? DEB 4 ??? AUT 5 ??? PKG
    Example: 1
  • 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 active
    Example: 1
  • Object Number of the service charge to post charged tips. Use this field with Charge Payment keys (Credit Cards and Room Charges).
    Example: 1
  • Object number the Screen Lookup key on which to show the Tender/Media.Applicable only for keyType = 2 / 3 / 4
    Example: 1
  • return the transaction to the default transaction Main Level after pressing this Tender/Media
    Example: false
  • return the transaction to the default transaction Sub Level after pressing this Tender/Media.
    Example: false
Nested Schema : NameTranslatedString
Type: object
name of the Tender Media
Example:
{
    "en-US":"Order Device 1",
    "es-MX":"Dispositivo de pedido 1"
}
Nested Schema : creditCardOptions
Type: object
An object containing the credit card options associated with the Tender / Media
Show Source
  • The amount that can be charged on a credit card before sending an authorization request to a credit card processor.
    Example: 0
  • 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 module
    Example: 0
  • 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
  • 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
  • the amount to be charged on a credit card before a voucher includes a signature line.
    Example: 0
  • 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
  • A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the credit card options associated with Tender Media
    Example: 11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000
  • preambles
    An array of preambles defined for the tender/ media.
  • 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
  • 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 module
    Example: 0
  • 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
  • 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: object
An array of data extensions for the tender / media
Show Source
Nested Schema : interfaceOptions
Type: object
An object containing the interface link and options associated with the Tender / Media
Show Source
  • Object number of the interface
    Example: 1
  • A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the interface options associated with Tender Media
    Example: 11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000
Nested Schema : menuLevels
Type: object
An object containing the menu levels on which the Tender / Media is active
Show Source
  • A string value of 0s and 1s of length 8 representing Main Levels
    Example: 00001011
  • A string value of 0s and 1s of length 8 representing Sub levels
    Example: 00001011
Nested Schema : miscOptions
Type: object
An array of miscellaneous options associated with the tender media
Show Source
  • The percentage amount to which the tip screen (on Signature Capture pads) defaults when using the Tender/Media.
    Example: 1
  • the High Amount Lock Out value for the Tender/Media. The value must contain all zeroes except for the first digit.
    Example: 1
  • A string value of 0s and 1s of length 128 representing Miscellaneous options
    Example: 11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000
Nested Schema : preambles
Type: object
An array of preambles defined for the tender/ media.
Show Source
  • 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*
  • 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
  • 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*
Back to Top

Response

Supported Media Types

200 Response

A collection of Tender Media objects of the organization
Body ()
Root Schema : TenderMediaResponse
Type: object
Show Source

400 Response

400 Bad Request
Body ()
Root Schema : ErrorDetails
Type: object
Response body when the request returns an error.
Show Source
Back to Top