Package com.stripe.param
Class ChargeCaptureParams.Builder
java.lang.Object
com.stripe.param.ChargeCaptureParams.Builder
- Enclosing class:
- ChargeCaptureParams
public static class ChargeCaptureParams.Builder
extends java.lang.Object
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description ChargeCaptureParams.Builder
addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list.ChargeCaptureParams.Builder
addExpand(java.lang.String element)
Add an element to `expand` list.ChargeCaptureParams
build()
Finalize and obtain parameter instance from this builder.ChargeCaptureParams.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.ChargeCaptureParams.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.ChargeCaptureParams.Builder
setAmount(java.lang.Long amount)
The amount to capture, which must be less than or equal to the original amount.ChargeCaptureParams.Builder
setApplicationFee(java.lang.Long applicationFee)
An application fee to add on to this charge.ChargeCaptureParams.Builder
setApplicationFeeAmount(java.lang.Long applicationFeeAmount)
An application fee amount to add on to this charge, which must be less than or equal to the original amount.ChargeCaptureParams.Builder
setReceiptEmail(java.lang.String receiptEmail)
The email address to send this charge's receipt to.ChargeCaptureParams.Builder
setStatementDescriptor(java.lang.String statementDescriptor)
For card charges, use `statement_descriptor_suffix` instead.ChargeCaptureParams.Builder
setStatementDescriptorSuffix(java.lang.String statementDescriptorSuffix)
Provides information about the charge that customers see on their statements.ChargeCaptureParams.Builder
setTransferData(ChargeCaptureParams.TransferData transferData)
An optional dictionary including the account to automatically transfer to as part of a destination charge.ChargeCaptureParams.Builder
setTransferGroup(java.lang.String transferGroup)
A string that identifies this transaction as part of a group.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
setAmount
The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. -
setApplicationFee
An application fee to add on to this charge. Can only be used with Stripe Connect. -
setApplicationFeeAmount
An application fee amount to add on to this charge, which must be less than or equal to the original amount. Can only be used with Stripe Connect. -
addExpand
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. SeeChargeCaptureParams.expand
for the field documentation. -
addAllExpand
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. SeeChargeCaptureParams.expand
for the field documentation. -
putExtraParam
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. SeeChargeCaptureParams.extraParams
for the field documentation. -
putAllExtraParam
public ChargeCaptureParams.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. SeeChargeCaptureParams.extraParams
for the field documentation. -
setReceiptEmail
The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode. -
setStatementDescriptor
For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. -
setStatementDescriptorSuffix
public ChargeCaptureParams.Builder setStatementDescriptorSuffix(java.lang.String statementDescriptorSuffix)Provides information about the charge 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
An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. -
setTransferGroup
A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for details.
-