com.stripe.param.OrderCreateParams 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.math.BigDecimal;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.Getter;
@Getter
public class OrderCreateParams extends ApiRequestParams {
/** Settings for automatic tax calculation for this order. */
@SerializedName("automatic_tax")
AutomaticTax automaticTax;
/**
* Billing details for the customer. If a customer is provided, this will be automatically
* populated with values from that customer if override values are not provided.
*/
@SerializedName("billing_details")
Object billingDetails;
/** The credits to apply to the order, only {@code gift_card} currently supported. */
@SerializedName("credits")
Object credits;
/**
* Required. Three-letter ISO currency code, in lowercase.
* Must be a supported currency.
*/
@SerializedName("currency")
String currency;
/** The customer associated with this order. */
@SerializedName("customer")
String customer;
/** An arbitrary string attached to the object. Often useful for displaying to users. */
@SerializedName("description")
String description;
/** The coupons, promotion codes, and/or discounts to apply to the order. */
@SerializedName("discounts")
Object discounts;
/** 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 IP address of the purchaser for this order. */
@SerializedName("ip_address")
String ipAddress;
/**
* Required. A list of line items the customer is ordering. Each line item
* includes information about the product, the quantity, and the resulting cost.
*/
@SerializedName("line_items")
List lineItems;
/**
* 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")
Map metadata;
/** Payment information associated with the order, including payment settings. */
@SerializedName("payment")
Payment payment;
/** Settings for the customer cost of shipping for this order. */
@SerializedName("shipping_cost")
Object shippingCost;
/** Shipping details for the order. */
@SerializedName("shipping_details")
Object shippingDetails;
/** Additional tax details about the purchaser to be used for this order. */
@SerializedName("tax_details")
TaxDetails taxDetails;
private OrderCreateParams(
AutomaticTax automaticTax,
Object billingDetails,
Object credits,
String currency,
String customer,
String description,
Object discounts,
List expand,
Map extraParams,
String ipAddress,
List lineItems,
Map metadata,
Payment payment,
Object shippingCost,
Object shippingDetails,
TaxDetails taxDetails) {
this.automaticTax = automaticTax;
this.billingDetails = billingDetails;
this.credits = credits;
this.currency = currency;
this.customer = customer;
this.description = description;
this.discounts = discounts;
this.expand = expand;
this.extraParams = extraParams;
this.ipAddress = ipAddress;
this.lineItems = lineItems;
this.metadata = metadata;
this.payment = payment;
this.shippingCost = shippingCost;
this.shippingDetails = shippingDetails;
this.taxDetails = taxDetails;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private AutomaticTax automaticTax;
private Object billingDetails;
private Object credits;
private String currency;
private String customer;
private String description;
private Object discounts;
private List expand;
private Map extraParams;
private String ipAddress;
private List lineItems;
private Map metadata;
private Payment payment;
private Object shippingCost;
private Object shippingDetails;
private TaxDetails taxDetails;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams build() {
return new OrderCreateParams(
this.automaticTax,
this.billingDetails,
this.credits,
this.currency,
this.customer,
this.description,
this.discounts,
this.expand,
this.extraParams,
this.ipAddress,
this.lineItems,
this.metadata,
this.payment,
this.shippingCost,
this.shippingDetails,
this.taxDetails);
}
/** Settings for automatic tax calculation for this order. */
public Builder setAutomaticTax(OrderCreateParams.AutomaticTax automaticTax) {
this.automaticTax = automaticTax;
return this;
}
/**
* Billing details for the customer. If a customer is provided, this will be automatically
* populated with values from that customer if override values are not provided.
*/
public Builder setBillingDetails(OrderCreateParams.BillingDetails billingDetails) {
this.billingDetails = billingDetails;
return this;
}
/**
* Billing details for the customer. If a customer is provided, this will be automatically
* populated with values from that customer if override values are not provided.
*/
public Builder setBillingDetails(EmptyParam billingDetails) {
this.billingDetails = billingDetails;
return this;
}
/**
* Add an element to `credits` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* OrderCreateParams#credits} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addCredit(OrderCreateParams.Credit element) {
if (this.credits == null || this.credits instanceof EmptyParam) {
this.credits = new ArrayList();
}
((List) this.credits).add(element);
return this;
}
/**
* Add all elements to `credits` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* OrderCreateParams#credits} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllCredit(List elements) {
if (this.credits == null || this.credits instanceof EmptyParam) {
this.credits = new ArrayList();
}
((List) this.credits).addAll(elements);
return this;
}
/** The credits to apply to the order, only {@code gift_card} currently supported. */
public Builder setCredits(EmptyParam credits) {
this.credits = credits;
return this;
}
/** The credits to apply to the order, only {@code gift_card} currently supported. */
public Builder setCredits(List credits) {
this.credits = credits;
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;
}
/** The customer associated with this order. */
public Builder setCustomer(String customer) {
this.customer = customer;
return this;
}
/** An arbitrary string attached to the object. Often useful for displaying to users. */
public Builder setDescription(String description) {
this.description = description;
return this;
}
/**
* Add an element to `discounts` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* OrderCreateParams#discounts} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addDiscount(OrderCreateParams.Discount element) {
if (this.discounts == null || this.discounts instanceof EmptyParam) {
this.discounts = new ArrayList();
}
((List) this.discounts).add(element);
return this;
}
/**
* Add all elements to `discounts` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* OrderCreateParams#discounts} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllDiscount(List elements) {
if (this.discounts == null || this.discounts instanceof EmptyParam) {
this.discounts = new ArrayList();
}
((List) this.discounts).addAll(elements);
return this;
}
/** The coupons, promotion codes, and/or discounts to apply to the order. */
public Builder setDiscounts(EmptyParam discounts) {
this.discounts = discounts;
return this;
}
/** The coupons, promotion codes, and/or discounts to apply to the order. */
public Builder setDiscounts(List discounts) {
this.discounts = discounts;
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
* OrderCreateParams#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
* OrderCreateParams#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
* OrderCreateParams#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 OrderCreateParams#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 IP address of the purchaser for this order. */
public Builder setIpAddress(String ipAddress) {
this.ipAddress = ipAddress;
return this;
}
/**
* Add an element to `lineItems` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* OrderCreateParams#lineItems} for the field documentation.
*/
public Builder addLineItem(OrderCreateParams.LineItem element) {
if (this.lineItems == null) {
this.lineItems = new ArrayList<>();
}
this.lineItems.add(element);
return this;
}
/**
* Add all elements to `lineItems` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* OrderCreateParams#lineItems} for the field documentation.
*/
public Builder addAllLineItem(List elements) {
if (this.lineItems == null) {
this.lineItems = new ArrayList<>();
}
this.lineItems.addAll(elements);
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
* OrderCreateParams#metadata} for the field documentation.
*/
public Builder putMetadata(String key, String value) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
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 OrderCreateParams#metadata} for the field documentation.
*/
public Builder putAllMetadata(Map map) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.putAll(map);
return this;
}
/** Payment information associated with the order, including payment settings. */
public Builder setPayment(OrderCreateParams.Payment payment) {
this.payment = payment;
return this;
}
/** Settings for the customer cost of shipping for this order. */
public Builder setShippingCost(OrderCreateParams.ShippingCost shippingCost) {
this.shippingCost = shippingCost;
return this;
}
/** Settings for the customer cost of shipping for this order. */
public Builder setShippingCost(EmptyParam shippingCost) {
this.shippingCost = shippingCost;
return this;
}
/** Shipping details for the order. */
public Builder setShippingDetails(OrderCreateParams.ShippingDetails shippingDetails) {
this.shippingDetails = shippingDetails;
return this;
}
/** Shipping details for the order. */
public Builder setShippingDetails(EmptyParam shippingDetails) {
this.shippingDetails = shippingDetails;
return this;
}
/** Additional tax details about the purchaser to be used for this order. */
public Builder setTaxDetails(OrderCreateParams.TaxDetails taxDetails) {
this.taxDetails = taxDetails;
return this;
}
}
@Getter
public static class AutomaticTax {
/**
* Required. Enable automatic tax calculation which will automatically compute
* tax rates on this order.
*/
@SerializedName("enabled")
Boolean enabled;
/**
* 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 AutomaticTax(Boolean enabled, Map extraParams) {
this.enabled = enabled;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Boolean enabled;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.AutomaticTax build() {
return new OrderCreateParams.AutomaticTax(this.enabled, this.extraParams);
}
/**
* Required. Enable automatic tax calculation which will automatically
* compute tax rates on this order.
*/
public Builder setEnabled(Boolean enabled) {
this.enabled = enabled;
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
* OrderCreateParams.AutomaticTax#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 OrderCreateParams.AutomaticTax#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
}
}
@Getter
public static class BillingDetails {
/** The billing address provided by the customer. */
@SerializedName("address")
Address address;
/** The billing email provided by the customer. */
@SerializedName("email")
String email;
/**
* 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 billing name provided by the customer. */
@SerializedName("name")
String name;
/** The billing phone number provided by the customer. */
@SerializedName("phone")
String phone;
private BillingDetails(
Address address, String email, Map extraParams, String name, String phone) {
this.address = address;
this.email = email;
this.extraParams = extraParams;
this.name = name;
this.phone = phone;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Address address;
private String email;
private Map extraParams;
private String name;
private String phone;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.BillingDetails build() {
return new OrderCreateParams.BillingDetails(
this.address, this.email, this.extraParams, this.name, this.phone);
}
/** The billing address provided by the customer. */
public Builder setAddress(OrderCreateParams.BillingDetails.Address address) {
this.address = address;
return this;
}
/** The billing email provided by the customer. */
public Builder setEmail(String email) {
this.email = email;
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
* OrderCreateParams.BillingDetails#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 OrderCreateParams.BillingDetails#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 billing name provided by the customer. */
public Builder setName(String name) {
this.name = name;
return this;
}
/** The billing phone number provided by the customer. */
public Builder setPhone(String phone) {
this.phone = phone;
return this;
}
}
@Getter
public static class Address {
/** City, district, suburb, town, or village. */
@SerializedName("city")
String city;
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
@SerializedName("country")
String country;
/**
* 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;
/** Address line 1 (e.g., street, PO Box, or company name). */
@SerializedName("line1")
String line1;
/** Address line 2 (e.g., apartment, suite, unit, or building). */
@SerializedName("line2")
String line2;
/** ZIP or postal code. */
@SerializedName("postal_code")
String postalCode;
/**
* State/province as an ISO 3166-2
* subdivision code, without country prefix. Example: "NY" or "TX".
*/
@SerializedName("state")
String state;
private Address(
String city,
String country,
Map extraParams,
String line1,
String line2,
String postalCode,
String state) {
this.city = city;
this.country = country;
this.extraParams = extraParams;
this.line1 = line1;
this.line2 = line2;
this.postalCode = postalCode;
this.state = state;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String city;
private String country;
private Map extraParams;
private String line1;
private String line2;
private String postalCode;
private String state;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.BillingDetails.Address build() {
return new OrderCreateParams.BillingDetails.Address(
this.city,
this.country,
this.extraParams,
this.line1,
this.line2,
this.postalCode,
this.state);
}
/** City, district, suburb, town, or village. */
public Builder setCity(String city) {
this.city = city;
return this;
}
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
public Builder setCountry(String country) {
this.country = country;
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 OrderCreateParams.BillingDetails.Address#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 OrderCreateParams.BillingDetails.Address#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Address line 1 (e.g., street, PO Box, or company name). */
public Builder setLine1(String line1) {
this.line1 = line1;
return this;
}
/** Address line 2 (e.g., apartment, suite, unit, or building). */
public Builder setLine2(String line2) {
this.line2 = line2;
return this;
}
/** ZIP or postal code. */
public Builder setPostalCode(String postalCode) {
this.postalCode = postalCode;
return this;
}
/**
* State/province as an ISO 3166-2
* subdivision code, without country prefix. Example: "NY" or "TX".
*/
public Builder setState(String state) {
this.state = state;
return this;
}
}
}
}
@Getter
public static class Credit {
/**
* 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 gift card to apply to the order. */
@SerializedName("gift_card")
String giftCard;
/**
* Required. The type of credit to apply to the order, only {@code gift_card}
* currently supported.
*/
@SerializedName("type")
Type type;
private Credit(Map extraParams, String giftCard, Type type) {
this.extraParams = extraParams;
this.giftCard = giftCard;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private String giftCard;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Credit build() {
return new OrderCreateParams.Credit(this.extraParams, this.giftCard, this.type);
}
/**
* 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
* OrderCreateParams.Credit#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 OrderCreateParams.Credit#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 gift card to apply to the order. */
public Builder setGiftCard(String giftCard) {
this.giftCard = giftCard;
return this;
}
/**
* Required. The type of credit to apply to the order, only {@code gift_card}
* currently supported.
*/
public Builder setType(OrderCreateParams.Credit.Type type) {
this.type = type;
return this;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("gift_card")
GIFT_CARD("gift_card");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
@Getter
public static class Discount {
/** ID of the coupon to create a new discount for. */
@SerializedName("coupon")
String coupon;
/** ID of an existing discount on the object (or one of its ancestors) to reuse. */
@SerializedName("discount")
String discount;
/**
* 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;
/** ID of the promotion code to create a new discount for. */
@SerializedName("promotion_code")
String promotionCode;
private Discount(
String coupon, String discount, Map extraParams, String promotionCode) {
this.coupon = coupon;
this.discount = discount;
this.extraParams = extraParams;
this.promotionCode = promotionCode;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String coupon;
private String discount;
private Map extraParams;
private String promotionCode;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Discount build() {
return new OrderCreateParams.Discount(
this.coupon, this.discount, this.extraParams, this.promotionCode);
}
/** ID of the coupon to create a new discount for. */
public Builder setCoupon(String coupon) {
this.coupon = coupon;
return this;
}
/** ID of an existing discount on the object (or one of its ancestors) to reuse. */
public Builder setDiscount(String discount) {
this.discount = discount;
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
* OrderCreateParams.Discount#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 OrderCreateParams.Discount#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** ID of the promotion code to create a new discount for. */
public Builder setPromotionCode(String promotionCode) {
this.promotionCode = promotionCode;
return this;
}
}
}
@Getter
public static class LineItem {
/** The description for the line item. Will default to the name of the associated product. */
@SerializedName("description")
String description;
/** The discounts applied to this line item. */
@SerializedName("discounts")
Object discounts;
/**
* 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 ID of a Price to add to the Order.
*
* The {@code price} parameter is an alternative to using the {@code product} parameter. If
* each of your products are sold at a single price, you can set {@code Product.default_price}
* and then pass the {@code product} parameter when creating a line item. If your products are
* sold at several possible prices, use the {@code price} parameter to explicitly specify which
* one to use.
*/
@SerializedName("price")
String price;
/**
* Data used to generate a new Price object inline.
*
*
The {@code price_data} parameter is an alternative to using the {@code product} or {@code
* price} parameters. If you create products upfront and configure a {@code
* Product.default_price}, pass the {@code product} parameter when creating a line item. If you
* prefer not to define products upfront, or if you charge variable prices, pass the {@code
* price_data} parameter to describe the price for this line item.
*
*
Each time you pass {@code price_data} we create a Price for the product. This Price is
* hidden in both the Dashboard and API lists and cannot be reused.
*/
@SerializedName("price_data")
PriceData priceData;
/**
* The ID of a Product to add to the Order.
*
*
The product must have a {@code default_price} specified. Otherwise, specify the price by
* passing the {@code price} or {@code price_data} parameter.
*/
@SerializedName("product")
String product;
/**
* Defines a Product inline and adds it to the Order.
*
*
{@code product_data} is an alternative to the {@code product} parameter. If you created a
* Product upfront, use the {@code product} parameter to refer to the existing Product. But if
* you prefer not to create Products upfront, pass the {@code product_data} parameter to define
* a Product inline as part of configuring the Order.
*
*
{@code product_data} automatically creates a Product, just as if you had manually created
* the Product. If a Product with the same ID already exists, then {@code product_data} re-uses
* it to avoid duplicates.
*/
@SerializedName("product_data")
ProductData productData;
/** The quantity of the line item. */
@SerializedName("quantity")
Long quantity;
/** The tax rates applied to this line item. */
@SerializedName("tax_rates")
Object taxRates;
private LineItem(
String description,
Object discounts,
Map extraParams,
String price,
PriceData priceData,
String product,
ProductData productData,
Long quantity,
Object taxRates) {
this.description = description;
this.discounts = discounts;
this.extraParams = extraParams;
this.price = price;
this.priceData = priceData;
this.product = product;
this.productData = productData;
this.quantity = quantity;
this.taxRates = taxRates;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String description;
private Object discounts;
private Map extraParams;
private String price;
private PriceData priceData;
private String product;
private ProductData productData;
private Long quantity;
private Object taxRates;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.LineItem build() {
return new OrderCreateParams.LineItem(
this.description,
this.discounts,
this.extraParams,
this.price,
this.priceData,
this.product,
this.productData,
this.quantity,
this.taxRates);
}
/** The description for the line item. Will default to the name of the associated product. */
public Builder setDescription(String description) {
this.description = description;
return this;
}
/**
* Add an element to `discounts` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* OrderCreateParams.LineItem#discounts} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addDiscount(OrderCreateParams.LineItem.Discount element) {
if (this.discounts == null || this.discounts instanceof EmptyParam) {
this.discounts = new ArrayList();
}
((List) this.discounts).add(element);
return this;
}
/**
* Add all elements to `discounts` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* OrderCreateParams.LineItem#discounts} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllDiscount(List elements) {
if (this.discounts == null || this.discounts instanceof EmptyParam) {
this.discounts = new ArrayList();
}
((List) this.discounts).addAll(elements);
return this;
}
/** The discounts applied to this line item. */
public Builder setDiscounts(EmptyParam discounts) {
this.discounts = discounts;
return this;
}
/** The discounts applied to this line item. */
public Builder setDiscounts(List discounts) {
this.discounts = discounts;
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
* OrderCreateParams.LineItem#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 OrderCreateParams.LineItem#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 ID of a Price to add to the Order.
*
* The {@code price} parameter is an alternative to using the {@code product} parameter. If
* each of your products are sold at a single price, you can set {@code Product.default_price}
* and then pass the {@code product} parameter when creating a line item. If your products are
* sold at several possible prices, use the {@code price} parameter to explicitly specify
* which one to use.
*/
public Builder setPrice(String price) {
this.price = price;
return this;
}
/**
* Data used to generate a new Price object inline.
*
*
The {@code price_data} parameter is an alternative to using the {@code product} or
* {@code price} parameters. If you create products upfront and configure a {@code
* Product.default_price}, pass the {@code product} parameter when creating a line item. If
* you prefer not to define products upfront, or if you charge variable prices, pass the
* {@code price_data} parameter to describe the price for this line item.
*
*
Each time you pass {@code price_data} we create a Price for the product. This Price is
* hidden in both the Dashboard and API lists and cannot be reused.
*/
public Builder setPriceData(OrderCreateParams.LineItem.PriceData priceData) {
this.priceData = priceData;
return this;
}
/**
* The ID of a Product to add to the Order.
*
*
The product must have a {@code default_price} specified. Otherwise, specify the price by
* passing the {@code price} or {@code price_data} parameter.
*/
public Builder setProduct(String product) {
this.product = product;
return this;
}
/**
* Defines a Product inline and adds it to the Order.
*
*
{@code product_data} is an alternative to the {@code product} parameter. If you created
* a Product upfront, use the {@code product} parameter to refer to the existing Product. But
* if you prefer not to create Products upfront, pass the {@code product_data} parameter to
* define a Product inline as part of configuring the Order.
*
*
{@code product_data} automatically creates a Product, just as if you had manually
* created the Product. If a Product with the same ID already exists, then {@code
* product_data} re-uses it to avoid duplicates.
*/
public Builder setProductData(OrderCreateParams.LineItem.ProductData productData) {
this.productData = productData;
return this;
}
/** The quantity of the line item. */
public Builder setQuantity(Long quantity) {
this.quantity = quantity;
return this;
}
/**
* Add an element to `taxRates` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* OrderCreateParams.LineItem#taxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addTaxRate(String element) {
if (this.taxRates == null || this.taxRates instanceof EmptyParam) {
this.taxRates = new ArrayList();
}
((List) this.taxRates).add(element);
return this;
}
/**
* Add all elements to `taxRates` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* OrderCreateParams.LineItem#taxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllTaxRate(List elements) {
if (this.taxRates == null || this.taxRates instanceof EmptyParam) {
this.taxRates = new ArrayList();
}
((List) this.taxRates).addAll(elements);
return this;
}
/** The tax rates applied to this line item. */
public Builder setTaxRates(EmptyParam taxRates) {
this.taxRates = taxRates;
return this;
}
/** The tax rates applied to this line item. */
public Builder setTaxRates(List taxRates) {
this.taxRates = taxRates;
return this;
}
}
@Getter
public static class Discount {
/** ID of the coupon to create a new discount for. */
@SerializedName("coupon")
String coupon;
/** ID of an existing discount on the object (or one of its ancestors) to reuse. */
@SerializedName("discount")
String discount;
/**
* 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 Discount(String coupon, String discount, Map extraParams) {
this.coupon = coupon;
this.discount = discount;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String coupon;
private String discount;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.LineItem.Discount build() {
return new OrderCreateParams.LineItem.Discount(
this.coupon, this.discount, this.extraParams);
}
/** ID of the coupon to create a new discount for. */
public Builder setCoupon(String coupon) {
this.coupon = coupon;
return this;
}
/** ID of an existing discount on the object (or one of its ancestors) to reuse. */
public Builder setDiscount(String discount) {
this.discount = discount;
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 OrderCreateParams.LineItem.Discount#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 OrderCreateParams.LineItem.Discount#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
}
}
@Getter
public static class PriceData {
/**
* Three-letter ISO currency
* code, in lowercase. Must be a supported
* currency.
*/
@SerializedName("currency")
String currency;
/**
* 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;
/**
* ID of the product this price belongs to.
*
* Use this to implement a variable-pricing model in your integration. This is required if
* {@code product_data} is not specified.
*/
@SerializedName("product")
String product;
/**
* Only required if a default
* tax behavior was not provided in the Stripe Tax settings. Specifies whether the price
* is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code
* exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code
* exclusive}, it cannot be changed.
*/
@SerializedName("tax_behavior")
TaxBehavior taxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how
* much to charge.
*/
@SerializedName("unit_amount")
Long unitAmount;
/**
* Same as {@code unit_amount}, but accepts a decimal value in cents (or local equivalent)
* with at most 12 decimal places. Only one of {@code unit_amount} and {@code
* unit_amount_decimal} can be set.
*/
@SerializedName("unit_amount_decimal")
BigDecimal unitAmountDecimal;
private PriceData(
String currency,
Map extraParams,
String product,
TaxBehavior taxBehavior,
Long unitAmount,
BigDecimal unitAmountDecimal) {
this.currency = currency;
this.extraParams = extraParams;
this.product = product;
this.taxBehavior = taxBehavior;
this.unitAmount = unitAmount;
this.unitAmountDecimal = unitAmountDecimal;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String currency;
private Map extraParams;
private String product;
private TaxBehavior taxBehavior;
private Long unitAmount;
private BigDecimal unitAmountDecimal;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.LineItem.PriceData build() {
return new OrderCreateParams.LineItem.PriceData(
this.currency,
this.extraParams,
this.product,
this.taxBehavior,
this.unitAmount,
this.unitAmountDecimal);
}
/**
* Three-letter ISO currency
* code, in lowercase. Must be a supported
* currency.
*/
public Builder setCurrency(String currency) {
this.currency = currency;
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 OrderCreateParams.LineItem.PriceData#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 OrderCreateParams.LineItem.PriceData#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* ID of the product this price belongs to.
*
* Use this to implement a variable-pricing model in your integration. This is required
* if {@code product_data} is not specified.
*/
public Builder setProduct(String product) {
this.product = product;
return this;
}
/**
* Only required if a default
* tax behavior was not provided in the Stripe Tax settings. Specifies whether the price
* is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code
* exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code
* exclusive}, it cannot be changed.
*/
public Builder setTaxBehavior(
OrderCreateParams.LineItem.PriceData.TaxBehavior taxBehavior) {
this.taxBehavior = taxBehavior;
return this;
}
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing
* how much to charge.
*/
public Builder setUnitAmount(Long unitAmount) {
this.unitAmount = unitAmount;
return this;
}
/**
* Same as {@code unit_amount}, but accepts a decimal value in cents (or local equivalent)
* with at most 12 decimal places. Only one of {@code unit_amount} and {@code
* unit_amount_decimal} can be set.
*/
public Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) {
this.unitAmountDecimal = unitAmountDecimal;
return this;
}
}
public enum TaxBehavior implements ApiRequestParams.EnumParam {
@SerializedName("exclusive")
EXCLUSIVE("exclusive"),
@SerializedName("inclusive")
INCLUSIVE("inclusive"),
@SerializedName("unspecified")
UNSPECIFIED("unspecified");
@Getter(onMethod_ = {@Override})
private final String value;
TaxBehavior(String value) {
this.value = value;
}
}
}
@Getter
public static class ProductData {
/**
* The product's description, meant to be displayable to the customer. Use this field to
* optionally store a long form explanation of the product being sold for your own rendering
* purposes.
*/
@SerializedName("description")
Object description;
/**
* 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;
/**
* Required. A unique identifier for this product.
*
* {@code product_data} automatically creates a Product with this ID. If a Product with the
* same ID already exists, then {@code product_data} re-uses it to avoid duplicates. If any of
* the fields in the existing Product are different from the values in {@code product_data},
* {@code product_data} updates the existing Product with the new information. So set {@code
* product_data[id]} to the same string every time you sell the same product, but don't re-use
* the same string for different products.
*/
@SerializedName("id")
String id;
/**
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
*/
@SerializedName("images")
Object images;
/**
* 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;
/** Required. The product's name, meant to be displayable to the customer. */
@SerializedName("name")
String name;
/** The dimensions of this product for shipping purposes. */
@SerializedName("package_dimensions")
Object packageDimensions;
/** Whether this product is shipped (i.e., physical goods). */
@SerializedName("shippable")
Boolean shippable;
/** A tax code ID. */
@SerializedName("tax_code")
Object taxCode;
/** A URL of a publicly-accessible webpage for this product. */
@SerializedName("url")
Object url;
private ProductData(
Object description,
Map extraParams,
String id,
Object images,
Object metadata,
String name,
Object packageDimensions,
Boolean shippable,
Object taxCode,
Object url) {
this.description = description;
this.extraParams = extraParams;
this.id = id;
this.images = images;
this.metadata = metadata;
this.name = name;
this.packageDimensions = packageDimensions;
this.shippable = shippable;
this.taxCode = taxCode;
this.url = url;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Object description;
private Map extraParams;
private String id;
private Object images;
private Object metadata;
private String name;
private Object packageDimensions;
private Boolean shippable;
private Object taxCode;
private Object url;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.LineItem.ProductData build() {
return new OrderCreateParams.LineItem.ProductData(
this.description,
this.extraParams,
this.id,
this.images,
this.metadata,
this.name,
this.packageDimensions,
this.shippable,
this.taxCode,
this.url);
}
/**
* The product's description, meant to be displayable to the customer. Use this field to
* optionally store a long form explanation of the product being sold for your own rendering
* purposes.
*/
public Builder setDescription(String description) {
this.description = description;
return this;
}
/**
* The product's description, meant to be displayable to the customer. Use this field to
* optionally store a long form explanation of the product being sold for your own rendering
* purposes.
*/
public Builder setDescription(EmptyParam description) {
this.description = description;
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 OrderCreateParams.LineItem.ProductData#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 OrderCreateParams.LineItem.ProductData#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Required. A unique identifier for this product.
*
* {@code product_data} automatically creates a Product with this ID. If a Product with
* the same ID already exists, then {@code product_data} re-uses it to avoid duplicates. If
* any of the fields in the existing Product are different from the values in {@code
* product_data}, {@code product_data} updates the existing Product with the new
* information. So set {@code product_data[id]} to the same string every time you sell the
* same product, but don't re-use the same string for different products.
*/
public Builder setId(String id) {
this.id = id;
return this;
}
/**
* Add an element to `images` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* OrderCreateParams.LineItem.ProductData#images} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addImage(String element) {
if (this.images == null || this.images instanceof EmptyParam) {
this.images = new ArrayList();
}
((List) this.images).add(element);
return this;
}
/**
* Add all elements to `images` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* OrderCreateParams.LineItem.ProductData#images} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllImage(List elements) {
if (this.images == null || this.images instanceof EmptyParam) {
this.images = new ArrayList();
}
((List) this.images).addAll(elements);
return this;
}
/**
* A list of up to 8 URLs of images for this product, meant to be displayable to the
* customer.
*/
public Builder setImages(EmptyParam images) {
this.images = images;
return this;
}
/**
* A list of up to 8 URLs of images for this product, meant to be displayable to the
* customer.
*/
public Builder setImages(List images) {
this.images = images;
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
* OrderCreateParams.LineItem.ProductData#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 OrderCreateParams.LineItem.ProductData#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;
}
/**
* Required. The product's name, meant to be displayable to the customer.
*/
public Builder setName(String name) {
this.name = name;
return this;
}
/** The dimensions of this product for shipping purposes. */
public Builder setPackageDimensions(
OrderCreateParams.LineItem.ProductData.PackageDimensions packageDimensions) {
this.packageDimensions = packageDimensions;
return this;
}
/** The dimensions of this product for shipping purposes. */
public Builder setPackageDimensions(EmptyParam packageDimensions) {
this.packageDimensions = packageDimensions;
return this;
}
/** Whether this product is shipped (i.e., physical goods). */
public Builder setShippable(Boolean shippable) {
this.shippable = shippable;
return this;
}
/** A tax code ID. */
public Builder setTaxCode(String taxCode) {
this.taxCode = taxCode;
return this;
}
/** A tax code ID. */
public Builder setTaxCode(EmptyParam taxCode) {
this.taxCode = taxCode;
return this;
}
/** A URL of a publicly-accessible webpage for this product. */
public Builder setUrl(String url) {
this.url = url;
return this;
}
/** A URL of a publicly-accessible webpage for this product. */
public Builder setUrl(EmptyParam url) {
this.url = url;
return this;
}
}
@Getter
public static class PackageDimensions {
/**
* 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;
/** Required. Height, in inches. Maximum precision is 2 decimal places. */
@SerializedName("height")
BigDecimal height;
/** Required. Length, in inches. Maximum precision is 2 decimal places. */
@SerializedName("length")
BigDecimal length;
/** Required. Weight, in ounces. Maximum precision is 2 decimal places. */
@SerializedName("weight")
BigDecimal weight;
/** Required. Width, in inches. Maximum precision is 2 decimal places. */
@SerializedName("width")
BigDecimal width;
private PackageDimensions(
Map extraParams,
BigDecimal height,
BigDecimal length,
BigDecimal weight,
BigDecimal width) {
this.extraParams = extraParams;
this.height = height;
this.length = length;
this.weight = weight;
this.width = width;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private BigDecimal height;
private BigDecimal length;
private BigDecimal weight;
private BigDecimal width;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.LineItem.ProductData.PackageDimensions build() {
return new OrderCreateParams.LineItem.ProductData.PackageDimensions(
this.extraParams, this.height, this.length, this.weight, this.width);
}
/**
* 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 OrderCreateParams.LineItem.ProductData.PackageDimensions#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 OrderCreateParams.LineItem.ProductData.PackageDimensions#extraParams}
* for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Required. Height, in inches. Maximum precision is 2 decimal places.
*/
public Builder setHeight(BigDecimal height) {
this.height = height;
return this;
}
/**
* Required. Length, in inches. Maximum precision is 2 decimal places.
*/
public Builder setLength(BigDecimal length) {
this.length = length;
return this;
}
/**
* Required. Weight, in ounces. Maximum precision is 2 decimal places.
*/
public Builder setWeight(BigDecimal weight) {
this.weight = weight;
return this;
}
/** Required. Width, in inches. Maximum precision is 2 decimal places. */
public Builder setWidth(BigDecimal width) {
this.width = width;
return this;
}
}
}
}
}
@Getter
public static class Payment {
/**
* 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;
/**
* Required. Settings describing how the order should configure generated
* PaymentIntents.
*/
@SerializedName("settings")
Settings settings;
private Payment(Map extraParams, Settings settings) {
this.extraParams = extraParams;
this.settings = settings;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private Settings settings;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment build() {
return new OrderCreateParams.Payment(this.extraParams, this.settings);
}
/**
* 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
* OrderCreateParams.Payment#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 OrderCreateParams.Payment#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Required. Settings describing how the order should configure generated
* PaymentIntents.
*/
public Builder setSettings(OrderCreateParams.Payment.Settings settings) {
this.settings = settings;
return this;
}
}
@Getter
public static class Settings {
/**
* 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.
*/
@SerializedName("application_fee_amount")
Long applicationFeeAmount;
/**
* 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;
/** PaymentMethod-specific configuration to provide to the order's PaymentIntent. */
@SerializedName("payment_method_options")
PaymentMethodOptions paymentMethodOptions;
/**
* The list of payment
* method types to provide to the order's PaymentIntent. Do not include this attribute if
* you prefer to manage your payment methods from the Stripe Dashboard.
*/
@SerializedName("payment_method_types")
List paymentMethodTypes;
/** The URL to redirect the customer to after they authenticate their payment. */
@SerializedName("return_url")
String returnUrl;
/**
* 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.
*/
@SerializedName("statement_descriptor")
String statementDescriptor;
/**
* 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.
*/
@SerializedName("statement_descriptor_suffix")
String statementDescriptorSuffix;
/** Provides configuration for completing a transfer for the order after it is paid. */
@SerializedName("transfer_data")
TransferData transferData;
private Settings(
Long applicationFeeAmount,
Map extraParams,
PaymentMethodOptions paymentMethodOptions,
List paymentMethodTypes,
String returnUrl,
String statementDescriptor,
String statementDescriptorSuffix,
TransferData transferData) {
this.applicationFeeAmount = applicationFeeAmount;
this.extraParams = extraParams;
this.paymentMethodOptions = paymentMethodOptions;
this.paymentMethodTypes = paymentMethodTypes;
this.returnUrl = returnUrl;
this.statementDescriptor = statementDescriptor;
this.statementDescriptorSuffix = statementDescriptorSuffix;
this.transferData = transferData;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long applicationFeeAmount;
private Map extraParams;
private PaymentMethodOptions paymentMethodOptions;
private List paymentMethodTypes;
private String returnUrl;
private String statementDescriptor;
private String statementDescriptorSuffix;
private TransferData transferData;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings build() {
return new OrderCreateParams.Payment.Settings(
this.applicationFeeAmount,
this.extraParams,
this.paymentMethodOptions,
this.paymentMethodTypes,
this.returnUrl,
this.statementDescriptor,
this.statementDescriptorSuffix,
this.transferData);
}
/**
* 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.
*/
public Builder setApplicationFeeAmount(Long applicationFeeAmount) {
this.applicationFeeAmount = applicationFeeAmount;
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 OrderCreateParams.Payment.Settings#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 OrderCreateParams.Payment.Settings#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** PaymentMethod-specific configuration to provide to the order's PaymentIntent. */
public Builder setPaymentMethodOptions(
OrderCreateParams.Payment.Settings.PaymentMethodOptions paymentMethodOptions) {
this.paymentMethodOptions = paymentMethodOptions;
return this;
}
/**
* Add an element to `paymentMethodTypes` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list.
* See {@link OrderCreateParams.Payment.Settings#paymentMethodTypes} for the field
* documentation.
*/
public Builder addPaymentMethodType(
OrderCreateParams.Payment.Settings.PaymentMethodType element) {
if (this.paymentMethodTypes == null) {
this.paymentMethodTypes = new ArrayList<>();
}
this.paymentMethodTypes.add(element);
return this;
}
/**
* Add all elements to `paymentMethodTypes` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list.
* See {@link OrderCreateParams.Payment.Settings#paymentMethodTypes} for the field
* documentation.
*/
public Builder addAllPaymentMethodType(
List elements) {
if (this.paymentMethodTypes == null) {
this.paymentMethodTypes = new ArrayList<>();
}
this.paymentMethodTypes.addAll(elements);
return this;
}
/** The URL to redirect the customer to after they authenticate their payment. */
public Builder setReturnUrl(String returnUrl) {
this.returnUrl = returnUrl;
return this;
}
/**
* 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.
*/
public Builder setStatementDescriptor(String statementDescriptor) {
this.statementDescriptor = statementDescriptor;
return this;
}
/**
* 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.
*/
public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) {
this.statementDescriptorSuffix = statementDescriptorSuffix;
return this;
}
/** Provides configuration for completing a transfer for the order after it is paid. */
public Builder setTransferData(
OrderCreateParams.Payment.Settings.TransferData transferData) {
this.transferData = transferData;
return this;
}
}
@Getter
public static class PaymentMethodOptions {
/**
* If paying by {@code acss_debit}, this sub-hash contains details about the ACSS Debit
* payment method options to pass to the order's PaymentIntent.
*/
@SerializedName("acss_debit")
AcssDebit acssDebit;
/**
* If paying by {@code afterpay_clearpay}, this sub-hash contains details about the
* AfterpayClearpay payment method options to pass to the order's PaymentIntent.
*/
@SerializedName("afterpay_clearpay")
AfterpayClearpay afterpayClearpay;
/**
* If paying by {@code alipay}, this sub-hash contains details about the Alipay payment
* method options to pass to the order's PaymentIntent.
*/
@SerializedName("alipay")
Alipay alipay;
/**
* If paying by {@code bancontact}, this sub-hash contains details about the Bancontact
* payment method options to pass to the order's PaymentIntent.
*/
@SerializedName("bancontact")
Bancontact bancontact;
/**
* If paying by {@code card}, this sub-hash contains details about the Card payment method
* options to pass to the order's PaymentIntent.
*/
@SerializedName("card")
Card card;
/**
* If paying by {@code customer_balance}, this sub-hash contains details about the Customer
* Balance payment method options to pass to the order's PaymentIntent.
*/
@SerializedName("customer_balance")
CustomerBalance customerBalance;
/**
* 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;
/**
* If paying by {@code ideal}, this sub-hash contains details about the iDEAL payment method
* options to pass to the order's PaymentIntent.
*/
@SerializedName("ideal")
Ideal ideal;
/**
* If paying by {@code klarna}, this sub-hash contains details about the Klarna payment
* method options to pass to the order's PaymentIntent.
*/
@SerializedName("klarna")
Klarna klarna;
/**
* If paying by {@code link}, this sub-hash contains details about the Link payment method
* options to pass to the order's PaymentIntent.
*/
@SerializedName("link")
Link link;
/**
* If paying by {@code oxxo}, this sub-hash contains details about the OXXO payment method
* options to pass to the order's PaymentIntent.
*/
@SerializedName("oxxo")
Oxxo oxxo;
/**
* If paying by {@code p24}, this sub-hash contains details about the P24 payment method
* options to pass to the order's PaymentIntent.
*/
@SerializedName("p24")
P24 p24;
/**
* If paying by {@code paypal}, this sub-hash contains details about the PayPal payment
* method options to pass to the order's PaymentIntent.
*/
@SerializedName("paypal")
Paypal paypal;
/**
* If paying by {@code sepa_debit}, this sub-hash contains details about the SEPA Debit
* payment method options to pass to the order's PaymentIntent.
*/
@SerializedName("sepa_debit")
SepaDebit sepaDebit;
/**
* If paying by {@code sofort}, this sub-hash contains details about the Sofort payment
* method options to pass to the order's PaymentIntent.
*/
@SerializedName("sofort")
Sofort sofort;
/**
* If paying by {@code wechat_pay}, this sub-hash contains details about the WeChat Pay
* payment method options to pass to the order's PaymentIntent.
*/
@SerializedName("wechat_pay")
WechatPay wechatPay;
private PaymentMethodOptions(
AcssDebit acssDebit,
AfterpayClearpay afterpayClearpay,
Alipay alipay,
Bancontact bancontact,
Card card,
CustomerBalance customerBalance,
Map extraParams,
Ideal ideal,
Klarna klarna,
Link link,
Oxxo oxxo,
P24 p24,
Paypal paypal,
SepaDebit sepaDebit,
Sofort sofort,
WechatPay wechatPay) {
this.acssDebit = acssDebit;
this.afterpayClearpay = afterpayClearpay;
this.alipay = alipay;
this.bancontact = bancontact;
this.card = card;
this.customerBalance = customerBalance;
this.extraParams = extraParams;
this.ideal = ideal;
this.klarna = klarna;
this.link = link;
this.oxxo = oxxo;
this.p24 = p24;
this.paypal = paypal;
this.sepaDebit = sepaDebit;
this.sofort = sofort;
this.wechatPay = wechatPay;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private AcssDebit acssDebit;
private AfterpayClearpay afterpayClearpay;
private Alipay alipay;
private Bancontact bancontact;
private Card card;
private CustomerBalance customerBalance;
private Map extraParams;
private Ideal ideal;
private Klarna klarna;
private Link link;
private Oxxo oxxo;
private P24 p24;
private Paypal paypal;
private SepaDebit sepaDebit;
private Sofort sofort;
private WechatPay wechatPay;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions(
this.acssDebit,
this.afterpayClearpay,
this.alipay,
this.bancontact,
this.card,
this.customerBalance,
this.extraParams,
this.ideal,
this.klarna,
this.link,
this.oxxo,
this.p24,
this.paypal,
this.sepaDebit,
this.sofort,
this.wechatPay);
}
/**
* If paying by {@code acss_debit}, this sub-hash contains details about the ACSS Debit
* payment method options to pass to the order's PaymentIntent.
*/
public Builder setAcssDebit(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit acssDebit) {
this.acssDebit = acssDebit;
return this;
}
/**
* If paying by {@code afterpay_clearpay}, this sub-hash contains details about the
* AfterpayClearpay payment method options to pass to the order's PaymentIntent.
*/
public Builder setAfterpayClearpay(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.AfterpayClearpay
afterpayClearpay) {
this.afterpayClearpay = afterpayClearpay;
return this;
}
/**
* If paying by {@code alipay}, this sub-hash contains details about the Alipay payment
* method options to pass to the order's PaymentIntent.
*/
public Builder setAlipay(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Alipay alipay) {
this.alipay = alipay;
return this;
}
/**
* If paying by {@code bancontact}, this sub-hash contains details about the Bancontact
* payment method options to pass to the order's PaymentIntent.
*/
public Builder setBancontact(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Bancontact bancontact) {
this.bancontact = bancontact;
return this;
}
/**
* If paying by {@code card}, this sub-hash contains details about the Card payment method
* options to pass to the order's PaymentIntent.
*/
public Builder setCard(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Card card) {
this.card = card;
return this;
}
/**
* If paying by {@code customer_balance}, this sub-hash contains details about the
* Customer Balance payment method options to pass to the order's PaymentIntent.
*/
public Builder setCustomerBalance(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance
customerBalance) {
this.customerBalance = customerBalance;
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 OrderCreateParams.Payment.Settings.PaymentMethodOptions#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 OrderCreateParams.Payment.Settings.PaymentMethodOptions#extraParams}
* for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* If paying by {@code ideal}, this sub-hash contains details about the iDEAL payment
* method options to pass to the order's PaymentIntent.
*/
public Builder setIdeal(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Ideal ideal) {
this.ideal = ideal;
return this;
}
/**
* If paying by {@code klarna}, this sub-hash contains details about the Klarna payment
* method options to pass to the order's PaymentIntent.
*/
public Builder setKlarna(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Klarna klarna) {
this.klarna = klarna;
return this;
}
/**
* If paying by {@code link}, this sub-hash contains details about the Link payment method
* options to pass to the order's PaymentIntent.
*/
public Builder setLink(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Link link) {
this.link = link;
return this;
}
/**
* If paying by {@code oxxo}, this sub-hash contains details about the OXXO payment method
* options to pass to the order's PaymentIntent.
*/
public Builder setOxxo(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Oxxo oxxo) {
this.oxxo = oxxo;
return this;
}
/**
* If paying by {@code p24}, this sub-hash contains details about the P24 payment method
* options to pass to the order's PaymentIntent.
*/
public Builder setP24(OrderCreateParams.Payment.Settings.PaymentMethodOptions.P24 p24) {
this.p24 = p24;
return this;
}
/**
* If paying by {@code paypal}, this sub-hash contains details about the PayPal payment
* method options to pass to the order's PaymentIntent.
*/
public Builder setPaypal(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Paypal paypal) {
this.paypal = paypal;
return this;
}
/**
* If paying by {@code sepa_debit}, this sub-hash contains details about the SEPA Debit
* payment method options to pass to the order's PaymentIntent.
*/
public Builder setSepaDebit(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.SepaDebit sepaDebit) {
this.sepaDebit = sepaDebit;
return this;
}
/**
* If paying by {@code sofort}, this sub-hash contains details about the Sofort payment
* method options to pass to the order's PaymentIntent.
*/
public Builder setSofort(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Sofort sofort) {
this.sofort = sofort;
return this;
}
/**
* If paying by {@code wechat_pay}, this sub-hash contains details about the WeChat Pay
* payment method options to pass to the order's PaymentIntent.
*/
public Builder setWechatPay(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.WechatPay wechatPay) {
this.wechatPay = wechatPay;
return this;
}
}
@Getter
public static class AcssDebit {
/**
* 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;
/** Additional fields for Mandate creation. */
@SerializedName("mandate_options")
MandateOptions mandateOptions;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to
* the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to a
* Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
@SerializedName("setup_future_usage")
ApiRequestParams.EnumParam setupFutureUsage;
/** Bank account verification method. */
@SerializedName("verification_method")
VerificationMethod verificationMethod;
private AcssDebit(
Map extraParams,
MandateOptions mandateOptions,
ApiRequestParams.EnumParam setupFutureUsage,
VerificationMethod verificationMethod) {
this.extraParams = extraParams;
this.mandateOptions = mandateOptions;
this.setupFutureUsage = setupFutureUsage;
this.verificationMethod = verificationMethod;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private MandateOptions mandateOptions;
private ApiRequestParams.EnumParam setupFutureUsage;
private VerificationMethod verificationMethod;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit(
this.extraParams,
this.mandateOptions,
this.setupFutureUsage,
this.verificationMethod);
}
/**
* 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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit#extraParams} for
* the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Additional fields for Mandate creation. */
public Builder setMandateOptions(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit.MandateOptions
mandateOptions) {
this.mandateOptions = mandateOptions;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
*
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(EmptyParam setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
/** Bank account verification method. */
public Builder setVerificationMethod(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit.VerificationMethod
verificationMethod) {
this.verificationMethod = verificationMethod;
return this;
}
}
@Getter
public static class MandateOptions {
/**
* A URL for custom mandate text to render during confirmation step. The URL will be
* rendered with additional GET parameters {@code payment_intent} and {@code
* payment_intent_client_secret} when confirming a Payment Intent, or {@code
* setup_intent} and {@code setup_intent_client_secret} when confirming a Setup Intent.
*/
@SerializedName("custom_mandate_url")
Object customMandateUrl;
/**
* 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;
/**
* Description of the mandate interval. Only required if 'payment_schedule' parameter is
* 'interval' or 'combined'.
*/
@SerializedName("interval_description")
String intervalDescription;
/** Payment schedule for the mandate. */
@SerializedName("payment_schedule")
PaymentSchedule paymentSchedule;
/** Transaction type of the mandate. */
@SerializedName("transaction_type")
TransactionType transactionType;
private MandateOptions(
Object customMandateUrl,
Map extraParams,
String intervalDescription,
PaymentSchedule paymentSchedule,
TransactionType transactionType) {
this.customMandateUrl = customMandateUrl;
this.extraParams = extraParams;
this.intervalDescription = intervalDescription;
this.paymentSchedule = paymentSchedule;
this.transactionType = transactionType;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Object customMandateUrl;
private Map extraParams;
private String intervalDescription;
private PaymentSchedule paymentSchedule;
private TransactionType transactionType;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit
.MandateOptions
build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit
.MandateOptions(
this.customMandateUrl,
this.extraParams,
this.intervalDescription,
this.paymentSchedule,
this.transactionType);
}
/**
* A URL for custom mandate text to render during confirmation step. The URL will be
* rendered with additional GET parameters {@code payment_intent} and {@code
* payment_intent_client_secret} when confirming a Payment Intent, or {@code
* setup_intent} and {@code setup_intent_client_secret} when confirming a Setup
* Intent.
*/
public Builder setCustomMandateUrl(String customMandateUrl) {
this.customMandateUrl = customMandateUrl;
return this;
}
/**
* A URL for custom mandate text to render during confirmation step. The URL will be
* rendered with additional GET parameters {@code payment_intent} and {@code
* payment_intent_client_secret} when confirming a Payment Intent, or {@code
* setup_intent} and {@code setup_intent_client_secret} when confirming a Setup
* Intent.
*/
public Builder setCustomMandateUrl(EmptyParam customMandateUrl) {
this.customMandateUrl = customMandateUrl;
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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit.MandateOptions#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit.MandateOptions#extraParams}
* for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Description of the mandate interval. Only required if 'payment_schedule' parameter
* is 'interval' or 'combined'.
*/
public Builder setIntervalDescription(String intervalDescription) {
this.intervalDescription = intervalDescription;
return this;
}
/** Payment schedule for the mandate. */
public Builder setPaymentSchedule(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit.MandateOptions
.PaymentSchedule
paymentSchedule) {
this.paymentSchedule = paymentSchedule;
return this;
}
/** Transaction type of the mandate. */
public Builder setTransactionType(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.AcssDebit.MandateOptions
.TransactionType
transactionType) {
this.transactionType = transactionType;
return this;
}
}
public enum PaymentSchedule implements ApiRequestParams.EnumParam {
@SerializedName("combined")
COMBINED("combined"),
@SerializedName("interval")
INTERVAL("interval"),
@SerializedName("sporadic")
SPORADIC("sporadic");
@Getter(onMethod_ = {@Override})
private final String value;
PaymentSchedule(String value) {
this.value = value;
}
}
public enum TransactionType implements ApiRequestParams.EnumParam {
@SerializedName("business")
BUSINESS("business"),
@SerializedName("personal")
PERSONAL("personal");
@Getter(onMethod_ = {@Override})
private final String value;
TransactionType(String value) {
this.value = value;
}
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none"),
@SerializedName("off_session")
OFF_SESSION("off_session"),
@SerializedName("on_session")
ON_SESSION("on_session");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
public enum VerificationMethod implements ApiRequestParams.EnumParam {
@SerializedName("automatic")
AUTOMATIC("automatic"),
@SerializedName("instant")
INSTANT("instant"),
@SerializedName("microdeposits")
MICRODEPOSITS("microdeposits");
@Getter(onMethod_ = {@Override})
private final String value;
VerificationMethod(String value) {
this.value = value;
}
}
}
@Getter
public static class AfterpayClearpay {
/**
* Controls when the funds are captured from the customer's account.
*
* If provided, this parameter overrides the behavior of the top-level capture_method
* for this payment method type when finalizing the payment with this payment method type.
*
*
If {@code capture_method} is already set on the PaymentIntent, providing an empty
* value for this parameter unsets the stored value for this payment method type.
*/
@SerializedName("capture_method")
CaptureMethod captureMethod;
/**
* 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;
/**
* An internal identifier or reference this payment corresponds to. The identifier is
* limited to 128 characters and may contain only letters, digits, underscores,
* backslashes and dashes.
*/
@SerializedName("reference")
String reference;
/**
* Indicates that you intend to make future payments with the payment method.
*
* Providing this parameter will attach the payment
* method to the order's Customer, if present, after the order's PaymentIntent is
* confirmed and any required actions from the user are complete. If no Customer was
* provided, the payment method can still be attached to a Customer
* after the transaction completes.
*
*
When processing card payments, Stripe also uses {@code setup_future_usage} to
* dynamically optimize your payment flow and comply with regional legislation and network
* rules, such as SCA.
*
*
If {@code setup_future_usage} is already set and you are performing a request using
* a publishable key, you may only update the value from {@code on_session} to {@code
* off_session}.
*/
@SerializedName("setup_future_usage")
SetupFutureUsage setupFutureUsage;
private AfterpayClearpay(
CaptureMethod captureMethod,
Map extraParams,
String reference,
SetupFutureUsage setupFutureUsage) {
this.captureMethod = captureMethod;
this.extraParams = extraParams;
this.reference = reference;
this.setupFutureUsage = setupFutureUsage;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private CaptureMethod captureMethod;
private Map extraParams;
private String reference;
private SetupFutureUsage setupFutureUsage;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.AfterpayClearpay
build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.AfterpayClearpay(
this.captureMethod, this.extraParams, this.reference, this.setupFutureUsage);
}
/**
* Controls when the funds are captured from the customer's account.
*
* If provided, this parameter overrides the behavior of the top-level capture_method
* for this payment method type when finalizing the payment with this payment method
* type.
*
*
If {@code capture_method} is already set on the PaymentIntent, providing an empty
* value for this parameter unsets the stored value for this payment method type.
*/
public Builder setCaptureMethod(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.AfterpayClearpay
.CaptureMethod
captureMethod) {
this.captureMethod = captureMethod;
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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.AfterpayClearpay#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.AfterpayClearpay#extraParams}
* for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* An internal identifier or reference this payment corresponds to. The identifier is
* limited to 128 characters and may contain only letters, digits, underscores,
* backslashes and dashes.
*/
public Builder setReference(String reference) {
this.reference = reference;
return this;
}
/**
* Indicates that you intend to make future payments with the payment method.
*
* Providing this parameter will attach the payment
* method to the order's Customer, if present, after the order's PaymentIntent is
* confirmed and any required actions from the user are complete. If no Customer was
* provided, the payment method can still be attached to a Customer
* after the transaction completes.
*
*
When processing card payments, Stripe also uses {@code setup_future_usage} to
* dynamically optimize your payment flow and comply with regional legislation and
* network rules, such as SCA.
*
*
If {@code setup_future_usage} is already set and you are performing a request
* using a publishable key, you may only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.AfterpayClearpay
.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
}
public enum CaptureMethod implements ApiRequestParams.EnumParam {
@SerializedName("automatic")
AUTOMATIC("automatic"),
@SerializedName("automatic_async")
AUTOMATIC_ASYNC("automatic_async"),
@SerializedName("manual")
MANUAL("manual");
@Getter(onMethod_ = {@Override})
private final String value;
CaptureMethod(String value) {
this.value = value;
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
@Getter
public static class Alipay {
/**
* 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;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to
* the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to a
* Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
@SerializedName("setup_future_usage")
ApiRequestParams.EnumParam setupFutureUsage;
private Alipay(
Map extraParams, ApiRequestParams.EnumParam setupFutureUsage) {
this.extraParams = extraParams;
this.setupFutureUsage = setupFutureUsage;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private ApiRequestParams.EnumParam setupFutureUsage;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.Alipay build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.Alipay(
this.extraParams, this.setupFutureUsage);
}
/**
* 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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Alipay#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Alipay#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Alipay.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
*
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(EmptyParam setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none"),
@SerializedName("off_session")
OFF_SESSION("off_session");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
@Getter
public static class Bancontact {
/**
* 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;
/**
* Preferred language of the Bancontact authorization page that the customer is redirected
* to.
*/
@SerializedName("preferred_language")
PreferredLanguage preferredLanguage;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to
* the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to a
* Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
@SerializedName("setup_future_usage")
ApiRequestParams.EnumParam setupFutureUsage;
private Bancontact(
Map extraParams,
PreferredLanguage preferredLanguage,
ApiRequestParams.EnumParam setupFutureUsage) {
this.extraParams = extraParams;
this.preferredLanguage = preferredLanguage;
this.setupFutureUsage = setupFutureUsage;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private PreferredLanguage preferredLanguage;
private ApiRequestParams.EnumParam setupFutureUsage;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.Bancontact build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.Bancontact(
this.extraParams, this.preferredLanguage, this.setupFutureUsage);
}
/**
* 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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Bancontact#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Bancontact#extraParams} for
* the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Preferred language of the Bancontact authorization page that the customer is
* redirected to.
*/
public Builder setPreferredLanguage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Bancontact.PreferredLanguage
preferredLanguage) {
this.preferredLanguage = preferredLanguage;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Bancontact.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
*
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(EmptyParam setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
}
public enum PreferredLanguage implements ApiRequestParams.EnumParam {
@SerializedName("de")
DE("de"),
@SerializedName("en")
EN("en"),
@SerializedName("fr")
FR("fr"),
@SerializedName("nl")
NL("nl");
@Getter(onMethod_ = {@Override})
private final String value;
PreferredLanguage(String value) {
this.value = value;
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none"),
@SerializedName("off_session")
OFF_SESSION("off_session");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
@Getter
public static class Card {
/** Controls when the funds will be captured from the customer's account. */
@SerializedName("capture_method")
CaptureMethod captureMethod;
/**
* 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;
/**
* Indicates that you intend to make future payments with the payment method.
*
* Providing this parameter will attach the payment
* method to the order's Customer, if present, after the order's PaymentIntent is
* confirmed and any required actions from the user are complete. If no Customer was
* provided, the payment method can still be attached to a Customer
* after the transaction completes.
*
*
When processing card payments, Stripe also uses {@code setup_future_usage} to
* dynamically optimize your payment flow and comply with regional legislation and network
* rules, such as SCA.
*
*
If {@code setup_future_usage} is already set and you are performing a request using
* a publishable key, you may only update the value from {@code on_session} to {@code
* off_session}.
*/
@SerializedName("setup_future_usage")
SetupFutureUsage setupFutureUsage;
private Card(
CaptureMethod captureMethod,
Map extraParams,
SetupFutureUsage setupFutureUsage) {
this.captureMethod = captureMethod;
this.extraParams = extraParams;
this.setupFutureUsage = setupFutureUsage;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private CaptureMethod captureMethod;
private Map extraParams;
private SetupFutureUsage setupFutureUsage;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.Card build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.Card(
this.captureMethod, this.extraParams, this.setupFutureUsage);
}
/** Controls when the funds will be captured from the customer's account. */
public Builder setCaptureMethod(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Card.CaptureMethod
captureMethod) {
this.captureMethod = captureMethod;
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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Card#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Card#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Indicates that you intend to make future payments with the payment method.
*
* Providing this parameter will attach the payment
* method to the order's Customer, if present, after the order's PaymentIntent is
* confirmed and any required actions from the user are complete. If no Customer was
* provided, the payment method can still be attached to a Customer
* after the transaction completes.
*
*
When processing card payments, Stripe also uses {@code setup_future_usage} to
* dynamically optimize your payment flow and comply with regional legislation and
* network rules, such as SCA.
*
*
If {@code setup_future_usage} is already set and you are performing a request
* using a publishable key, you may only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Card.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
}
public enum CaptureMethod implements ApiRequestParams.EnumParam {
@SerializedName("automatic")
AUTOMATIC("automatic"),
@SerializedName("automatic_async")
AUTOMATIC_ASYNC("automatic_async"),
@SerializedName("manual")
MANUAL("manual");
@Getter(onMethod_ = {@Override})
private final String value;
CaptureMethod(String value) {
this.value = value;
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none"),
@SerializedName("off_session")
OFF_SESSION("off_session"),
@SerializedName("on_session")
ON_SESSION("on_session");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
@Getter
public static class CustomerBalance {
/**
* Configuration for the bank transfer funding type, if the {@code funding_type} is set to
* {@code bank_transfer}.
*/
@SerializedName("bank_transfer")
BankTransfer bankTransfer;
/**
* 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 funding method type to be used when there are not enough funds in the customer
* balance. Permitted values include: {@code bank_transfer}.
*/
@SerializedName("funding_type")
FundingType fundingType;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to
* the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to a
* Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
@SerializedName("setup_future_usage")
SetupFutureUsage setupFutureUsage;
private CustomerBalance(
BankTransfer bankTransfer,
Map extraParams,
FundingType fundingType,
SetupFutureUsage setupFutureUsage) {
this.bankTransfer = bankTransfer;
this.extraParams = extraParams;
this.fundingType = fundingType;
this.setupFutureUsage = setupFutureUsage;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private BankTransfer bankTransfer;
private Map extraParams;
private FundingType fundingType;
private SetupFutureUsage setupFutureUsage;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance(
this.bankTransfer, this.extraParams, this.fundingType, this.setupFutureUsage);
}
/**
* Configuration for the bank transfer funding type, if the {@code funding_type} is set
* to {@code bank_transfer}.
*/
public Builder setBankTransfer(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance.BankTransfer
bankTransfer) {
this.bankTransfer = bankTransfer;
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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance#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 funding method type to be used when there are not enough funds in the customer
* balance. Permitted values include: {@code bank_transfer}.
*/
public Builder setFundingType(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance.FundingType
fundingType) {
this.fundingType = fundingType;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance
.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
}
@Getter
public static class BankTransfer {
/** Configuration for the eu_bank_transfer funding type. */
@SerializedName("eu_bank_transfer")
EuBankTransfer euBankTransfer;
/**
* 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;
/**
* List of address types that should be returned in the financial_addresses response. If
* not specified, all valid types will be returned.
*
* Permitted values include: {@code sort_code}, {@code zengin}, {@code iban}, or
* {@code spei}.
*/
@SerializedName("requested_address_types")
List<
OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance
.BankTransfer.RequestedAddressType>
requestedAddressTypes;
/**
* Required. The list of bank transfer types that this PaymentIntent is
* allowed to use for funding Permitted values include: {@code eu_bank_transfer}, {@code
* gb_bank_transfer}, {@code jp_bank_transfer}, {@code mx_bank_transfer}, or {@code
* us_bank_transfer}.
*/
@SerializedName("type")
Type type;
private BankTransfer(
EuBankTransfer euBankTransfer,
Map extraParams,
List<
OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance
.BankTransfer.RequestedAddressType>
requestedAddressTypes,
Type type) {
this.euBankTransfer = euBankTransfer;
this.extraParams = extraParams;
this.requestedAddressTypes = requestedAddressTypes;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private EuBankTransfer euBankTransfer;
private Map extraParams;
private List<
OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance
.BankTransfer.RequestedAddressType>
requestedAddressTypes;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance
.BankTransfer
build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance
.BankTransfer(
this.euBankTransfer, this.extraParams, this.requestedAddressTypes, this.type);
}
/** Configuration for the eu_bank_transfer funding type. */
public Builder setEuBankTransfer(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance
.BankTransfer.EuBankTransfer
euBankTransfer) {
this.euBankTransfer = euBankTransfer;
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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance.BankTransfer#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance.BankTransfer#extraParams}
* for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Add an element to `requestedAddressTypes` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original
* list. See {@link
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance.BankTransfer#requestedAddressTypes}
* for the field documentation.
*/
public Builder addRequestedAddressType(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance
.BankTransfer.RequestedAddressType
element) {
if (this.requestedAddressTypes == null) {
this.requestedAddressTypes = new ArrayList<>();
}
this.requestedAddressTypes.add(element);
return this;
}
/**
* Add all elements to `requestedAddressTypes` list. A list is initialized for the
* first `add/addAll` call, and subsequent calls adds additional elements to the
* original list. See {@link
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance.BankTransfer#requestedAddressTypes}
* for the field documentation.
*/
public Builder addAllRequestedAddressType(
List<
OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance
.BankTransfer.RequestedAddressType>
elements) {
if (this.requestedAddressTypes == null) {
this.requestedAddressTypes = new ArrayList<>();
}
this.requestedAddressTypes.addAll(elements);
return this;
}
/**
* Required. The list of bank transfer types that this PaymentIntent
* is allowed to use for funding Permitted values include: {@code eu_bank_transfer},
* {@code gb_bank_transfer}, {@code jp_bank_transfer}, {@code mx_bank_transfer}, or
* {@code us_bank_transfer}.
*/
public Builder setType(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance
.BankTransfer.Type
type) {
this.type = type;
return this;
}
}
@Getter
public static class EuBankTransfer {
/**
* Required. The desired country code of the bank account
* information. Permitted values include: {@code BE}, {@code DE}, {@code ES}, {@code
* FR}, {@code IE}, or {@code NL}.
*/
@SerializedName("country")
String country;
/**
* 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 EuBankTransfer(String country, Map extraParams) {
this.country = country;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String country;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance
.BankTransfer.EuBankTransfer
build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance
.BankTransfer.EuBankTransfer(this.country, this.extraParams);
}
/**
* Required. The desired country code of the bank account
* information. Permitted values include: {@code BE}, {@code DE}, {@code ES}, {@code
* FR}, {@code IE}, or {@code NL}.
*/
public Builder setCountry(String country) {
this.country = country;
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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance.BankTransfer.EuBankTransfer#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.CustomerBalance.BankTransfer.EuBankTransfer#extraParams}
* for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
}
}
public enum RequestedAddressType implements ApiRequestParams.EnumParam {
@SerializedName("aba")
ABA("aba"),
@SerializedName("iban")
IBAN("iban"),
@SerializedName("sepa")
SEPA("sepa"),
@SerializedName("sort_code")
SORT_CODE("sort_code"),
@SerializedName("spei")
SPEI("spei"),
@SerializedName("swift")
SWIFT("swift"),
@SerializedName("zengin")
ZENGIN("zengin");
@Getter(onMethod_ = {@Override})
private final String value;
RequestedAddressType(String value) {
this.value = value;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("eu_bank_transfer")
EU_BANK_TRANSFER("eu_bank_transfer"),
@SerializedName("gb_bank_transfer")
GB_BANK_TRANSFER("gb_bank_transfer"),
@SerializedName("jp_bank_transfer")
JP_BANK_TRANSFER("jp_bank_transfer"),
@SerializedName("mx_bank_transfer")
MX_BANK_TRANSFER("mx_bank_transfer"),
@SerializedName("us_bank_transfer")
US_BANK_TRANSFER("us_bank_transfer");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
public enum FundingType implements ApiRequestParams.EnumParam {
@SerializedName("bank_transfer")
BANK_TRANSFER("bank_transfer");
@Getter(onMethod_ = {@Override})
private final String value;
FundingType(String value) {
this.value = value;
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
@Getter
public static class Ideal {
/**
* 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;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to
* the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to a
* Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
@SerializedName("setup_future_usage")
ApiRequestParams.EnumParam setupFutureUsage;
private Ideal(
Map extraParams, ApiRequestParams.EnumParam setupFutureUsage) {
this.extraParams = extraParams;
this.setupFutureUsage = setupFutureUsage;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private ApiRequestParams.EnumParam setupFutureUsage;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.Ideal build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.Ideal(
this.extraParams, this.setupFutureUsage);
}
/**
* 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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Ideal#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Ideal#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Ideal.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
*
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(EmptyParam setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none"),
@SerializedName("off_session")
OFF_SESSION("off_session");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
@Getter
public static class Klarna {
/**
* Controls when the funds are captured from the customer's account.
*
*
If provided, this parameter overrides the behavior of the top-level capture_method
* for this payment method type when finalizing the payment with this payment method type.
*
*
If {@code capture_method} is already set on the PaymentIntent, providing an empty
* value for this parameter unsets the stored value for this payment method type.
*/
@SerializedName("capture_method")
ApiRequestParams.EnumParam captureMethod;
/**
* 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;
/**
* Preferred language of the Klarna authorization page that the customer is redirected to.
*/
@SerializedName("preferred_locale")
PreferredLocale preferredLocale;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to
* the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to a
* Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
@SerializedName("setup_future_usage")
SetupFutureUsage setupFutureUsage;
private Klarna(
ApiRequestParams.EnumParam captureMethod,
Map extraParams,
PreferredLocale preferredLocale,
SetupFutureUsage setupFutureUsage) {
this.captureMethod = captureMethod;
this.extraParams = extraParams;
this.preferredLocale = preferredLocale;
this.setupFutureUsage = setupFutureUsage;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private ApiRequestParams.EnumParam captureMethod;
private Map extraParams;
private PreferredLocale preferredLocale;
private SetupFutureUsage setupFutureUsage;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.Klarna build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.Klarna(
this.captureMethod,
this.extraParams,
this.preferredLocale,
this.setupFutureUsage);
}
/**
* Controls when the funds are captured from the customer's account.
*
* If provided, this parameter overrides the behavior of the top-level capture_method
* for this payment method type when finalizing the payment with this payment method
* type.
*
*
If {@code capture_method} is already set on the PaymentIntent, providing an empty
* value for this parameter unsets the stored value for this payment method type.
*/
public Builder setCaptureMethod(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Klarna.CaptureMethod
captureMethod) {
this.captureMethod = captureMethod;
return this;
}
/**
* Controls when the funds are captured from the customer's account.
*
*
If provided, this parameter overrides the behavior of the top-level capture_method
* for this payment method type when finalizing the payment with this payment method
* type.
*
*
If {@code capture_method} is already set on the PaymentIntent, providing an empty
* value for this parameter unsets the stored value for this payment method type.
*/
public Builder setCaptureMethod(EmptyParam captureMethod) {
this.captureMethod = captureMethod;
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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Klarna#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Klarna#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Preferred language of the Klarna authorization page that the customer is redirected
* to.
*/
public Builder setPreferredLocale(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Klarna.PreferredLocale
preferredLocale) {
this.preferredLocale = preferredLocale;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Klarna.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
}
public enum CaptureMethod implements ApiRequestParams.EnumParam {
@SerializedName("manual")
MANUAL("manual");
@Getter(onMethod_ = {@Override})
private final String value;
CaptureMethod(String value) {
this.value = value;
}
}
public enum PreferredLocale implements ApiRequestParams.EnumParam {
@SerializedName("cs-CZ")
CS_CZ("cs-CZ"),
@SerializedName("da-DK")
DA_DK("da-DK"),
@SerializedName("de-AT")
DE_AT("de-AT"),
@SerializedName("de-CH")
DE_CH("de-CH"),
@SerializedName("de-DE")
DE_DE("de-DE"),
@SerializedName("el-GR")
EL_GR("el-GR"),
@SerializedName("en-AT")
EN_AT("en-AT"),
@SerializedName("en-AU")
EN_AU("en-AU"),
@SerializedName("en-BE")
EN_BE("en-BE"),
@SerializedName("en-CA")
EN_CA("en-CA"),
@SerializedName("en-CH")
EN_CH("en-CH"),
@SerializedName("en-CZ")
EN_CZ("en-CZ"),
@SerializedName("en-DE")
EN_DE("en-DE"),
@SerializedName("en-DK")
EN_DK("en-DK"),
@SerializedName("en-ES")
EN_ES("en-ES"),
@SerializedName("en-FI")
EN_FI("en-FI"),
@SerializedName("en-FR")
EN_FR("en-FR"),
@SerializedName("en-GB")
EN_GB("en-GB"),
@SerializedName("en-GR")
EN_GR("en-GR"),
@SerializedName("en-IE")
EN_IE("en-IE"),
@SerializedName("en-IT")
EN_IT("en-IT"),
@SerializedName("en-NL")
EN_NL("en-NL"),
@SerializedName("en-NO")
EN_NO("en-NO"),
@SerializedName("en-NZ")
EN_NZ("en-NZ"),
@SerializedName("en-PL")
EN_PL("en-PL"),
@SerializedName("en-PT")
EN_PT("en-PT"),
@SerializedName("en-RO")
EN_RO("en-RO"),
@SerializedName("en-SE")
EN_SE("en-SE"),
@SerializedName("en-US")
EN_US("en-US"),
@SerializedName("es-ES")
ES_ES("es-ES"),
@SerializedName("es-US")
ES_US("es-US"),
@SerializedName("fi-FI")
FI_FI("fi-FI"),
@SerializedName("fr-BE")
FR_BE("fr-BE"),
@SerializedName("fr-CA")
FR_CA("fr-CA"),
@SerializedName("fr-CH")
FR_CH("fr-CH"),
@SerializedName("fr-FR")
FR_FR("fr-FR"),
@SerializedName("it-CH")
IT_CH("it-CH"),
@SerializedName("it-IT")
IT_IT("it-IT"),
@SerializedName("nb-NO")
NB_NO("nb-NO"),
@SerializedName("nl-BE")
NL_BE("nl-BE"),
@SerializedName("nl-NL")
NL_NL("nl-NL"),
@SerializedName("pl-PL")
PL_PL("pl-PL"),
@SerializedName("pt-PT")
PT_PT("pt-PT"),
@SerializedName("ro-RO")
RO_RO("ro-RO"),
@SerializedName("sv-FI")
SV_FI("sv-FI"),
@SerializedName("sv-SE")
SV_SE("sv-SE");
@Getter(onMethod_ = {@Override})
private final String value;
PreferredLocale(String value) {
this.value = value;
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
@Getter
public static class Link {
/**
* Controls when the funds are captured from the customer's account.
*
*
If provided, this parameter overrides the behavior of the top-level capture_method
* for this payment method type when finalizing the payment with this payment method type.
*
*
If {@code capture_method} is already set on the PaymentIntent, providing an empty
* value for this parameter unsets the stored value for this payment method type.
*/
@SerializedName("capture_method")
ApiRequestParams.EnumParam captureMethod;
/**
* 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;
/** [Deprecated] This is a legacy parameter that no longer has any function. */
@SerializedName("persistent_token")
@Deprecated
String persistentToken;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to
* the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to a
* Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
@SerializedName("setup_future_usage")
ApiRequestParams.EnumParam setupFutureUsage;
private Link(
ApiRequestParams.EnumParam captureMethod,
Map extraParams,
String persistentToken,
ApiRequestParams.EnumParam setupFutureUsage) {
this.captureMethod = captureMethod;
this.extraParams = extraParams;
this.persistentToken = persistentToken;
this.setupFutureUsage = setupFutureUsage;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private ApiRequestParams.EnumParam captureMethod;
private Map extraParams;
private String persistentToken;
private ApiRequestParams.EnumParam setupFutureUsage;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.Link build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.Link(
this.captureMethod,
this.extraParams,
this.persistentToken,
this.setupFutureUsage);
}
/**
* Controls when the funds are captured from the customer's account.
*
* If provided, this parameter overrides the behavior of the top-level capture_method
* for this payment method type when finalizing the payment with this payment method
* type.
*
*
If {@code capture_method} is already set on the PaymentIntent, providing an empty
* value for this parameter unsets the stored value for this payment method type.
*/
public Builder setCaptureMethod(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Link.CaptureMethod
captureMethod) {
this.captureMethod = captureMethod;
return this;
}
/**
* Controls when the funds are captured from the customer's account.
*
*
If provided, this parameter overrides the behavior of the top-level capture_method
* for this payment method type when finalizing the payment with this payment method
* type.
*
*
If {@code capture_method} is already set on the PaymentIntent, providing an empty
* value for this parameter unsets the stored value for this payment method type.
*/
public Builder setCaptureMethod(EmptyParam captureMethod) {
this.captureMethod = captureMethod;
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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Link#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Link#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** [Deprecated] This is a legacy parameter that no longer has any function. */
@Deprecated
public Builder setPersistentToken(String persistentToken) {
this.persistentToken = persistentToken;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Link.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
*
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(EmptyParam setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
}
public enum CaptureMethod implements ApiRequestParams.EnumParam {
@SerializedName("manual")
MANUAL("manual");
@Getter(onMethod_ = {@Override})
private final String value;
CaptureMethod(String value) {
this.value = value;
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none"),
@SerializedName("off_session")
OFF_SESSION("off_session");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
@Getter
public static class Oxxo {
/**
* The number of calendar days before an OXXO voucher expires. For example, if you create
* an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will
* expire on Wednesday at 23:59 America/Mexico_City time.
*/
@SerializedName("expires_after_days")
Long expiresAfterDays;
/**
* 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;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to
* the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to a
* Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
@SerializedName("setup_future_usage")
SetupFutureUsage setupFutureUsage;
private Oxxo(
Long expiresAfterDays,
Map extraParams,
SetupFutureUsage setupFutureUsage) {
this.expiresAfterDays = expiresAfterDays;
this.extraParams = extraParams;
this.setupFutureUsage = setupFutureUsage;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long expiresAfterDays;
private Map extraParams;
private SetupFutureUsage setupFutureUsage;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.Oxxo build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.Oxxo(
this.expiresAfterDays, this.extraParams, this.setupFutureUsage);
}
/**
* The number of calendar days before an OXXO voucher expires. For example, if you
* create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO
* invoice will expire on Wednesday at 23:59 America/Mexico_City time.
*/
public Builder setExpiresAfterDays(Long expiresAfterDays) {
this.expiresAfterDays = expiresAfterDays;
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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Oxxo#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Oxxo#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Oxxo.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
@Getter
public static class P24 {
/**
* 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;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to
* the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to a
* Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
@SerializedName("setup_future_usage")
SetupFutureUsage setupFutureUsage;
/** Confirm that the payer has accepted the P24 terms and conditions. */
@SerializedName("tos_shown_and_accepted")
Boolean tosShownAndAccepted;
private P24(
Map extraParams,
SetupFutureUsage setupFutureUsage,
Boolean tosShownAndAccepted) {
this.extraParams = extraParams;
this.setupFutureUsage = setupFutureUsage;
this.tosShownAndAccepted = tosShownAndAccepted;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private SetupFutureUsage setupFutureUsage;
private Boolean tosShownAndAccepted;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.P24 build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.P24(
this.extraParams, this.setupFutureUsage, this.tosShownAndAccepted);
}
/**
* 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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.P24#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.P24#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.P24.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
/** Confirm that the payer has accepted the P24 terms and conditions. */
public Builder setTosShownAndAccepted(Boolean tosShownAndAccepted) {
this.tosShownAndAccepted = tosShownAndAccepted;
return this;
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
@Getter
public static class Paypal {
/** Controls when the funds will be captured from the customer's account. */
@SerializedName("capture_method")
ApiRequestParams.EnumParam captureMethod;
/**
* 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;
/**
* Preferred
* locale of the PayPal checkout page that the customer is redirected to.
*/
@SerializedName("preferred_locale")
PreferredLocale preferredLocale;
/**
* A reference of the PayPal transaction visible to customer which is mapped to PayPal's
* invoice ID. This must be a globally unique ID if you have configured in your PayPal
* settings to block multiple payments per invoice ID.
*/
@SerializedName("reference")
String reference;
/**
* A reference of the PayPal transaction visible to customer which is mapped to PayPal's
* invoice ID. This must be a globally unique ID if you have configured in your PayPal
* settings to block multiple payments per invoice ID.
*/
@SerializedName("reference_id")
String referenceId;
/**
* The risk correlation ID for an on-session payment using a saved PayPal payment method.
*/
@SerializedName("risk_correlation_id")
String riskCorrelationId;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to
* the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to a
* Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
@SerializedName("setup_future_usage")
ApiRequestParams.EnumParam setupFutureUsage;
/**
* The Stripe connected account IDs of the sellers on the platform for this transaction
* (optional). Only allowed when separate charges
* and transfers are used.
*/
@SerializedName("subsellers")
List subsellers;
private Paypal(
ApiRequestParams.EnumParam captureMethod,
Map extraParams,
PreferredLocale preferredLocale,
String reference,
String referenceId,
String riskCorrelationId,
ApiRequestParams.EnumParam setupFutureUsage,
List subsellers) {
this.captureMethod = captureMethod;
this.extraParams = extraParams;
this.preferredLocale = preferredLocale;
this.reference = reference;
this.referenceId = referenceId;
this.riskCorrelationId = riskCorrelationId;
this.setupFutureUsage = setupFutureUsage;
this.subsellers = subsellers;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private ApiRequestParams.EnumParam captureMethod;
private Map extraParams;
private PreferredLocale preferredLocale;
private String reference;
private String referenceId;
private String riskCorrelationId;
private ApiRequestParams.EnumParam setupFutureUsage;
private List subsellers;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.Paypal build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.Paypal(
this.captureMethod,
this.extraParams,
this.preferredLocale,
this.reference,
this.referenceId,
this.riskCorrelationId,
this.setupFutureUsage,
this.subsellers);
}
/** Controls when the funds will be captured from the customer's account. */
public Builder setCaptureMethod(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Paypal.CaptureMethod
captureMethod) {
this.captureMethod = captureMethod;
return this;
}
/** Controls when the funds will be captured from the customer's account. */
public Builder setCaptureMethod(EmptyParam captureMethod) {
this.captureMethod = captureMethod;
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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Paypal#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Paypal#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Preferred
* locale of the PayPal checkout page that the customer is redirected to.
*/
public Builder setPreferredLocale(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Paypal.PreferredLocale
preferredLocale) {
this.preferredLocale = preferredLocale;
return this;
}
/**
* A reference of the PayPal transaction visible to customer which is mapped to PayPal's
* invoice ID. This must be a globally unique ID if you have configured in your PayPal
* settings to block multiple payments per invoice ID.
*/
public Builder setReference(String reference) {
this.reference = reference;
return this;
}
/**
* A reference of the PayPal transaction visible to customer which is mapped to PayPal's
* invoice ID. This must be a globally unique ID if you have configured in your PayPal
* settings to block multiple payments per invoice ID.
*/
public Builder setReferenceId(String referenceId) {
this.referenceId = referenceId;
return this;
}
/**
* The risk correlation ID for an on-session payment using a saved PayPal payment
* method.
*/
public Builder setRiskCorrelationId(String riskCorrelationId) {
this.riskCorrelationId = riskCorrelationId;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Paypal.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
*
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(EmptyParam setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
/**
* Add an element to `subsellers` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Paypal#subsellers} for the
* field documentation.
*/
public Builder addSubseller(String element) {
if (this.subsellers == null) {
this.subsellers = new ArrayList<>();
}
this.subsellers.add(element);
return this;
}
/**
* Add all elements to `subsellers` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original
* list. See {@link
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Paypal#subsellers} for the
* field documentation.
*/
public Builder addAllSubseller(List elements) {
if (this.subsellers == null) {
this.subsellers = new ArrayList<>();
}
this.subsellers.addAll(elements);
return this;
}
}
public enum CaptureMethod implements ApiRequestParams.EnumParam {
@SerializedName("manual")
MANUAL("manual");
@Getter(onMethod_ = {@Override})
private final String value;
CaptureMethod(String value) {
this.value = value;
}
}
public enum PreferredLocale implements ApiRequestParams.EnumParam {
@SerializedName("cs-CZ")
CS_CZ("cs-CZ"),
@SerializedName("da-DK")
DA_DK("da-DK"),
@SerializedName("de-AT")
DE_AT("de-AT"),
@SerializedName("de-DE")
DE_DE("de-DE"),
@SerializedName("de-LU")
DE_LU("de-LU"),
@SerializedName("el-GR")
EL_GR("el-GR"),
@SerializedName("en-GB")
EN_GB("en-GB"),
@SerializedName("en-US")
EN_US("en-US"),
@SerializedName("es-ES")
ES_ES("es-ES"),
@SerializedName("fi-FI")
FI_FI("fi-FI"),
@SerializedName("fr-BE")
FR_BE("fr-BE"),
@SerializedName("fr-FR")
FR_FR("fr-FR"),
@SerializedName("fr-LU")
FR_LU("fr-LU"),
@SerializedName("hu-HU")
HU_HU("hu-HU"),
@SerializedName("it-IT")
IT_IT("it-IT"),
@SerializedName("nl-BE")
NL_BE("nl-BE"),
@SerializedName("nl-NL")
NL_NL("nl-NL"),
@SerializedName("pl-PL")
PL_PL("pl-PL"),
@SerializedName("pt-PT")
PT_PT("pt-PT"),
@SerializedName("sk-SK")
SK_SK("sk-SK"),
@SerializedName("sv-SE")
SV_SE("sv-SE");
@Getter(onMethod_ = {@Override})
private final String value;
PreferredLocale(String value) {
this.value = value;
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none"),
@SerializedName("off_session")
OFF_SESSION("off_session");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
@Getter
public static class SepaDebit {
/**
* 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;
/** Additional fields for Mandate creation. */
@SerializedName("mandate_options")
MandateOptions mandateOptions;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to
* the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to a
* Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
@SerializedName("setup_future_usage")
ApiRequestParams.EnumParam setupFutureUsage;
private SepaDebit(
Map extraParams,
MandateOptions mandateOptions,
ApiRequestParams.EnumParam setupFutureUsage) {
this.extraParams = extraParams;
this.mandateOptions = mandateOptions;
this.setupFutureUsage = setupFutureUsage;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private MandateOptions mandateOptions;
private ApiRequestParams.EnumParam setupFutureUsage;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.SepaDebit build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.SepaDebit(
this.extraParams, this.mandateOptions, this.setupFutureUsage);
}
/**
* 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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.SepaDebit#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.SepaDebit#extraParams} for
* the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Additional fields for Mandate creation. */
public Builder setMandateOptions(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.SepaDebit.MandateOptions
mandateOptions) {
this.mandateOptions = mandateOptions;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.SepaDebit.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
*
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(EmptyParam setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
}
@Getter
public static class MandateOptions {
/**
* 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 MandateOptions(Map extraParams) {
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.SepaDebit
.MandateOptions
build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.SepaDebit
.MandateOptions(this.extraParams);
}
/**
* 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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.SepaDebit.MandateOptions#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.SepaDebit.MandateOptions#extraParams}
* for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none"),
@SerializedName("off_session")
OFF_SESSION("off_session"),
@SerializedName("on_session")
ON_SESSION("on_session");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
@Getter
public static class Sofort {
/**
* 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;
/** Language shown to the payer on redirect. */
@SerializedName("preferred_language")
ApiRequestParams.EnumParam preferredLanguage;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to
* the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to a
* Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
@SerializedName("setup_future_usage")
ApiRequestParams.EnumParam setupFutureUsage;
private Sofort(
Map extraParams,
ApiRequestParams.EnumParam preferredLanguage,
ApiRequestParams.EnumParam setupFutureUsage) {
this.extraParams = extraParams;
this.preferredLanguage = preferredLanguage;
this.setupFutureUsage = setupFutureUsage;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private ApiRequestParams.EnumParam preferredLanguage;
private ApiRequestParams.EnumParam setupFutureUsage;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.Sofort build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.Sofort(
this.extraParams, this.preferredLanguage, this.setupFutureUsage);
}
/**
* 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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Sofort#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.Sofort#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Language shown to the payer on redirect. */
public Builder setPreferredLanguage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Sofort.PreferredLanguage
preferredLanguage) {
this.preferredLanguage = preferredLanguage;
return this;
}
/** Language shown to the payer on redirect. */
public Builder setPreferredLanguage(EmptyParam preferredLanguage) {
this.preferredLanguage = preferredLanguage;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.Sofort.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
*
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(EmptyParam setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
}
public enum PreferredLanguage implements ApiRequestParams.EnumParam {
@SerializedName("de")
DE("de"),
@SerializedName("en")
EN("en"),
@SerializedName("es")
ES("es"),
@SerializedName("fr")
FR("fr"),
@SerializedName("it")
IT("it"),
@SerializedName("nl")
NL("nl"),
@SerializedName("pl")
PL("pl");
@Getter(onMethod_ = {@Override})
private final String value;
PreferredLanguage(String value) {
this.value = value;
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none"),
@SerializedName("off_session")
OFF_SESSION("off_session");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
@Getter
public static class WechatPay {
/** The app ID registered with WeChat Pay. Only required when client is ios or android. */
@SerializedName("app_id")
String appId;
/** Required. The client type that the end customer will pay from */
@SerializedName("client")
Client client;
/**
* 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;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to
* the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to a
* Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
@SerializedName("setup_future_usage")
SetupFutureUsage setupFutureUsage;
private WechatPay(
String appId,
Client client,
Map extraParams,
SetupFutureUsage setupFutureUsage) {
this.appId = appId;
this.client = client;
this.extraParams = extraParams;
this.setupFutureUsage = setupFutureUsage;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String appId;
private Client client;
private Map extraParams;
private SetupFutureUsage setupFutureUsage;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.PaymentMethodOptions.WechatPay build() {
return new OrderCreateParams.Payment.Settings.PaymentMethodOptions.WechatPay(
this.appId, this.client, this.extraParams, this.setupFutureUsage);
}
/**
* The app ID registered with WeChat Pay. Only required when client is ios or android.
*/
public Builder setAppId(String appId) {
this.appId = appId;
return this;
}
/** Required. The client type that the end customer will pay from */
public Builder setClient(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.WechatPay.Client client) {
this.client = client;
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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.WechatPay#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
* OrderCreateParams.Payment.Settings.PaymentMethodOptions.WechatPay#extraParams} for
* the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment
* method.
*
* If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method
* to the Customer after the PaymentIntent is confirmed and the customer completes any
* required actions. If you don't provide a Customer, you can still attach the payment method to
* a Customer after the transaction completes.
*
*
If the payment method is {@code card_present} and isn't a digital wallet, Stripe
* creates and attaches a generated_card
* payment method representing the card to the Customer instead.
*
*
When processing card payments, Stripe uses {@code setup_future_usage} to help you
* comply with regional legislation and network rules, such as SCA.
*
*
If you've already set {@code setup_future_usage} and you're performing a request
* using a publishable key, you can only update the value from {@code on_session} to
* {@code off_session}.
*/
public Builder setSetupFutureUsage(
OrderCreateParams.Payment.Settings.PaymentMethodOptions.WechatPay.SetupFutureUsage
setupFutureUsage) {
this.setupFutureUsage = setupFutureUsage;
return this;
}
}
public enum Client implements ApiRequestParams.EnumParam {
@SerializedName("android")
ANDROID("android"),
@SerializedName("ios")
IOS("ios"),
@SerializedName("web")
WEB("web");
@Getter(onMethod_ = {@Override})
private final String value;
Client(String value) {
this.value = value;
}
}
public enum SetupFutureUsage implements ApiRequestParams.EnumParam {
@SerializedName("none")
NONE("none");
@Getter(onMethod_ = {@Override})
private final String value;
SetupFutureUsage(String value) {
this.value = value;
}
}
}
}
@Getter
public static class TransferData {
/**
* The amount that will be transferred automatically when the order is paid. If no amount is
* set, the full amount is transferred. There cannot be any line items with recurring prices
* when using this field.
*/
@SerializedName("amount")
Long amount;
/** Required. ID of the Connected account receiving the transfer. */
@SerializedName("destination")
String destination;
/**
* 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, String destination, Map extraParams) {
this.amount = amount;
this.destination = destination;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private String destination;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.Payment.Settings.TransferData build() {
return new OrderCreateParams.Payment.Settings.TransferData(
this.amount, this.destination, this.extraParams);
}
/**
* The amount that will be transferred automatically when the order is paid. If no amount
* is set, the full amount is transferred. There cannot be any line items with recurring
* prices when using this field.
*/
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/** Required. ID of the Connected account receiving the transfer. */
public Builder setDestination(String destination) {
this.destination = destination;
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 OrderCreateParams.Payment.Settings.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 OrderCreateParams.Payment.Settings.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;
}
}
}
public enum PaymentMethodType implements ApiRequestParams.EnumParam {
@SerializedName("acss_debit")
ACSS_DEBIT("acss_debit"),
@SerializedName("afterpay_clearpay")
AFTERPAY_CLEARPAY("afterpay_clearpay"),
@SerializedName("alipay")
ALIPAY("alipay"),
@SerializedName("au_becs_debit")
AU_BECS_DEBIT("au_becs_debit"),
@SerializedName("bacs_debit")
BACS_DEBIT("bacs_debit"),
@SerializedName("bancontact")
BANCONTACT("bancontact"),
@SerializedName("card")
CARD("card"),
@SerializedName("customer_balance")
CUSTOMER_BALANCE("customer_balance"),
@SerializedName("eps")
EPS("eps"),
@SerializedName("fpx")
FPX("fpx"),
@SerializedName("giropay")
GIROPAY("giropay"),
@SerializedName("grabpay")
GRABPAY("grabpay"),
@SerializedName("ideal")
IDEAL("ideal"),
@SerializedName("klarna")
KLARNA("klarna"),
@SerializedName("link")
LINK("link"),
@SerializedName("oxxo")
OXXO("oxxo"),
@SerializedName("p24")
P24("p24"),
@SerializedName("paypal")
PAYPAL("paypal"),
@SerializedName("sepa_debit")
SEPA_DEBIT("sepa_debit"),
@SerializedName("sofort")
SOFORT("sofort"),
@SerializedName("wechat_pay")
WECHAT_PAY("wechat_pay");
@Getter(onMethod_ = {@Override})
private final String value;
PaymentMethodType(String value) {
this.value = value;
}
}
}
}
@Getter
public static class ShippingCost {
/**
* 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 ID of the shipping rate to use for this order. */
@SerializedName("shipping_rate")
String shippingRate;
/** Parameters to create a new ad-hoc shipping rate for this order. */
@SerializedName("shipping_rate_data")
ShippingRateData shippingRateData;
private ShippingCost(
Map extraParams, String shippingRate, ShippingRateData shippingRateData) {
this.extraParams = extraParams;
this.shippingRate = shippingRate;
this.shippingRateData = shippingRateData;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private String shippingRate;
private ShippingRateData shippingRateData;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.ShippingCost build() {
return new OrderCreateParams.ShippingCost(
this.extraParams, this.shippingRate, this.shippingRateData);
}
/**
* 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
* OrderCreateParams.ShippingCost#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 OrderCreateParams.ShippingCost#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 ID of the shipping rate to use for this order. */
public Builder setShippingRate(String shippingRate) {
this.shippingRate = shippingRate;
return this;
}
/** Parameters to create a new ad-hoc shipping rate for this order. */
public Builder setShippingRateData(
OrderCreateParams.ShippingCost.ShippingRateData shippingRateData) {
this.shippingRateData = shippingRateData;
return this;
}
}
@Getter
public static class ShippingRateData {
/**
* The estimated range for how long shipping will take, meant to be displayable to the
* customer. This will appear on CheckoutSessions.
*/
@SerializedName("delivery_estimate")
DeliveryEstimate deliveryEstimate;
/**
* Required. The name of the shipping rate, meant to be displayable to the
* customer. This will appear on CheckoutSessions.
*/
@SerializedName("display_name")
String displayName;
/**
* 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;
/**
* Describes a fixed amount to charge for shipping. Must be present if type is {@code
* fixed_amount}.
*/
@SerializedName("fixed_amount")
FixedAmount fixedAmount;
/**
* 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")
Map metadata;
/**
* Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of
* {@code inclusive}, {@code exclusive}, or {@code unspecified}.
*/
@SerializedName("tax_behavior")
TaxBehavior taxBehavior;
/**
* A tax code ID. The Shipping tax
* code is {@code txcd_92010001}.
*/
@SerializedName("tax_code")
String taxCode;
/** The type of calculation to use on the shipping rate. */
@SerializedName("type")
Type type;
private ShippingRateData(
DeliveryEstimate deliveryEstimate,
String displayName,
Map extraParams,
FixedAmount fixedAmount,
Map metadata,
TaxBehavior taxBehavior,
String taxCode,
Type type) {
this.deliveryEstimate = deliveryEstimate;
this.displayName = displayName;
this.extraParams = extraParams;
this.fixedAmount = fixedAmount;
this.metadata = metadata;
this.taxBehavior = taxBehavior;
this.taxCode = taxCode;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private DeliveryEstimate deliveryEstimate;
private String displayName;
private Map extraParams;
private FixedAmount fixedAmount;
private Map metadata;
private TaxBehavior taxBehavior;
private String taxCode;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.ShippingCost.ShippingRateData build() {
return new OrderCreateParams.ShippingCost.ShippingRateData(
this.deliveryEstimate,
this.displayName,
this.extraParams,
this.fixedAmount,
this.metadata,
this.taxBehavior,
this.taxCode,
this.type);
}
/**
* The estimated range for how long shipping will take, meant to be displayable to the
* customer. This will appear on CheckoutSessions.
*/
public Builder setDeliveryEstimate(
OrderCreateParams.ShippingCost.ShippingRateData.DeliveryEstimate deliveryEstimate) {
this.deliveryEstimate = deliveryEstimate;
return this;
}
/**
* Required. The name of the shipping rate, meant to be displayable to the
* customer. This will appear on CheckoutSessions.
*/
public Builder setDisplayName(String displayName) {
this.displayName = displayName;
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 OrderCreateParams.ShippingCost.ShippingRateData#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 OrderCreateParams.ShippingCost.ShippingRateData#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Describes a fixed amount to charge for shipping. Must be present if type is {@code
* fixed_amount}.
*/
public Builder setFixedAmount(
OrderCreateParams.ShippingCost.ShippingRateData.FixedAmount fixedAmount) {
this.fixedAmount = fixedAmount;
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
* OrderCreateParams.ShippingCost.ShippingRateData#metadata} for the field documentation.
*/
public Builder putMetadata(String key, String value) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
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 OrderCreateParams.ShippingCost.ShippingRateData#metadata} for the field
* documentation.
*/
public Builder putAllMetadata(Map map) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.putAll(map);
return this;
}
/**
* Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of
* {@code inclusive}, {@code exclusive}, or {@code unspecified}.
*/
public Builder setTaxBehavior(
OrderCreateParams.ShippingCost.ShippingRateData.TaxBehavior taxBehavior) {
this.taxBehavior = taxBehavior;
return this;
}
/**
* A tax code ID. The Shipping tax
* code is {@code txcd_92010001}.
*/
public Builder setTaxCode(String taxCode) {
this.taxCode = taxCode;
return this;
}
/** The type of calculation to use on the shipping rate. */
public Builder setType(OrderCreateParams.ShippingCost.ShippingRateData.Type type) {
this.type = type;
return this;
}
}
@Getter
public static class DeliveryEstimate {
/**
* 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 upper bound of the estimated range. If empty, represents no upper bound i.e.,
* infinite.
*/
@SerializedName("maximum")
Maximum maximum;
/** The lower bound of the estimated range. If empty, represents no lower bound. */
@SerializedName("minimum")
Minimum minimum;
private DeliveryEstimate(
Map extraParams, Maximum maximum, Minimum minimum) {
this.extraParams = extraParams;
this.maximum = maximum;
this.minimum = minimum;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private Maximum maximum;
private Minimum minimum;
/** Finalize and obtain parameter instance from this builder. */
public OrderCreateParams.ShippingCost.ShippingRateData.DeliveryEstimate build() {
return new OrderCreateParams.ShippingCost.ShippingRateData.DeliveryEstimate(
this.extraParams, this.maximum, this.minimum);
}
/**
* 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
* OrderCreateParams.ShippingCost.ShippingRateData.DeliveryEstimate#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
* OrderCreateParams.ShippingCost.ShippingRateData.DeliveryEstimate#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 upper bound of the estimated range. If empty, represents no upper bound i.e.,
* infinite.
*/
public Builder setMaximum(
OrderCreateParams.ShippingCost.ShippingRateData.DeliveryEstimate.Maximum maximum) {
this.maximum = maximum;
return this;
}
/** The lower bound of the estimated range. If empty, represents no lower bound. */
public Builder setMinimum(
OrderCreateParams.ShippingCost.ShippingRateData.DeliveryEstimate.Minimum minimum) {
this.minimum = minimum;
return this;
}
}
@Getter
public static class Maximum {
/**
* 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