JSDoc: Class: PayIntent

new PayIntent()

Source:

remotemessage/PayIntent.js, line 20

Methods

(static) PayIntent#getAction() → {String}

Get the field value The action to fire in the device (com.clover.remote.protocol.action.START_REMOTE_PROTOCOL_PAY)

Source:

remotemessage/PayIntent.js, line 77

Returns:

Type: String

(static) PayIntent#getAllowOfflinePayment() → {Boolean|Null}

Get the field value

Source:

remotemessage/PayIntent.js, line 557

Returns:

Type: Boolean | Null

(static) PayIntent#getAllowPartialAuth() → {Boolean|Null}

Get the field value

Source:

remotemessage/PayIntent.js, line 629

Returns:

Type: Boolean | Null

(static) PayIntent#getAmount() → {Number|Null}

Get the field value Amount for transaction

Source:

remotemessage/PayIntent.js, line 98

Returns:

must be a long integer,

Type: Number | Null

(static) PayIntent#getApplicationTracking() → {apps.AppTracking}

Get the field value

Source:

remotemessage/PayIntent.js, line 611

Returns:

Type: apps.AppTracking

(static) PayIntent#getApproveOfflinePaymentWithoutPrompt() → {Boolean|Null}

Get the field value

Source:

remotemessage/PayIntent.js, line 575

Returns:

Type: Boolean | Null

(static) PayIntent#getCardDataMessage() → {String}

Get the field value

Source:

remotemessage/PayIntent.js, line 425

Returns:

Type: String

(static) PayIntent#getCardEntryMethods() → {Number}

Get the field value Allowed entry methods

Source:

remotemessage/PayIntent.js, line 335

Returns:

must be an integer

Type: Number

(static) PayIntent#getCashAdvanceCustomerIdentification() → {payments.CashAdvanceCustomerIdentification}

Get the field value

Source:

remotemessage/PayIntent.js, line 665

Returns:

Type: payments.CashAdvanceCustomerIdentification

(static) PayIntent#getDisableRestartTransactionWhenFailed() → {Boolean}

Get the field value

Source:

remotemessage/PayIntent.js, line 500

Returns:

Type: Boolean

(static) PayIntent#getEmployeeId() → {String}

Get the field value Unique identifier for a employee

Source:

remotemessage/PayIntent.js, line 221

Returns:

Type: String

(static) PayIntent#getExternalPaymentId() → {String}

Get the field value An id that allows an external system to link to a payment.

Source:

remotemessage/PayIntent.js, line 521

Returns:

Type: String

(static) PayIntent#getExternalReferenceId() → {String}

Get the field value An id that can be passed to the merchant's gateway, and ultimately appear in settlement records.

Source:

remotemessage/PayIntent.js, line 704

Returns:

Type: String

(static) PayIntent#getGermanInfo() → {payments.GermanInfo}

Get the field value

Source:

remotemessage/PayIntent.js, line 647

Returns:

Type: payments.GermanInfo

(static) PayIntent#getIsCardNotPresent() → {Boolean}

Get the field value

Source:

remotemessage/PayIntent.js, line 407

Returns:

Type: Boolean

(static) PayIntent#getIsDisableCashBack() → {Boolean}

Get the field value If true, then cash back will not be offered.

Source:

remotemessage/PayIntent.js, line 296

Returns:

Type: Boolean

(static) PayIntent#getIsForceSwipePinEntry() → {Boolean}

Get the field value

Source:

remotemessage/PayIntent.js, line 482

Returns:

Type: Boolean

(static) PayIntent#getIsTesting() → {Boolean}

Get the field value

Source:

remotemessage/PayIntent.js, line 314

Returns:

Type: Boolean

(static) PayIntent#getOrderId() → {String}

Get the field value Unique identifier for a order

Source:

remotemessage/PayIntent.js, line 179

Returns:

Type: String

(static) PayIntent#getPassThroughValues() → {Object.<String, String>}

Get the field value A map of values passed through to the server that are NOT used in payment processing or persisted.

Source:

remotemessage/PayIntent.js, line 725

Returns:

A map of to <>

Type: Object.<String, String>

(static) PayIntent#getPaymentId() → {String}

Get the field value Unique identifier for a payment

Source:

remotemessage/PayIntent.js, line 200

Returns:

Type: String

(static) PayIntent#getPostalCode() → {String}

Get the field value

Source:

remotemessage/PayIntent.js, line 389

Returns:

Type: String

(static) PayIntent#getRemotePrint() → {Boolean}

Get the field value If true, then the receiver of this message does NOT print

Source:

remotemessage/PayIntent.js, line 446

Returns:

Type: Boolean

(static) PayIntent#getRequiresRemoteConfirmation() → {Boolean|Null}

Get the field value

Source:

remotemessage/PayIntent.js, line 593

Returns:

Type: Boolean | Null

(static) PayIntent#getServiceChargeAmount() → {payments.ServiceChargeAmount}

Get the field value

Source:

remotemessage/PayIntent.js, line 275

Returns:

Type: payments.ServiceChargeAmount

(static) PayIntent#getStreetAddress() → {String}

