Get Tender Parameters
post
/config/sim/v2/setup/getTenderParameters
Gets Tender Parameters.
Request
Supported Media Types
- multipart/form-data
- application/json
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, cashTenderObjNum, guestPayOptions -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order. Tender Parameters support orderBy on hierUnitId.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Tender Parameters support searchCriteria on hierUnitId.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A collection of Tender Parameters.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Tender Parameters objects.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Tender Parameters objects.
Show Source
-
Array of:
object items
Model for Tender Parameters object.
Nested Schema : items
Type:
objectModel for Tender Parameters object.
Show Source
-
activateGiftCardServiceChargeObjNum:
integer
SPI Activate Gift Card non-revenue Service Charge object number.Example:
3 -
automaticServiceChargeObjNum:
integer
Non-open amount Service Charge object number for Automatic Service Charge.Example:
1 -
bankLoanTenderObjNum:
integer
Default Bank Loan Tender Media object number.Example:
4 -
cashbackServiceChargeObjNum:
integer
SPI Cashback non-revenue Service Charge object number.Example:
6 -
cashOutGiftCardTenderObjNum:
integer
SPI Cash Out Gift Card Pickup Tender Media object number.Example:
10 -
cashTenderObjNum:
integer
Default Cash Tender Media object number.Example:
1 -
ccSurchargeServiceChargeObjNum:
integer
SPI CC Surcharge Service Charge object number.Example:
9 -
coverChargeObjNum:
integer
Cover Charge Service Charge object number that adds to guest count.Example:
2 -
donationServiceChargeObjNum:
integer
SPI Donation non-revenue Service Charge object number.Example:
8 -
guestPayOptions:
string
A string value of 0s and 1s of length 8 representing the enablement or disablement of Guest Pay options.Example:
00000000 -
guestPayOptionsExt:
object guestPayOptionsExt
An object containing the descriptive Guest Pay options list associated with Tender Parameters.
-
guestPayPayments:
array guestPayPayments
Guest Pay payment rows. Required fields apply only when a guestPayPayments object is supplied.
-
hierUnitId:
integer
Unique hierarchy unit value for the target hierarchy node.Example:
2 -
issueGiftCardServiceChargeObjNum:
integer
SPI Issue Gift Card non-revenue Service Charge object number.Example:
4 -
kdsGuestCheckTenderObjNum:
integer
KDS Guest Check Service Total Tender Media object number.Example:
7 -
operaSelfPayTenderObjNum:
integer
OPERA Self Pay Payment Tender Media object number without linked interface.Example:
11 -
paymentAdjustmentServiceChargeObjNum:
integer
SPI Payment Adjustment non-revenue Service Charge object number.Example:
7 -
paymentCardTenderObjNum:
integer
SPI Payment Card Tender Media object number with charged tip service charge.Example:
8 -
redeemGiftCardTenderObjNum:
integer
SPI Redeem Gift Card Payment Tender Media object number.Example:
9 -
reloadGiftCardServiceChargeObjNum:
integer
SPI Reload Gift Card non-revenue Service Charge object number.Example:
5 -
reprintTenderObjNum:
integer
Default Reprint Check Tender Media object number.Example:
5 -
suspendOrderTenderObjNum:
integer
Suspend Order Service Total Tender Media object number with Suspend Order enabled.Example:
6
Nested Schema : guestPayOptionsExt
Type:
objectAn object containing the descriptive Guest Pay options list associated with Tender Parameters.
Show Source
-
disableEmailReceipt:
boolean
A Boolean flag indicating to disable email receipt. This corresponds to Guest Pay option bit 2.Example:
false -
exitGuestPayWithoutIdPrompt:
boolean
A Boolean flag indicating to exit Guest Pay without an ID prompt. This corresponds to Guest Pay option bit 1.Example:
false
Nested Schema : guestPayPayments
Type:
arrayGuest Pay payment rows. Required fields apply only when a guestPayPayments object is supplied.
Show Source
Example:
[
{
"objectNumber":1,
"paymentOptions":"00000000",
"paymentOptionsExt":{
"enabled":false
},
"paymentType":0,
"paymentCommand":null
},
{
"objectNumber":2,
"paymentOptions":"00000000",
"paymentOptionsExt":{
"enabled":false
},
"paymentType":0,
"paymentCommand":null
},
{
"objectNumber":3,
"paymentOptions":"00000000",
"paymentOptionsExt":{
"enabled":false
},
"paymentType":0,
"paymentCommand":null
},
{
"objectNumber":4,
"paymentOptions":"00000000",
"paymentOptionsExt":{
"enabled":false
},
"paymentType":0,
"paymentCommand":null
},
{
"objectNumber":5,
"paymentOptions":"00000000",
"paymentOptionsExt":{
"enabled":false
},
"paymentType":0,
"paymentCommand":null
}
]Nested Schema : items
Type:
Show Source
object-
objectNumber:
integer
Payment row object number. Expected values are 1-5.Example:
1 -
paymentCommand:
string
Payment command string. Format goes as follows: payment-category:payment-type function-name [argument], for example CreditDebit:Loadable CreditAuthAndPay or CreditDebit:Loadable CreditAuthAndPay 1234. For OPERA/PMS, use payment-category:payment-type Interface:interfaceId TenderMedia:tenderMediaObjNum, for example Other1:LoadablePms Interface:168 TenderMedia:2.Example:
CreditDebit:Loadable CreditAuthAndPay -
paymentOptions:
string
A string value of 0s and 1s of length 8 representing the enablement or disablement of the Guest Pay payment options.Example:
00000000 -
paymentOptionsExt:
object paymentOptionsExt
An object containing the descriptive Guest Pay payment options list associated with Tender Parameters.
-
paymentType:
integer
Payment type. Tender Parameters Guest Pay supports 1 for Credit Card.Example:
1
Nested Schema : paymentOptionsExt
Type:
objectAn object containing the descriptive Guest Pay payment options list associated with Tender Parameters.
Show Source
-
enabled:
boolean
A Boolean flag indicating the Guest Pay payment row is enabled. This corresponds to payment option bit 1.Example:
false