Builder | Clover SDK for Javascript Integration

Hierarchy

Builder

Index

Properties

Methods

Properties

Private action

action: string

Private allowOfflinePayment

allowOfflinePayment: boolean

deprecated: // Please use TransactionSettings

Private allowPartialAuth

allowPartialAuth: boolean = true

Private amount

amount: number

Private applicationTracking

applicationTracking: sdk.apps.AppTracking

Private approveOfflinePaymentWithoutPrompt

approveOfflinePaymentWithoutPrompt: boolean

deprecated: // Please use TransactionSettings

Private cardDataMessage

cardDataMessage: string

Private cardEntryMethods

cardEntryMethods: number

deprecated: // Please use TransactionSettings

Private cashAdvanceCustomerIdentification

cashAdvanceCustomerIdentification: sdk.payments.CashAdvanceCustomerIdentification

Private disableRestartTransactionWhenFailed

disableRestartTransactionWhenFailed: boolean = false

deprecated: // Please use TransactionSettings

Private employeeId

employeeId: string

Private externalPaymentId

externalPaymentId: string

Private germanInfo

germanInfo: sdk.payments.GermanInfo

Private isCardNotPresent

isCardNotPresent: boolean = false

Private isDisableCashBack

isDisableCashBack: boolean = false

deprecated: // Please use TransactionSettings

Private isForceSwipePinEntry

isForceSwipePinEntry: boolean = false

deprecated: // Please use TransactionSettings

Private isTesting

isTesting: boolean = false

Private orderId

orderId: string

Private paymentId

paymentId: string

Private postalCode

postalCode: string

Private remotePrint

remotePrint: boolean = false

deprecated: // Please use TransactionSettings

Private requiresRemoteConfirmation

requiresRemoteConfirmation: boolean

Private serviceChargeAmount

serviceChargeAmount: sdk.payments.ServiceChargeAmount

Private streetAddress

streetAddress: string

Private taxAmount

taxAmount: number

Private taxableAmountRates

taxableAmountRates: Array<sdk.payments.TaxableAmountRate>

Private tipAmount

tipAmount: number

Private tippableAmount

tippableAmount: number

deprecated: // Please use TransactionSettings

Private transactionNo

transactionNo: string

Private transactionSettings

transactionSettings: sdk.payments.TransactionSettings

Private transactionType

transactionType: sdk.remotemessage.TransactionType

Private vaultedCard

vaultedCard: sdk.payments.VaultedCard

Private voiceAuthCode

voiceAuthCode: string

Methods

build

build(): sdk.remotemessage.PayIntent

- Defined in util/PayIntent/Builder.ts:297
Returns sdk.remotemessage.PayIntent

payIntent

payIntent(payIntent: sdk.remotemessage.PayIntent): Builder

- Defined in util/PayIntent/Builder.ts:81
Parameters
- payIntent: sdk.remotemessage.PayIntent
Returns Builder

payment

payment(payment: sdk.payment.Payment): Builder

- Defined in util/PayIntent/Builder.ts:71
Parameters
- payment: sdk.payment.Payment
Returns Builder

setAapproveOfflinePaymentWithoutPrompt

setAapproveOfflinePaymentWithoutPrompt(approveOfflinePaymentWithoutPrompt: boolean): Builder

- Defined in util/PayIntent/Builder.ts:254
deprecated

Parameters
- approveOfflinePaymentWithoutPrompt: boolean
Returns Builder

setAction

setAction(action: string): Builder

- Defined in util/PayIntent/Builder.ts:123
Parameters
- action: string
Returns Builder

setAllowOfflinePayment

setAllowOfflinePayment(allowOfflinePayment: boolean): Builder

- Defined in util/PayIntent/Builder.ts:245
deprecated

Parameters
- allowOfflinePayment: boolean
Returns Builder

setAllowPartialAuth

setAllowPartialAuth(allowPartialAuth?: boolean): Builder

