com.stripe.param.PaymentIntentCaptureParams Maven / Gradle / Ivy
// File generated from our OpenAPI spec
package com.stripe.param;
import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import com.stripe.param.common.EmptyParam;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.Getter;
@Getter
public class PaymentIntentCaptureParams extends ApiRequestParams {
/**
* The amount to capture from the PaymentIntent, which must be less than or equal to the original
* amount. Any additional amount is automatically refunded. Defaults to the full {@code
* amount_capturable} if it's not provided.
*/
@SerializedName("amount_to_capture")
Long amountToCapture;
/**
* 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.
*/
@SerializedName("application_fee_amount")
Long applicationFeeAmount;
/** Specifies which fields in the response should be expanded. */
@SerializedName("expand")
List expand;
/**
* 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 {@code @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.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/**
* Defaults to {@code true}. When capturing a PaymentIntent, setting {@code final_capture} to
* {@code false} notifies Stripe to not release the remaining uncaptured funds to make sure that
* they're captured in future requests. You can only use this setting when multicapture is available for
* PaymentIntents.
*/
@SerializedName("final_capture")
Boolean finalCapture;
/**
* Set of key-value pairs that you can attach
* to an object. This can be useful for storing additional information about the object in a
* structured format. Individual keys can be unset by posting an empty value to them. All keys can
* be unset by posting an empty value to {@code metadata}.
*/
@SerializedName("metadata")
Object metadata;
/**
* Text that appears on the customer's statement as the statement descriptor for a non-card
* charge. This value overrides the account's default statement descriptor. For information about
* requirements, including the 22-character limit, see the Statement
* Descriptor docs.
*
* Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix
* instead.
*/
@SerializedName("statement_descriptor")
String statementDescriptor;
/**
* Provides information about a card charge. Concatenated to the account's statement
* descriptor prefix to form the complete statement descriptor that appears on the customer's
* statement.
*/
@SerializedName("statement_descriptor_suffix")
String statementDescriptorSuffix;
/**
* The parameters that you can use to automatically create a transfer after the payment is
* captured. Learn more about the use case for connected accounts.
*/
@SerializedName("transfer_data")
TransferData transferData;
private PaymentIntentCaptureParams(
Long amountToCapture,
Long applicationFeeAmount,
List expand,
Map extraParams,
Boolean finalCapture,
Object metadata,
String statementDescriptor,
String statementDescriptorSuffix,
TransferData transferData) {
this.amountToCapture = amountToCapture;
this.applicationFeeAmount = applicationFeeAmount;
this.expand = expand;
this.extraParams = extraParams;
this.finalCapture = finalCapture;
this.metadata = metadata;
this.statementDescriptor = statementDescriptor;
this.statementDescriptorSuffix = statementDescriptorSuffix;
this.transferData = transferData;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amountToCapture;
private Long applicationFeeAmount;
private List expand;
private Map extraParams;
private Boolean finalCapture;
private Object metadata;
private String statementDescriptor;
private String statementDescriptorSuffix;
private TransferData transferData;
/** Finalize and obtain parameter instance from this builder. */
public PaymentIntentCaptureParams build() {
return new PaymentIntentCaptureParams(
this.amountToCapture,
this.applicationFeeAmount,
this.expand,
this.extraParams,
this.finalCapture,
this.metadata,
this.statementDescriptor,
this.statementDescriptorSuffix,
this.transferData);
}
/**
* The amount to capture from the PaymentIntent, which must be less than or equal to the
* original amount. Any additional amount is automatically refunded. Defaults to the full {@code
* amount_capturable} if it's not provided.
*/
public Builder setAmountToCapture(Long amountToCapture) {
this.amountToCapture = amountToCapture;
return this;
}
/**
* 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.
*/
public Builder setApplicationFeeAmount(Long applicationFeeAmount) {
this.applicationFeeAmount = applicationFeeAmount;
return this;
}
/**
* 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. See {@link
* PaymentIntentCaptureParams#expand} for the field documentation.
*/
public Builder addExpand(String element) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.add(element);
return this;
}
/**
* 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. See {@link
* PaymentIntentCaptureParams#expand} for the field documentation.
*/
public Builder addAllExpand(List elements) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.addAll(elements);
return this;
}
/**
* 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. See {@link
* PaymentIntentCaptureParams#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* 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.
* See {@link PaymentIntentCaptureParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Defaults to {@code true}. When capturing a PaymentIntent, setting {@code final_capture} to
* {@code false} notifies Stripe to not release the remaining uncaptured funds to make sure that
* they're captured in future requests. You can only use this setting when multicapture is available for
* PaymentIntents.
*/
public Builder setFinalCapture(Boolean finalCapture) {
this.finalCapture = finalCapture;
return this;
}
/**
* Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call,
* and subsequent calls add additional key/value pairs to the original map. See {@link
* PaymentIntentCaptureParams#metadata} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder putMetadata(String key, String value) {
if (this.metadata == null || this.metadata instanceof EmptyParam) {
this.metadata = new HashMap();
}
((Map) this.metadata).put(key, value);
return this;
}
/**
* Add all map key/value pairs to `metadata` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link PaymentIntentCaptureParams#metadata} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder putAllMetadata(Map map) {
if (this.metadata == null || this.metadata instanceof EmptyParam) {
this.metadata = new HashMap();
}
((Map) this.metadata).putAll(map);
return this;
}
/**
* Set of key-value pairs that you can attach
* to an object. This can be useful for storing additional information about the object in a
* structured format. Individual keys can be unset by posting an empty value to them. All keys
* can be unset by posting an empty value to {@code metadata}.
*/
public Builder setMetadata(EmptyParam metadata) {
this.metadata = metadata;
return this;
}
/**
* Set of key-value pairs that you can attach
* to an object. This can be useful for storing additional information about the object in a
* structured format. Individual keys can be unset by posting an empty value to them. All keys
* can be unset by posting an empty value to {@code metadata}.
*/
public Builder setMetadata(Map metadata) {
this.metadata = metadata;
return this;
}
/**
* Text that appears on the customer's statement as the statement descriptor for a non-card
* charge. This value overrides the account's default statement descriptor. For information
* about requirements, including the 22-character limit, see the Statement
* Descriptor docs.
*
* Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix
* instead.
*/
public Builder setStatementDescriptor(String statementDescriptor) {
this.statementDescriptor = statementDescriptor;
return this;
}
/**
* Provides information about a card charge. Concatenated to the account's statement
* descriptor prefix to form the complete statement descriptor that appears on the
* customer's statement.
*/
public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) {
this.statementDescriptorSuffix = statementDescriptorSuffix;
return this;
}
/**
* The parameters that you can use to automatically create a transfer after the payment is
* captured. Learn more about the use case for connected
* accounts.
*/
public Builder setTransferData(PaymentIntentCaptureParams.TransferData transferData) {
this.transferData = transferData;
return this;
}
}
@Getter
public static class TransferData {
/** The amount that will be transferred automatically when a charge succeeds. */
@SerializedName("amount")
Long amount;
/**
* 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 {@code @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.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
private TransferData(Long amount, Map extraParams) {
this.amount = amount;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public PaymentIntentCaptureParams.TransferData build() {
return new PaymentIntentCaptureParams.TransferData(this.amount, this.extraParams);
}
/** The amount that will be transferred automatically when a charge succeeds. */
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/**
* 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. See {@link
* PaymentIntentCaptureParams.TransferData#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* 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.
* See {@link PaymentIntentCaptureParams.TransferData#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
}
}
}