Get the field value

Source:

remotemessage/PayIntent.js, line 371

Returns:

Type: String

(static) PayIntent#getTaxableAmountRates() → {Array.<payments.TaxableAmountRate>}

Get the field value

Source:

remotemessage/PayIntent.js, line 257

Returns:

An array of

Type: Array.<payments.TaxableAmountRate>

(static) PayIntent#getTaxAmount() → {Number|Null}

Get the field value

Source:

remotemessage/PayIntent.js, line 158

Returns:

must be a long integer,

Type: Number | Null

(static) PayIntent#getTipAmount() → {Number|Null}

Get the field value Amount paid in tips

Source:

remotemessage/PayIntent.js, line 140

Returns:

must be a long integer,

Type: Number | Null

(static) PayIntent#getTippableAmount() → {Number|Null}

Get the field value Amount used when calculating on screen tips

Source:

remotemessage/PayIntent.js, line 119

Returns:

must be a long integer,

Type: Number | Null

(static) PayIntent#getTransactionNo() → {String}

Get the field value

Source:

remotemessage/PayIntent.js, line 464

Returns:

Type: String

(static) PayIntent#getTransactionSettings() → {payments.TransactionSettings}

Get the field value

Source:

remotemessage/PayIntent.js, line 683

Returns:

Type: payments.TransactionSettings

(static) PayIntent#getTransactionType() → {remotemessage.TransactionType}

Get the field value

Source:

remotemessage/PayIntent.js, line 239

Returns:

Type: remotemessage.TransactionType

(static) PayIntent#getVaultedCard() → {payments.VaultedCard}

Get the field value

Source:

remotemessage/PayIntent.js, line 539

Returns:

Type: payments.VaultedCard

(static) PayIntent#getVoiceAuthCode() → {String}

Get the field value

Source:

remotemessage/PayIntent.js, line 353

Returns:

Type: String

(static) PayIntent#setAction(action)

Set the field value The action to fire in the device (com.clover.remote.protocol.action.START_REMOTE_PROTOCOL_PAY)

Parameters:

Name	Type	Description
`action`	String

Source:

remotemessage/PayIntent.js, line 67

(static) PayIntent#setAllowOfflinePayment(allowOfflinePayment)

Set the field value

Parameters:

Name	Type	Description
`allowOfflinePayment`	Boolean \| Null

Source:

remotemessage/PayIntent.js, line 548

(static) PayIntent#setAllowPartialAuth(allowPartialAuth)

Set the field value

Parameters:

Name	Type	Description
`allowPartialAuth`	Boolean \| Null

Source:

remotemessage/PayIntent.js, line 620

(static) PayIntent#setAmount(amount)

Set the field value Amount for transaction

Parameters:

Name	Type	Description
`amount`	Number \| Null	must be a long integer,

Source:

remotemessage/PayIntent.js, line 88

(static) PayIntent#setApplicationTracking(applicationTracking)

Set the field value

Parameters:

Name	Type	Description
`applicationTracking`	apps.AppTracking

Source:

remotemessage/PayIntent.js, line 602

(static) PayIntent#setApproveOfflinePaymentWithoutPrompt(approveOfflinePaymentWithoutPrompt)

Set the field value

Parameters:

Name	Type	Description
`approveOfflinePaymentWithoutPrompt`	Boolean \| Null

Source:

remotemessage/PayIntent.js, line 566

(static) PayIntent#setCardDataMessage(cardDataMessage)

Set the field value

Parameters:

Name	Type	Description
`cardDataMessage`	String

Source:

remotemessage/PayIntent.js, line 416

(static) PayIntent#setCardEntryMethods(cardEntryMethods)

Set the field value Allowed entry methods

Parameters:

Name	Type	Description
`cardEntryMethods`	Number	must be an integer

Source:

remotemessage/PayIntent.js, line 325

(static) PayIntent#setCashAdvanceCustomerIdentification(cashAdvanceCustomerIdentification)

Set the field value

Parameters:

Name	Type	Description
`cashAdvanceCustomerIdentification`	payments.CashAdvanceCustomerIdentification

Source:

remotemessage/PayIntent.js, line 656

(static) PayIntent#setDisableRestartTransactionWhenFailed(disableRestartTransactionWhenFailed)

Set the field value

Parameters:

Name	Type	Description
`disableRestartTransactionWhenFailed`	Boolean

Source:

remotemessage/PayIntent.js, line 491

(static) PayIntent#setEmployeeId(employeeId)

Set the field value Unique identifier for a employee

Parameters:

Name	Type	Description
`employeeId`	String

Source:

remotemessage/PayIntent.js, line 211

(static) PayIntent#setExternalPaymentId(externalPaymentId)

Set the field value An id that allows an external system to link to a payment.

Parameters:

Name	Type	Description
`externalPaymentId`	String

Source:

remotemessage/PayIntent.js, line 511

(static) PayIntent#setExternalReferenceId(externalReferenceId)

Set the field value An id that can be passed to the merchant's gateway, and ultimately appear in settlement records.

Parameters:

Name	Type	Description
`externalReferenceId`	String