- Defined in util/PayIntent/Builder.ts:272
Parameters
- Default value allowPartialAuth: boolean = false
Returns Builder

setAmount

setAmount(amount: number): Builder

- Defined in util/PayIntent/Builder.ts:128
Parameters
- amount: number
Returns Builder

setApplicationTracking

setApplicationTracking(applicationTracking: sdk.apps.AppTracking): Builder

- Defined in util/PayIntent/Builder.ts:267
Parameters
- applicationTracking: sdk.apps.AppTracking
Returns Builder

setCardDataMessage

setCardDataMessage(cardDataMessage: string): Builder

- Defined in util/PayIntent/Builder.ts:168
Parameters
- cardDataMessage: string
Returns Builder

setCardEntryMethods

setCardEntryMethods(cardEntryMethods: number): Builder

- Defined in util/PayIntent/Builder.ts:163
deprecated

Parameters
- cardEntryMethods: number
Returns Builder

setCardNotPresent

setCardNotPresent(cardNotPresent?: boolean): Builder

- Defined in util/PayIntent/Builder.ts:292
Parameters
- Default value cardNotPresent: boolean = false
Returns Builder

setCustomerIdentification

setCustomerIdentification(customerIdentification: sdk.payments.CashAdvanceCustomerIdentification): Builder

- Defined in util/PayIntent/Builder.ts:282
Parameters
- customerIdentification: sdk.payments.CashAdvanceCustomerIdentification
Returns Builder

setDisableCashback

setDisableCashback(disableCashBack?: boolean): Builder

- Defined in util/PayIntent/Builder.ts:203
deprecated

Parameters
- Default value disableCashBack: boolean = false
Returns Builder

setDisableRestartTransactionWhenFailed

setDisableRestartTransactionWhenFailed(disableRestartTransactionWhenFailed?: boolean): Builder

- Defined in util/PayIntent/Builder.ts:226
deprecated

Parameters
- Default value disableRestartTransactionWhenFailed: boolean = false
Returns Builder

setEmployeeId

setEmployeeId(employeeId: string): Builder

- Defined in util/PayIntent/Builder.ts:147
Parameters
- employeeId: string
Returns Builder

setExternalPaymentId

setExternalPaymentId(externalPaymentId: string): Builder

- Defined in util/PayIntent/Builder.ts:234
Parameters
- externalPaymentId: string
Returns Builder

setForceSwipePinEntry

setForceSwipePinEntry(isForceSwipePinEntry?: boolean): Builder

- Defined in util/PayIntent/Builder.ts:217
deprecated

Parameters
- Default value isForceSwipePinEntry: boolean = false
Returns Builder

setGermanInfo

setGermanInfo(germanInfo: sdk.payments.GermanInfo): Builder

- Defined in util/PayIntent/Builder.ts:277
Parameters
- germanInfo: sdk.payments.GermanInfo
Returns Builder

setOrderId

setOrderId(orderId: string): Builder

- Defined in util/PayIntent/Builder.ts:183
Parameters
- orderId: string
Returns Builder

setPaymentId

setPaymentId(paymentId: string): Builder

- Defined in util/PayIntent/Builder.ts:188
Parameters
- paymentId: string
Returns Builder

setRemotePrint

setRemotePrint(remotePrint?: boolean): Builder

- Defined in util/PayIntent/Builder.ts:194
deprecated

Parameters
- Default value remotePrint: boolean = false
Returns Builder

setRequiresRemoteConfirmation

setRequiresRemoteConfirmation(requiresRemoteConfirmation: boolean): Builder

- Defined in util/PayIntent/Builder.ts:262
Parameters
- requiresRemoteConfirmation: boolean
Returns Builder

setServiceChargeAmount

setServiceChargeAmount(serviceChargeAmount: sdk.payments.ServiceChargeAmount): Builder

- Defined in util/PayIntent/Builder.ts:178
Parameters
- serviceChargeAmount: sdk.payments.ServiceChargeAmount
Returns Builder

