com.stripe.param

Class ChargeCaptureParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.ChargeCaptureParams

public class ChargeCaptureParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChargeCaptureParams.Builder
static class	ChargeCaptureParams.TransferData

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method and Description
static ChargeCaptureParams.Builder	builder()
java.lang.Long	getAmount() The amount to capture, which must be less than or equal to the original amount.
java.lang.Long	getApplicationFee() An application fee to add on to this charge.
java.lang.Long	getApplicationFeeAmount() An application fee amount to add on to this charge, which must be less than or equal to the original amount.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.lang.String	getReceiptEmail() The email address to send this charge's receipt to.
java.lang.String	getStatementDescriptor() For card charges, use `statement_descriptor_suffix` instead.
java.lang.String	getStatementDescriptorSuffix() Provides information about the charge that customers see on their statements.
ChargeCaptureParams.TransferData	getTransferData() An optional dictionary including the account to automatically transfer to as part of a destination charge.
java.lang.String	getTransferGroup() A string that identifies this transaction as part of a group.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ChargeCaptureParams.Builder builder()

getAmount

public java.lang.Long getAmount()

The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded.

getApplicationFee

public java.lang.Long getApplicationFee()

An application fee to add on to this charge. Can only be used with Stripe Connect.

getApplicationFeeAmount

public java.lang.Long getApplicationFeeAmount()

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.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getReceiptEmail

public java.lang.String getReceiptEmail()

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.

getStatementDescriptor

public java.lang.String getStatementDescriptor()

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.

getStatementDescriptorSuffix

public java.lang.String getStatementDescriptorSuffix()

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.

getTransferData

public ChargeCaptureParams.TransferData getTransferData()

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.

getTransferGroup

public java.lang.String getTransferGroup()

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.