com.stripe.param.ChargeCaptureParams Maven / Gradle / Ivy
// Generated by delombok at Fri May 01 10:51:46 PDT 2020
package com.stripe.param;
import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class ChargeCaptureParams extends ApiRequestParams {
/**
* The amount to capture, which must be less than or equal to the original amount. Any additional
* amount will be automatically refunded.
*/
@SerializedName("amount")
Long amount;
/**
* An application fee to add on to this charge.
*/
@SerializedName("application_fee")
Long applicationFee;
/**
* An application fee amount to add on to this charge, which must be less than or equal to the
* original amount.
*/
@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;
/**
* 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.
*/
@SerializedName("receipt_email")
String receiptEmail;
/**
* For card charges, use {@code 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.
*/
@SerializedName("statement_descriptor")
String statementDescriptor;
/**
* 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.
*/
@SerializedName("statement_descriptor_suffix")
String statementDescriptorSuffix;
/**
* An optional dictionary including the account to automatically transfer to as part of a
* destination charge. See the
* Connect documentation for details.
*/
@SerializedName("transfer_data")
TransferData transferData;
/**
* A string that identifies this transaction as part of a group. {@code transfer_group} may only
* be provided if it has not been set. See the Connect
* documentation for details.
*/
@SerializedName("transfer_group")
String transferGroup;
private ChargeCaptureParams(Long amount, Long applicationFee, Long applicationFeeAmount, List expand, Map extraParams, String receiptEmail, String statementDescriptor, String statementDescriptorSuffix, TransferData transferData, String transferGroup) {
this.amount = amount;
this.applicationFee = applicationFee;
this.applicationFeeAmount = applicationFeeAmount;
this.expand = expand;
this.extraParams = extraParams;
this.receiptEmail = receiptEmail;
this.statementDescriptor = statementDescriptor;
this.statementDescriptorSuffix = statementDescriptorSuffix;
this.transferData = transferData;
this.transferGroup = transferGroup;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private Long applicationFee;
private Long applicationFeeAmount;
private List expand;
private Map extraParams;
private String receiptEmail;
private String statementDescriptor;
private String statementDescriptorSuffix;
private TransferData transferData;
private String transferGroup;
/**
* Finalize and obtain parameter instance from this builder.
*/
public ChargeCaptureParams build() {
return new ChargeCaptureParams(this.amount, this.applicationFee, this.applicationFeeAmount, this.expand, this.extraParams, this.receiptEmail, this.statementDescriptor, this.statementDescriptorSuffix, this.transferData, this.transferGroup);
}
/**
* The amount to capture, which must be less than or equal to the original amount. Any
* additional amount will be automatically refunded.
*/
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/**
* An application fee to add on to this charge.
*/
public Builder setApplicationFee(Long applicationFee) {
this.applicationFee = applicationFee;
return this;
}
/**
* An application fee amount to add on to this charge, which must be less than or equal to the
* original amount.
*/
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
* ChargeCaptureParams#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
* ChargeCaptureParams#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
* ChargeCaptureParams#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 ChargeCaptureParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* 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.
*/
public Builder setReceiptEmail(String receiptEmail) {
this.receiptEmail = receiptEmail;
return this;
}
/**
* For card charges, use {@code 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.
*/
public Builder setStatementDescriptor(String statementDescriptor) {
this.statementDescriptor = statementDescriptor;
return this;
}
/**
* 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.
*/
public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) {
this.statementDescriptorSuffix = statementDescriptorSuffix;
return this;
}
/**
* An optional dictionary including the account to automatically transfer to as part of a
* destination charge. See the
* Connect documentation for details.
*/
public Builder setTransferData(TransferData transferData) {
this.transferData = transferData;
return this;
}
/**
* A string that identifies this transaction as part of a group. {@code transfer_group} may only
* be provided if it has not been set. See the Connect
* documentation for details.
*/
public Builder setTransferGroup(String transferGroup) {
this.transferGroup = transferGroup;
return this;
}
}
public static class TransferData {
/**
* The amount transferred to the destination account, if specified. By default, the entire
* charge amount is transferred to the destination account.
*/
@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 TransferData build() {
return new TransferData(this.amount, this.extraParams);
}
/**
* The amount transferred to the destination account, if specified. By default, the entire
* charge amount is transferred to the destination account.
*/
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
* ChargeCaptureParams.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 ChargeCaptureParams.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;
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getAmount() {
return this.amount;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
}
/**
* The amount to capture, which must be less than or equal to the original amount. Any additional
* amount will be automatically refunded.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getAmount() {
return this.amount;
}
/**
* An application fee to add on to this charge.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getApplicationFee() {
return this.applicationFee;
}
/**
* An application fee amount to add on to this charge, which must be less than or equal to the
* original amount.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getApplicationFeeAmount() {
return this.applicationFeeAmount;
}
/**
* Specifies which fields in the response should be expanded.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public List getExpand() {
return this.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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* 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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getReceiptEmail() {
return this.receiptEmail;
}
/**
* For card charges, use {@code 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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getStatementDescriptor() {
return this.statementDescriptor;
}
/**
* 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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getStatementDescriptorSuffix() {
return this.statementDescriptorSuffix;
}
/**
* An optional dictionary including the account to automatically transfer to as part of a
* destination charge. See the
* Connect documentation for details.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public TransferData getTransferData() {
return this.transferData;
}
/**
* A string that identifies this transaction as part of a group. {@code transfer_group} may only
* be provided if it has not been set. See the Connect
* documentation for details.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTransferGroup() {
return this.transferGroup;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy