com.stripe.param

Class PaymentIntentCaptureParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.PaymentIntentCaptureParams

public class PaymentIntentCaptureParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaymentIntentCaptureParams.Builder
static class	PaymentIntentCaptureParams.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 PaymentIntentCaptureParams.Builder	builder()
java.lang.Long	getAmountToCapture() The amount to capture from the PaymentIntent, which must be less than or equal to the original amount.
java.lang.Long	getApplicationFeeAmount() The amount of the application fee (if any) that will be applied to the payment and transferred to the application owner's Stripe account.
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	getStatementDescriptor() For non-card charges, you can use this value as the complete description that appears on your customers’ statements.
java.lang.String	getStatementDescriptorSuffix() Provides information about a card payment that customers see on their statements.
PaymentIntentCaptureParams.TransferData	getTransferData() The parameters used to automatically create a Transfer when the payment is captured.

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 PaymentIntentCaptureParams.Builder builder()

getAmountToCapture

public java.lang.Long getAmountToCapture()

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 full `amount_capturable` if not provided.

getApplicationFeeAmount

public java.lang.Long getApplicationFeeAmount()

The amount of the application fee (if any) that will be applied to the payment and transferred to the application owner's Stripe account. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).

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.

getStatementDescriptor

public java.lang.String getStatementDescriptor()

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.

getStatementDescriptorSuffix

public java.lang.String getStatementDescriptorSuffix()

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.

getTransferData

public PaymentIntentCaptureParams.TransferData getTransferData()

The parameters used to automatically create a Transfer when the payment is captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).