Package com.clover.sdk.v3.payments.api
Class TipAdjustRequestIntentBuilder
- java.lang.Object
-
- com.clover.sdk.v3.payments.api.BaseIntentBuilder
-
- com.clover.sdk.v3.payments.api.TipAdjustRequestIntentBuilder
-
public class TipAdjustRequestIntentBuilder extends BaseIntentBuilder
Use the TipAdjustRequestIntentBuilder to build an intent for a merchant to add a tip to a payment. This is NOT to prompt the customer for a tip, rather it allows a merchant to apply a tip to an existing payment, for example, from a tip amount left on a receipt. If the tip amount is not provided (null) then a UI will be displayed allowing a merchant to enter a tip amount.
-
-
Field Summary
-
Fields inherited from class com.clover.sdk.v3.payments.api.BaseIntentBuilder
PAPI_SDK_NAME
-
-
Constructor Summary
Constructors Constructor Description TipAdjustRequestIntentBuilder(String paymentId)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TipAdjustRequestIntentBuilder
AdjustTip(String paymentId, Long tipAmount)
Use to create a Tip Adjust request to adjust a payment.Intent
build(Context context)
returns a single-use Intent that can be used to launch an Activity to process the requestTipAdjustRequestIntentBuilder
tipAmount(Long tipAmount)
The amount of the tip.
-
-
-
Constructor Detail
-
TipAdjustRequestIntentBuilder
@Deprecated public TipAdjustRequestIntentBuilder(String paymentId)
Deprecated.Create the build with a required paymentId of the payment to apply the tip- Parameters:
paymentId
-
-
-
Method Detail
-
tipAmount
public TipAdjustRequestIntentBuilder tipAmount(Long tipAmount)
The amount of the tip. If null, the Clover Tip app will open for the user to enter the tip for the payment- Parameters:
tipAmount
-- Returns:
-
AdjustTip
public static TipAdjustRequestIntentBuilder AdjustTip(String paymentId, @Nullable Long tipAmount)
Use to create a Tip Adjust request to adjust a payment.- Parameters:
paymentId
-tipAmount
- - this is optional. If included, it will be a headless tip adjust. If null, you will have the opportunity to enter a tip amount within the Tips app.- Returns:
-
build
public Intent build(Context context) throws IllegalArgumentException
Description copied from class:BaseIntentBuilder
returns a single-use Intent that can be used to launch an Activity to process the request- Overrides:
build
in classBaseIntentBuilder
- Returns:
- Throws:
IllegalArgumentException
-
-