new SaleRequest()
- Source:
Extends
Methods
(static) SaleRequest#getAllowOfflinePayment() → {Boolean|Null}
Get the field value
If true then offline payments can be accepted
- Source:
Returns:
- Type
- Boolean | Null
(static) SaleRequest#getApproveOfflinePaymentWithoutPrompt() → {Boolean|Null}
Get the field value
If true then offline payments will be approved without a prompt
- Source:
Returns:
- Type
- Boolean | Null
(static) SaleRequest#getDisableCashback() → {Boolean|Null}
Get the field value
Do not allow cash back
- Source:
Returns:
- Type
- Boolean | Null
(static) SaleRequest#getDisableTipOnScreen() → {Boolean|Null}
Get the field value
If true, the tip screen will not be displayed on the device, even if the merchant is configured for tips on screen
- Source:
Returns:
- Type
- Boolean | Null
(static) SaleRequest#getTaxAmount() → {Number|Null}
Get the field value
Amount paid in tips
- Source:
Returns:
must be a long integer,
- Type
- Number | Null
(static) SaleRequest#getTipAmount() → {Number|Null}
Get the field value
Included tip
- Source:
Returns:
must be a long integer,
- Type
- Number | Null
(static) SaleRequest#getTipMode() → {payments.TipMode}
Get the field value
- Source:
Returns:
- Type
- payments.TipMode
(static) SaleRequest#getTippableAmount() → {Number|Null}
Get the field value
Total amount used when calculating tips
- Source:
Returns:
must be a long integer,
- Type
- Number | Null
(static) SaleRequest#setAllowOfflinePayment(allowOfflinePayment)
Set the field value
If true then offline payments can be accepted
Parameters:
Name | Type | Description |
---|---|---|
allowOfflinePayment |
Boolean | Null |
- Source:
(static) SaleRequest#setApproveOfflinePaymentWithoutPrompt(approveOfflinePaymentWithoutPrompt)
Set the field value
If true then offline payments will be approved without a prompt
Parameters:
Name | Type | Description |
---|---|---|
approveOfflinePaymentWithoutPrompt |
Boolean | Null |
- Source:
(static) SaleRequest#setDisableCashback(disableCashback)
Set the field value
Do not allow cash back
Parameters:
Name | Type | Description |
---|---|---|
disableCashback |
Boolean | Null |
- Source:
(static) SaleRequest#setDisableTipOnScreen(disableTipOnScreen)
Set the field value
If true, the tip screen will not be displayed on the device, even if the merchant is configured for tips on screen
Parameters:
Name | Type | Description |
---|---|---|
disableTipOnScreen |
Boolean | Null |
- Source:
(static) SaleRequest#setTaxAmount(taxAmount)
Set the field value
Amount paid in tips
Parameters:
Name | Type | Description |
---|---|---|
taxAmount |
Number | Null | must be a long integer, |
- Source:
(static) SaleRequest#setTipAmount(tipAmount)
Set the field value
Included tip
Parameters:
Name | Type | Description |
---|---|---|
tipAmount |
Number | Null | must be a long integer, |
- Source:
(static) SaleRequest#setTipMode(tipMode)
Set the field value
Parameters:
Name | Type | Description |
---|---|---|
tipMode |
payments.TipMode |
- Source:
(static) SaleRequest#setTippableAmount(tippableAmount)
Set the field value
Total amount used when calculating tips
Parameters:
Name | Type | Description |
---|---|---|
tippableAmount |
Number | Null | must be a long integer, |
- Source: