Class PaymentIntentRequest
java.lang.Object
com.broadleafcommerce.vendor.stripe.service.paymentintent.PaymentIntentRequest
- All Implemented Interfaces:
Serializable
The request to create
PaymentIntent.- Author:
- Divyank Chavan.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanbooleanAny extra properties needed to define thePaymentIntent.The application id associated with the current request.The customer context id associated with the current request.The BLC customer email.The BLC customer full name.The BLC customer id.Transaction descriptor that appears on the customer's statement (non-card payments only).javax.money.MonetaryAmountThe total amount to be used for thePaymentIntentWhen a PaymentIntent's payment method is stored for future use, this value declares if we intend to use the payment method on-session (i.e.The tenant id associated with the current request.inthashCode()booleanFlag for controling wheather to attach stripe customer to payment intent object..voidsetAdditionalAttributes(Map<String, Object> additionalAttributes) Any extra properties needed to define thePaymentIntent.voidsetApplicationId(String applicationId) The application id associated with the current request.voidsetCustomerContextId(String customerContextId) The customer context id associated with the current request.voidsetCustomerEmail(String customerEmail) The BLC customer email.voidsetCustomerFullName(String customerFullName) The BLC customer full name.voidsetCustomerId(String customerId) The BLC customer id.voidsetDynamicStatementDescriptor(String dynamicStatementDescriptor) Transaction descriptor that appears on the customer's statement (non-card payments only).voidsetPaymentTotal(javax.money.MonetaryAmount paymentTotal) The total amount to be used for thePaymentIntentvoidsetSavedPaymentUsage(String savedPaymentUsage) When a PaymentIntent's payment method is stored for future use, this value declares if we intend to use the payment method on-session (i.e.voidsetSaveForFutureUse(boolean saveForFutureUse) Flag for controling wheather to attach stripe customer to payment intent object..voidsetTenantId(String tenantId) The tenant id associated with the current request.toString()
-
Constructor Details
-
PaymentIntentRequest
public PaymentIntentRequest()
-
-
Method Details
-
getPaymentTotal
public javax.money.MonetaryAmount getPaymentTotal()The total amount to be used for thePaymentIntent- Returns:
- cartTotal
-
getCustomerId
The BLC customer id.- Returns:
- the BLC customer id
-
getCustomerFullName
The BLC customer full name.- Returns:
- the BLC customer full name
-
getCustomerEmail
The BLC customer email.- Returns:
- the BLC customer email
-
isSaveForFutureUse
public boolean isSaveForFutureUse()Flag for controling wheather to attach stripe customer to payment intent object..- Returns:
- the saveForFutureUse
-
getSavedPaymentUsage
When a PaymentIntent's payment method is stored for future use, this value declares if we intend to use the payment method on-session (i.e. as part of a customer interaction) or off-session (i.e. as part of a business-driven interaction).- Returns:
- If we intend to use the payment method on-session or off-session.
- See Also:
-
SetupIntentCreateParams.Usage
-
getDynamicStatementDescriptor
Transaction descriptor that appears on the customer's statement (non-card payments only). Must contain at least one letter, maximum 22 characters. -
getTenantId
The tenant id associated with the current request.- Returns:
- the tenant id
-
getApplicationId
The application id associated with the current request.- Returns:
- the application id
-
getCustomerContextId
The customer context id associated with the current request.- Returns:
- the customer context id
-
getAdditionalAttributes
Any extra properties needed to define thePaymentIntent.- Returns:
- any extra properties needed to define the
PaymentIntent
-
setPaymentTotal
public void setPaymentTotal(javax.money.MonetaryAmount paymentTotal) The total amount to be used for thePaymentIntent- Parameters:
paymentTotal- The total amount to be used for thePaymentIntent
-
setCustomerId
The BLC customer id.- Parameters:
customerId- the BLC customer id
-
setCustomerFullName
The BLC customer full name.- Parameters:
customerFullName- the BLC customer full name
-
setCustomerEmail
The BLC customer email.- Parameters:
customerEmail- the BLC customer email
-
setSaveForFutureUse
public void setSaveForFutureUse(boolean saveForFutureUse) Flag for controling wheather to attach stripe customer to payment intent object..- Parameters:
saveForFutureUse-
-
setSavedPaymentUsage
When a PaymentIntent's payment method is stored for future use, this value declares if we intend to use the payment method on-session (i.e. as part of a customer interaction) or off-session (i.e. as part of a business-driven interaction).- Parameters:
usage- Declares if we intend to use the payment method on-session or off-session.- See Also:
-
SetupIntentCreateParams.Usage
-
setDynamicStatementDescriptor
Transaction descriptor that appears on the customer's statement (non-card payments only). Must contain at least one letter, maximum 22 characters. -
setTenantId
The tenant id associated with the current request.- Parameters:
tenantId- the tenant id
-
setApplicationId
The application id associated with the current request.- Parameters:
applicationId- the application id
-
setCustomerContextId
The customer context id associated with the current request.- Parameters:
customerContextId- the customer context id
-
setAdditionalAttributes
Any extra properties needed to define thePaymentIntent.- Parameters:
additionalAttributes- any extra properties needed to define thePaymentIntent
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-