com.stripe.param.CustomerFundCashBalanceParams 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 java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.Getter;
@Getter
public class CustomerFundCashBalanceParams extends ApiRequestParams {
/**
* Required. Amount to be used for this test cash balance transaction. A positive
* integer representing how much to fund in the smallest currency unit (e.g., 100
* cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).
*/
@SerializedName("amount")
Long amount;
/**
* Required. Three-letter ISO currency code, in lowercase.
* Must be a supported currency.
*/
@SerializedName("currency")
String currency;
/** 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;
/**
* A description of the test funding. This simulates free-text references supplied by customers
* when making bank transfers to their cash balance. You can use this to test how Stripe's reconciliation
* algorithm applies to different user inputs.
*/
@SerializedName("reference")
String reference;
private CustomerFundCashBalanceParams(
Long amount,
String currency,
List expand,
Map extraParams,
String reference) {
this.amount = amount;
this.currency = currency;
this.expand = expand;
this.extraParams = extraParams;
this.reference = reference;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private String currency;
private List expand;
private Map extraParams;
private String reference;
/** Finalize and obtain parameter instance from this builder. */
public CustomerFundCashBalanceParams build() {
return new CustomerFundCashBalanceParams(
this.amount, this.currency, this.expand, this.extraParams, this.reference);
}
/**
* Required. Amount to be used for this test cash balance transaction. A
* positive integer representing how much to fund in the smallest currency unit (e.g., 100
* cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).
*/
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/**
* Required. Three-letter ISO currency code, in lowercase.
* Must be a supported currency.
*/
public Builder setCurrency(String currency) {
this.currency = currency;
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
* CustomerFundCashBalanceParams#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
* CustomerFundCashBalanceParams#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
* CustomerFundCashBalanceParams#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 CustomerFundCashBalanceParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* A description of the test funding. This simulates free-text references supplied by customers
* when making bank transfers to their cash balance. You can use this to test how Stripe's reconciliation
* algorithm applies to different user inputs.
*/
public Builder setReference(String reference) {
this.reference = reference;
return this;
}
}
}