Package com.clover.sdk.v3.payments.api

Class PaymentRequestIntentBuilder

java.lang.Object

com.clover.sdk.v3.payments.api.BaseIntentBuilder

com.clover.sdk.v3.payments.api.PaymentRequestIntentBuilder

public class PaymentRequestIntentBuilder
extends BaseIntentBuilder

Use the PaymentRequestIntentBuilder class to initiate a payment request on a Clover device.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaymentRequestIntentBuilder.CardOptions	Card options that allow the Integrator to control the use of cards.
static class	PaymentRequestIntentBuilder.OfflineOptions	Offline options that allow the Integrator to control a transaction's offline state on a per-transaction level.
static class	PaymentRequestIntentBuilder.ReceiptOptions	Receipt options that allow the Integrator to control the receipt selection on a per-transaction level.
static class	PaymentRequestIntentBuilder.SignatureOptions	Signature options that allow the Integrator to control how the signature is collected on a per-transaction level.
static class	PaymentRequestIntentBuilder.TenderOptions	Tender options allow Integrators to control Cash and Custom Tenders on a per-transaction level.
static class	PaymentRequestIntentBuilder.TipOptions	Tip options that allow the Integrator to control tipping on a per-transaction level.
static class	PaymentRequestIntentBuilder.TokenizeOptions	Options to tokenize card during transaction

Field Summary

Fields inherited from class com.clover.sdk.v3.payments.api.BaseIntentBuilder

PAPI_SDK_NAME

Constructor Summary

Constructors

Constructor	Description
PaymentRequestIntentBuilder(String externalPaymentId, long amount)	Creates an instance of the PaymentRequestIntentBuilder class

Method Summary

Modifier and Type	Method	Description
Intent	build(Context context)	return a single-use Intent to be used by Integrator POS to initiate payment
PaymentRequestIntentBuilder	cardOptions(PaymentRequestIntentBuilder.CardOptions cardOptions)	Sets CardOptions on the PaymentRequestIntentBuilder object
PaymentRequestIntentBuilder	externalReferenceId(String externalReferenceId)	Sets the field 'externalReferenceId'
PaymentRequestIntentBuilder	offlineOptions(PaymentRequestIntentBuilder.OfflineOptions offlineOptions)	Sets OfflineOptions on the PaymentRequestIntentBuilder object
PaymentRequestIntentBuilder	orderId(String orderId)	Set the id of the order, to which the payment will be added
PaymentRequestIntentBuilder	receiptOptions(PaymentRequestIntentBuilder.ReceiptOptions receiptOptions)	Sets ReceiptOptions on the PaymentRequestIntentBuilder object
PaymentRequestIntentBuilder	taxAmount(Long taxAmount)	Sets the field 'taxAmount'.
PaymentRequestIntentBuilder	tenderOptions(PaymentRequestIntentBuilder.TenderOptions tenderOptions)	Sets TenderOptions on the PaymentRequestIntentBuilder object
PaymentRequestIntentBuilder	tipAndSignatureOptions(PaymentRequestIntentBuilder.TipOptions tipOptions, PaymentRequestIntentBuilder.SignatureOptions signatureOptions, Boolean preferOnScreen)	Sets TipOptions, SignatureOptions and preferOnScreen on the PaymentRequestIntentBuilder object
PaymentRequestIntentBuilder	tokenizeOptions(PaymentRequestIntentBuilder.TokenizeOptions tokenizeOptions)	Set TokenizeOptions for this single transaction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PaymentRequestIntentBuilder

public PaymentRequestIntentBuilder(String externalPaymentId,
                                   long amount)

Creates an instance of the PaymentRequestIntentBuilder class

Parameters:

externalPaymentId -

amount -

Method Detail

tipAndSignatureOptions

public PaymentRequestIntentBuilder tipAndSignatureOptions(PaymentRequestIntentBuilder.TipOptions tipOptions,
                                                          PaymentRequestIntentBuilder.SignatureOptions signatureOptions,
                                                          Boolean preferOnScreen)

Sets TipOptions, SignatureOptions and preferOnScreen on the PaymentRequestIntentBuilder object

Parameters:

tipOptions -

signatureOptions -

preferOnScreen - - applies to both tip and signature as preferred location

Returns:

PaymentRequestIntentBuilder object with new TipOptions, SignatureOptions and preferOnScreen

cardOptions

public PaymentRequestIntentBuilder cardOptions(PaymentRequestIntentBuilder.CardOptions cardOptions)

Sets CardOptions on the PaymentRequestIntentBuilder object

Parameters:

cardOptions -

Returns:

PaymentRequestIntentBuilder object with new CardOptions

tenderOptions

public PaymentRequestIntentBuilder tenderOptions(PaymentRequestIntentBuilder.TenderOptions tenderOptions)

Sets TenderOptions on the PaymentRequestIntentBuilder object

Parameters:

tenderOptions - - @see TenderOptions

Returns:

PaymentRequestIntentBuilder object with new TenderOptions

receiptOptions

public PaymentRequestIntentBuilder receiptOptions(PaymentRequestIntentBuilder.ReceiptOptions receiptOptions)

Sets ReceiptOptions on the PaymentRequestIntentBuilder object

Parameters:

receiptOptions -

Returns:

PaymentRequestIntentBuilder object with new ReceiptOptions

offlineOptions

public PaymentRequestIntentBuilder offlineOptions(PaymentRequestIntentBuilder.OfflineOptions offlineOptions)

Sets OfflineOptions on the PaymentRequestIntentBuilder object

Parameters:

offlineOptions -

Returns:

PaymentRequestIntentBuilder object with new OfflineOptions

tokenizeOptions

public PaymentRequestIntentBuilder tokenizeOptions(PaymentRequestIntentBuilder.TokenizeOptions tokenizeOptions)

Set TokenizeOptions for this single transaction

Parameters:

tokenizeOptions - - @see TokenizeOptions

Returns:

externalReferenceId

public PaymentRequestIntentBuilder externalReferenceId(String externalReferenceId)

Sets the field 'externalReferenceId'

Parameters:

externalReferenceId -

Returns:

PaymentRequestIntentBuilder object with new externalReferenceId

taxAmount

public PaymentRequestIntentBuilder taxAmount(Long taxAmount)

Sets the field 'taxAmount'. NOTE: This will not affect the total amount.

Parameters:

taxAmount -

Returns:

PaymentRequestIntentBuilder object with new taxAmount

orderId

public PaymentRequestIntentBuilder orderId(String orderId)

Set the id of the order, to which the payment will be added

Parameters:

orderId - - id of an existing order

Returns:

PaymentRequestIntentBuilder object with new orderId

build

public Intent build(Context context)
             throws IllegalArgumentException

return a single-use Intent to be used by Integrator POS to initiate payment

Overrides:

build in class BaseIntentBuilder

Parameters:

context -

Returns:

Intent to be used to initiate a payment.

Throws:

IllegalArgumentException