setTaxAmount

setTaxAmount(taxAmount: number): Builder

- Defined in util/PayIntent/Builder.ts:142
Parameters
- taxAmount: number
Returns Builder

setTaxableAmountRates

setTaxableAmountRates(taxableAmountRates: Array<sdk.payments.TaxableAmountRate>): Builder

- Defined in util/PayIntent/Builder.ts:173
Parameters
- taxableAmountRates: Array<sdk.payments.TaxableAmountRate>
Returns Builder

setTipAmount

setTipAmount(tipAmount: number): Builder

- Defined in util/PayIntent/Builder.ts:152
Parameters
- tipAmount: number
Returns Builder

setTippableAmount

setTippableAmount(tippableAmount: number): Builder

- Defined in util/PayIntent/Builder.ts:134
deprecated

Parameters
- tippableAmount: number
Returns Builder

setTransactionNo

setTransactionNo(transactionNo: string): Builder

- Defined in util/PayIntent/Builder.ts:211
Parameters
- transactionNo: string
Returns Builder

setTransactionSettings

setTransactionSettings(transactionSettings: sdk.payments.TransactionSettings): Builder

- Defined in util/PayIntent/Builder.ts:287
Parameters
- transactionSettings: sdk.payments.TransactionSettings
Returns Builder

setTransactionType

setTransactionType(transactionType: sdk.remotemessage.TransactionType): Builder

- Defined in util/PayIntent/Builder.ts:157
Parameters
- transactionType: sdk.remotemessage.TransactionType
Returns Builder

setVaultedCard

setVaultedCard(vaultedCard: sdk.payments.VaultedCard): Builder

- Defined in util/PayIntent/Builder.ts:239
Parameters
- vaultedCard: sdk.payments.VaultedCard
Returns Builder

Static buildTransactionSettingsFromPayIntent

buildTransactionSettingsFromPayIntent(payIntent: sdk.remotemessage.PayIntent): sdk.payments.TransactionSettings

- Defined in util/PayIntent/Builder.ts:52
Parameters
- payIntent: sdk.remotemessage.PayIntent
Returns sdk.payments.TransactionSettings

Hierarchy

Index

Properties

Methods

Properties

Private action

Private allowOfflinePayment

Private allowPartialAuth

Private amount

Private applicationTracking

Private approveOfflinePaymentWithoutPrompt

Private cardDataMessage

Private cardEntryMethods

Private cashAdvanceCustomerIdentification

Private disableRestartTransactionWhenFailed

Private employeeId

Private externalPaymentId

Private germanInfo

Private isCardNotPresent

Private isDisableCashBack

Private isForceSwipePinEntry

Private isTesting

Private orderId

Private paymentId

Private postalCode

Private remotePrint

Private requiresRemoteConfirmation

Private serviceChargeAmount

Private streetAddress

Private taxAmount

Private taxableAmountRates

Private tipAmount

Private tippableAmount

Private transactionNo

Private transactionSettings

Private transactionType

Private vaultedCard

Private voiceAuthCode

Methods

build

Returns sdk.remotemessage.PayIntent

payIntent

Parameters

payIntent: sdk.remotemessage.PayIntent

Returns Builder

payment

Parameters

payment: sdk.payment.Payment

Returns Builder

setAapproveOfflinePaymentWithoutPrompt

Parameters

approveOfflinePaymentWithoutPrompt: boolean

Returns Builder

setAction

Parameters

action: string

Returns Builder

setAllowOfflinePayment

Parameters

allowOfflinePayment: boolean

Returns Builder

setAllowPartialAuth

Parameters

Default value allowPartialAuth: boolean = false

Returns Builder

setAmount

Parameters

amount: number

Returns Builder

setApplicationTracking

Parameters

applicationTracking: sdk.apps.AppTracking

Returns Builder

setCardDataMessage

Parameters

cardDataMessage: string

Returns Builder

setCardEntryMethods

Parameters

cardEntryMethods: number