Upsert Tender Parameters
post
/config/sim/v2/setup/upsertTenderParameters
Updates the Tender Parameters if they exist; otherwise, adds Tender Parameters.
Request
Supported Media Types
- multipart/form-data
- application/json
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Tender Parameters Request Body for Create, Update, and Upsert requests.
Root Schema : schema
Type:
Show Source
object-
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 -
guestPayPayments:
array guestPayPayments
Guest Pay payment rows. Required fields apply only when a guestPayPayments object is supplied.
-
hierUnitId(required):
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 : guestPayPayments
Type:
arrayGuest Pay payment rows. Required fields apply only when a guestPayPayments object is supplied.
Show Source
Example:
[
{
"objectNumber":1,
"paymentOptions":"00000000",
"paymentType":0,
"paymentCommand":null
},
{
"objectNumber":2,
"paymentOptions":"00000000",
"paymentType":0,
"paymentCommand":null
},
{
"objectNumber":3,
"paymentOptions":"00000000",
"paymentType":0,
"paymentCommand":null
},
{
"objectNumber":4,
"paymentOptions":"00000000",
"paymentType":0,
"paymentCommand":null
},
{
"objectNumber":5,
"paymentOptions":"00000000",
"paymentType":0,
"paymentCommand":null
}
]Nested Schema : items
Type:
Show Source
object-
objectNumber(required):
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 -
paymentType:
integer
Payment type. Tender Parameters Guest Pay supports 1 for Credit Card.Example:
1
Response
Supported Media Types
- application/json
200 Response
Tender Parameters Updated.
Root Schema : schema
Type:
Show Source
object-
hierUnitId:
integer
Unique hierarchy unit value for the updated hierarchy node.Example:
2
201 Response
Tender Parameters Added.
Root Schema : schema
Type:
Show Source
object-
hierUnitId:
integer
Unique hierarchy unit value for the inserted hierarchy node.Example:
2