Package com.stripe.param
Class PaymentIntentCaptureParams.Builder
- java.lang.Object
-
- com.stripe.param.PaymentIntentCaptureParams.Builder
-
- Enclosing class:
- PaymentIntentCaptureParams
public static class PaymentIntentCaptureParams.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PaymentIntentCaptureParams.Builder
addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list.PaymentIntentCaptureParams.Builder
addExpand(java.lang.String element)
Add an element to `expand` list.PaymentIntentCaptureParams
build()
Finalize and obtain parameter instance from this builder.PaymentIntentCaptureParams.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.PaymentIntentCaptureParams.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.PaymentIntentCaptureParams.Builder
setAmountToCapture(java.lang.Long amountToCapture)
The amount to capture from the PaymentIntent, which must be less than or equal to the original amount.PaymentIntentCaptureParams.Builder
setApplicationFeeAmount(java.lang.Long applicationFeeAmount)
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.PaymentIntentCaptureParams.Builder
setStatementDescriptor(java.lang.String statementDescriptor)
For non-card charges, you can use this value as the complete description that appears on your customers’ statements.PaymentIntentCaptureParams.Builder
setStatementDescriptorSuffix(java.lang.String statementDescriptorSuffix)
Provides information about a card payment that customers see on their statements.PaymentIntentCaptureParams.Builder
setTransferData(PaymentIntentCaptureParams.TransferData transferData)
The parameters used to automatically create a Transfer when the payment is captured.
-
-
-
Method Detail
-
build
public PaymentIntentCaptureParams build()
Finalize and obtain parameter instance from this builder.
-
setAmountToCapture
public PaymentIntentCaptureParams.Builder setAmountToCapture(java.lang.Long amountToCapture)
The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. Defaults to the fullamount_capturable
if not provided.
-
setApplicationFeeAmount
public PaymentIntentCaptureParams.Builder setApplicationFeeAmount(java.lang.Long applicationFeeAmount)
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.
-
addExpand
public PaymentIntentCaptureParams.Builder addExpand(java.lang.String element)
Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeePaymentIntentCaptureParams.expand
for the field documentation.
-
addAllExpand
public PaymentIntentCaptureParams.Builder addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeePaymentIntentCaptureParams.expand
for the field documentation.
-
putExtraParam
public PaymentIntentCaptureParams.Builder putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeePaymentIntentCaptureParams.extraParams
for the field documentation.
-
putAllExtraParam
public PaymentIntentCaptureParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeePaymentIntentCaptureParams.extraParams
for the field documentation.
-
setStatementDescriptor
public PaymentIntentCaptureParams.Builder setStatementDescriptor(java.lang.String statementDescriptor)
For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
-
setStatementDescriptorSuffix
public PaymentIntentCaptureParams.Builder setStatementDescriptorSuffix(java.lang.String statementDescriptorSuffix)
Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
-
setTransferData
public PaymentIntentCaptureParams.Builder setTransferData(PaymentIntentCaptureParams.TransferData transferData)
The parameters used to automatically create a Transfer when the payment is captured. For more information, see the PaymentIntents use case for connected accounts.
-
-