Get Tender Parameters

post

/config/sim/v2/setup/getTenderParameters

Gets Tender Parameters.

Request

Supported Media Types
Body ()
The input Body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • If specified, limits the data returned to these fields.
    Example: hierUnitId, cashTenderObjNum, guestPayOptions
  • 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
  • If specified, limits translated strings returned
    Example: 1,2,3
  • If using paging, number of results returned in this page.
    Example: 100
  • Starting resource record index. Not required if paging parameters are not supported
    Example: 0
  • Sorts the response by the specified field name and sort order. Tender Parameters support orderBy on hierUnitId.
    Example: hierUnitId:asc
  • If specified, returns records that match the criteria. Tender Parameters support searchCriteria on hierUnitId.
    Example: where equals(hierUnitId, 7)
Back to Top

Response

Supported Media Types

200 Response

A collection of Tender Parameters.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of Tender Parameters objects.
Show Source
Nested Schema : items
Type: object
Model for Tender Parameters object.
Show Source
Nested Schema : guestPayOptionsExt
Type: object
An object containing the descriptive Guest Pay options list associated with Tender Parameters.
Show Source
Nested Schema : guestPayPayments
Type: array
Guest 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: object
Show Source
  • Payment row object number. Expected values are 1-5.
    Example: 1
  • 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
  • A string value of 0s and 1s of length 8 representing the enablement or disablement of the Guest Pay payment options.
    Example: 00000000
  • paymentOptionsExt
    An object containing the descriptive Guest Pay payment options list associated with Tender Parameters.
  • Payment type. Tender Parameters Guest Pay supports 1 for Credit Card.
    Example: 1
Nested Schema : paymentOptionsExt
Type: object
An object containing the descriptive Guest Pay payment options list associated with Tender Parameters.
Show Source
  • A Boolean flag indicating the Guest Pay payment row is enabled. This corresponds to payment option bit 1.
    Example: false
Back to Top