Source:

remotemessage/PayIntent.js, line 694

(static) PayIntent#setGermanInfo(germanInfo)

Set the field value

Parameters:

Name	Type	Description
`germanInfo`	payments.GermanInfo

Source:

remotemessage/PayIntent.js, line 638

(static) PayIntent#setIsCardNotPresent(isCardNotPresent)

Set the field value

Parameters:

Name	Type	Description
`isCardNotPresent`	Boolean

Source:

remotemessage/PayIntent.js, line 398

(static) PayIntent#setIsDisableCashBack(isDisableCashBack)

Set the field value If true, then cash back will not be offered.

Parameters:

Name	Type	Description
`isDisableCashBack`	Boolean

Source:

remotemessage/PayIntent.js, line 286

(static) PayIntent#setIsForceSwipePinEntry(isForceSwipePinEntry)

Set the field value

Parameters:

Name	Type	Description
`isForceSwipePinEntry`	Boolean

Source:

remotemessage/PayIntent.js, line 473

(static) PayIntent#setIsTesting(isTesting)

Set the field value

Parameters:

Name	Type	Description
`isTesting`	Boolean

Source:

remotemessage/PayIntent.js, line 305

(static) PayIntent#setOrderId(orderId)

Set the field value Unique identifier for a order

Parameters:

Name	Type	Description
`orderId`	String

Source:

remotemessage/PayIntent.js, line 169

(static) PayIntent#setPassThroughValues(passThroughValues)

Set the field value A map of values passed through to the server that are NOT used in payment processing or persisted.

Parameters:

Name	Type	Description
`passThroughValues`	Object.<String, String>	A map of to <>

Source:

remotemessage/PayIntent.js, line 715

(static) PayIntent#setPaymentId(paymentId)

Set the field value Unique identifier for a payment

Parameters:

Name	Type	Description
`paymentId`	String

Source:

remotemessage/PayIntent.js, line 190

(static) PayIntent#setPostalCode(postalCode)

Set the field value

Parameters:

Name	Type	Description
`postalCode`	String

Source:

remotemessage/PayIntent.js, line 380

(static) PayIntent#setRemotePrint(remotePrint)

Set the field value If true, then the receiver of this message does NOT print

Parameters:

Name	Type	Description
`remotePrint`	Boolean

Source:

remotemessage/PayIntent.js, line 436

(static) PayIntent#setRequiresRemoteConfirmation(requiresRemoteConfirmation)

Set the field value

Parameters:

Name	Type	Description
`requiresRemoteConfirmation`	Boolean \| Null

Source:

remotemessage/PayIntent.js, line 584

(static) PayIntent#setServiceChargeAmount(serviceChargeAmount)

Set the field value

Parameters:

Name	Type	Description
`serviceChargeAmount`	payments.ServiceChargeAmount

Source:

remotemessage/PayIntent.js, line 266

(static) PayIntent#setStreetAddress(streetAddress)

Set the field value

Parameters:

Name	Type	Description
`streetAddress`	String

Source:

remotemessage/PayIntent.js, line 362

(static) PayIntent#setTaxableAmountRates(taxableAmountRates)

Set the field value

Parameters:

Name	Type	Description
`taxableAmountRates`	Array.<payments.TaxableAmountRate>	An array of

Source:

remotemessage/PayIntent.js, line 248

(static) PayIntent#setTaxAmount(taxAmount)

Set the field value

Parameters:

Name	Type	Description
`taxAmount`	Number \| Null	must be a long integer,

Source:

remotemessage/PayIntent.js, line 149

(static) PayIntent#setTipAmount(tipAmount)

Set the field value Amount paid in tips

Parameters:

Name	Type	Description
`tipAmount`	Number \| Null	must be a long integer,

Source:

remotemessage/PayIntent.js, line 130

(static) PayIntent#setTippableAmount(tippableAmount)

Set the field value Amount used when calculating on screen tips

Parameters:

Name	Type	Description
`tippableAmount`	Number \| Null	must be a long integer,

Source:

remotemessage/PayIntent.js, line 109

(static) PayIntent#setTransactionNo(transactionNo)

Set the field value

Parameters:

Name	Type	Description
`transactionNo`	String

Source:

remotemessage/PayIntent.js, line 455

(static) PayIntent#setTransactionSettings(transactionSettings)

Set the field value

Parameters:

Name	Type	Description
`transactionSettings`	payments.TransactionSettings

Source:

remotemessage/PayIntent.js, line 674

(static) PayIntent#setTransactionType(transactionType)

Set the field value

Parameters:

Name	Type	Description
`transactionType`	remotemessage.TransactionType

Source:

remotemessage/PayIntent.js, line 230

(static) PayIntent#setVaultedCard(vaultedCard)

Set the field value

Parameters:

Name	Type	Description
`vaultedCard`	payments.VaultedCard

Source:

remotemessage/PayIntent.js, line 530

(static) PayIntent#setVoiceAuthCode(voiceAuthCode)

Set the field value

Parameters:

Name	Type	Description
`voiceAuthCode`	String

Source:

remotemessage/PayIntent.js, line 344