com.stripe.param.AccountCreateParams Maven / Gradle / Ivy
// Generated by delombok at Mon May 18 17:31:34 PDT 2020
package com.stripe.param;
import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import com.stripe.net.ApiRequestParams.EnumParam;
import com.stripe.param.common.EmptyParam;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class AccountCreateParams extends ApiRequestParams {
/**
* An account token, used to
* securely provide details to the account.
*/
@SerializedName("account_token")
String accountToken;
/**
* Business information about the account.
*/
@SerializedName("business_profile")
BusinessProfile businessProfile;
/**
* The business type.
*/
@SerializedName("business_type")
Object businessType;
/**
* Information about the company or business. This field is null unless {@code business_type} is
* set to {@code company}, {@code government_entity}, or {@code non_profit}.
*/
@SerializedName("company")
Company company;
/**
* The country in which the account holder resides, or in which the business is legally
* established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the
* United States and the business for which you're creating an account is legally represented in
* Canada, you would use {@code CA} as the country for the account being created.
*/
@SerializedName("country")
String country;
/**
* Three-letter ISO currency code representing the default currency for the account. This must be
* a currency that Stripe supports in the account's
* country.
*/
@SerializedName("default_currency")
String defaultCurrency;
/**
* The email address of the account holder. For Custom accounts, this is only to make the account
* easier to identify to you: Stripe will never directly email your users.
*/
@SerializedName("email")
String email;
/**
* Specifies which fields in the response should be expanded.
*/
@SerializedName("expand")
List expand;
/**
* A card or bank account to attach to the account. You can provide either a token, like the ones
* returned by Stripe.js, or a dictionary, as
* documented in the {@code external_account} parameter for bank account creation.
* <br><br>By default, providing an external account sets it as the new default
* external account for its currency, and deletes the old default if one exists. To add additional
* external accounts without replacing the existing default for the currency, use the bank account
* or card creation API.
*/
@SerializedName("external_account")
String externalAccount;
/**
* 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;
/**
* Information about the person represented by the account. This field is null unless {@code
* business_type} is set to {@code individual}.
*/
@SerializedName("individual")
Individual individual;
/**
* 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;
/**
* The set of capabilities you want to unlock for this account. Each capability will be inactive
* until you have provided its specific requirements and Stripe has verified them. An account may
* have some of its requested capabilities be active and some be inactive.
*/
@SerializedName("requested_capabilities")
List requestedCapabilities;
/**
* Options for customizing how the account functions within Stripe.
*/
@SerializedName("settings")
Settings settings;
/**
* Details on the account's acceptance of the Stripe Services
* Agreement.
*/
@SerializedName("tos_acceptance")
TosAcceptance tosAcceptance;
/**
* The type of Stripe account to create. Currently must be {@code custom}, as only Custom accounts may be created via
* the API.
*/
@SerializedName("type")
Type type;
private AccountCreateParams(String accountToken, BusinessProfile businessProfile, Object businessType, Company company, String country, String defaultCurrency, String email, List expand, String externalAccount, Map extraParams, Individual individual, Object metadata, List requestedCapabilities, Settings settings, TosAcceptance tosAcceptance, Type type) {
this.accountToken = accountToken;
this.businessProfile = businessProfile;
this.businessType = businessType;
this.company = company;
this.country = country;
this.defaultCurrency = defaultCurrency;
this.email = email;
this.expand = expand;
this.externalAccount = externalAccount;
this.extraParams = extraParams;
this.individual = individual;
this.metadata = metadata;
this.requestedCapabilities = requestedCapabilities;
this.settings = settings;
this.tosAcceptance = tosAcceptance;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String accountToken;
private BusinessProfile businessProfile;
private Object businessType;
private Company company;
private String country;
private String defaultCurrency;
private String email;
private List expand;
private String externalAccount;
private Map extraParams;
private Individual individual;
private Object metadata;
private List requestedCapabilities;
private Settings settings;
private TosAcceptance tosAcceptance;
private Type type;
/**
* Finalize and obtain parameter instance from this builder.
*/
public AccountCreateParams build() {
return new AccountCreateParams(this.accountToken, this.businessProfile, this.businessType, this.company, this.country, this.defaultCurrency, this.email, this.expand, this.externalAccount, this.extraParams, this.individual, this.metadata, this.requestedCapabilities, this.settings, this.tosAcceptance, this.type);
}
/**
* An account token, used to
* securely provide details to the account.
*/
public Builder setAccountToken(String accountToken) {
this.accountToken = accountToken;
return this;
}
/**
* Business information about the account.
*/
public Builder setBusinessProfile(BusinessProfile businessProfile) {
this.businessProfile = businessProfile;
return this;
}
/**
* The business type.
*/
public Builder setBusinessType(BusinessType businessType) {
this.businessType = businessType;
return this;
}
/**
* The business type.
*/
public Builder setBusinessType(String businessType) {
this.businessType = businessType;
return this;
}
/**
* Information about the company or business. This field is null unless {@code business_type} is
* set to {@code company}, {@code government_entity}, or {@code non_profit}.
*/
public Builder setCompany(Company company) {
this.company = company;
return this;
}
/**
* The country in which the account holder resides, or in which the business is legally
* established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in
* the United States and the business for which you're creating an account is legally
* represented in Canada, you would use {@code CA} as the country for the account being created.
*/
public Builder setCountry(String country) {
this.country = country;
return this;
}
/**
* Three-letter ISO currency code representing the default currency for the account. This must
* be a currency that Stripe supports in the account's
* country.
*/
public Builder setDefaultCurrency(String defaultCurrency) {
this.defaultCurrency = defaultCurrency;
return this;
}
/**
* The email address of the account holder. For Custom accounts, this is only to make the
* account easier to identify to you: Stripe will never directly email your users.
*/
public Builder setEmail(String email) {
this.email = email;
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
* AccountCreateParams#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
* AccountCreateParams#expand} for the field documentation.
*/
public Builder addAllExpand(List elements) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.addAll(elements);
return this;
}
/**
* A card or bank account to attach to the account. You can provide either a token, like the
* ones returned by Stripe.js, or a dictionary,
* as documented in the {@code external_account} parameter for bank account creation.
* <br><br>By default, providing an external account sets it as the new default
* external account for its currency, and deletes the old default if one exists. To add
* additional external accounts without replacing the existing default for the currency, use the
* bank account or card creation API.
*/
public Builder setExternalAccount(String externalAccount) {
this.externalAccount = externalAccount;
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
* AccountCreateParams#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 AccountCreateParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Information about the person represented by the account. This field is null unless {@code
* business_type} is set to {@code individual}.
*/
public Builder setIndividual(Individual individual) {
this.individual = individual;
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
* AccountCreateParams#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 AccountCreateParams#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;
}
/**
* Add an element to `requestedCapabilities` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list. See
* {@link AccountCreateParams#requestedCapabilities} for the field documentation.
*/
public Builder addRequestedCapability(RequestedCapability element) {
if (this.requestedCapabilities == null) {
this.requestedCapabilities = new ArrayList<>();
}
this.requestedCapabilities.add(element);
return this;
}
/**
* Add all elements to `requestedCapabilities` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list. See
* {@link AccountCreateParams#requestedCapabilities} for the field documentation.
*/
public Builder addAllRequestedCapability(List elements) {
if (this.requestedCapabilities == null) {
this.requestedCapabilities = new ArrayList<>();
}
this.requestedCapabilities.addAll(elements);
return this;
}
/**
* Options for customizing how the account functions within Stripe.
*/
public Builder setSettings(Settings settings) {
this.settings = settings;
return this;
}
/**
* Details on the account's acceptance of the Stripe Services
* Agreement.
*/
public Builder setTosAcceptance(TosAcceptance tosAcceptance) {
this.tosAcceptance = tosAcceptance;
return this;
}
/**
* The type of Stripe account to create. Currently must be {@code custom}, as only Custom accounts may be created via
* the API.
*/
public Builder setType(Type type) {
this.type = type;
return this;
}
}
public static class BusinessProfile {
/**
* 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 merchant category code for the
* account. MCCs are used to classify businesses based on the goods or services they
* provide.
*/
@SerializedName("mcc")
String mcc;
/**
* The customer-facing business name.
*/
@SerializedName("name")
String name;
/**
* Internal-only description of the product sold by, or service provided by, the business. Used
* by Stripe for risk and underwriting purposes.
*/
@SerializedName("product_description")
String productDescription;
/**
* A publicly available mailing address for sending support issues to.
*/
@SerializedName("support_address")
SupportAddress supportAddress;
/**
* A publicly available email address for sending support issues to.
*/
@SerializedName("support_email")
String supportEmail;
/**
* A publicly available phone number to call with support issues.
*/
@SerializedName("support_phone")
String supportPhone;
/**
* A publicly available website for handling support issues.
*/
@SerializedName("support_url")
String supportUrl;
/**
* The business's publicly available website.
*/
@SerializedName("url")
String url;
private BusinessProfile(Map extraParams, String mcc, String name, String productDescription, SupportAddress supportAddress, String supportEmail, String supportPhone, String supportUrl, String url) {
this.extraParams = extraParams;
this.mcc = mcc;
this.name = name;
this.productDescription = productDescription;
this.supportAddress = supportAddress;
this.supportEmail = supportEmail;
this.supportPhone = supportPhone;
this.supportUrl = supportUrl;
this.url = url;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private String mcc;
private String name;
private String productDescription;
private SupportAddress supportAddress;
private String supportEmail;
private String supportPhone;
private String supportUrl;
private String url;
/**
* Finalize and obtain parameter instance from this builder.
*/
public BusinessProfile build() {
return new BusinessProfile(this.extraParams, this.mcc, this.name, this.productDescription, this.supportAddress, this.supportEmail, this.supportPhone, this.supportUrl, this.url);
}
/**
* 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
* AccountCreateParams.BusinessProfile#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 AccountCreateParams.BusinessProfile#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 merchant category code for the
* account. MCCs are used to classify businesses based on the goods or services they
* provide.
*/
public Builder setMcc(String mcc) {
this.mcc = mcc;
return this;
}
/**
* The customer-facing business name.
*/
public Builder setName(String name) {
this.name = name;
return this;
}
/**
* Internal-only description of the product sold by, or service provided by, the business.
* Used by Stripe for risk and underwriting purposes.
*/
public Builder setProductDescription(String productDescription) {
this.productDescription = productDescription;
return this;
}
/**
* A publicly available mailing address for sending support issues to.
*/
public Builder setSupportAddress(SupportAddress supportAddress) {
this.supportAddress = supportAddress;
return this;
}
/**
* A publicly available email address for sending support issues to.
*/
public Builder setSupportEmail(String supportEmail) {
this.supportEmail = supportEmail;
return this;
}
/**
* A publicly available phone number to call with support issues.
*/
public Builder setSupportPhone(String supportPhone) {
this.supportPhone = supportPhone;
return this;
}
/**
* A publicly available website for handling support issues.
*/
public Builder setSupportUrl(String supportUrl) {
this.supportUrl = supportUrl;
return this;
}
/**
* The business's publicly available website.
*/
public Builder setUrl(String url) {
this.url = url;
return this;
}
}
public static class SupportAddress {
/** 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, county, province, or region. */
@SerializedName("state")
String state;
private SupportAddress(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 SupportAddress build() {
return new SupportAddress(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 AccountCreateParams.BusinessProfile.SupportAddress#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 AccountCreateParams.BusinessProfile.SupportAddress#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;
}
public Builder setState(String state) {
this.state = state;
return this;
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCity() {
return this.city;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCountry() {
return this.country;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine1() {
return this.line1;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine2() {
return this.line2;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getPostalCode() {
return this.postalCode;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getState() {
return this.state;
}
}
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* The merchant category code for the
* account. MCCs are used to classify businesses based on the goods or services they
* provide.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getMcc() {
return this.mcc;
}
/**
* The customer-facing business name.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getName() {
return this.name;
}
/**
* Internal-only description of the product sold by, or service provided by, the business. Used
* by Stripe for risk and underwriting purposes.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getProductDescription() {
return this.productDescription;
}
/**
* A publicly available mailing address for sending support issues to.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SupportAddress getSupportAddress() {
return this.supportAddress;
}
/**
* A publicly available email address for sending support issues to.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getSupportEmail() {
return this.supportEmail;
}
/**
* A publicly available phone number to call with support issues.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getSupportPhone() {
return this.supportPhone;
}
/**
* A publicly available website for handling support issues.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getSupportUrl() {
return this.supportUrl;
}
/**
* The business's publicly available website.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getUrl() {
return this.url;
}
}
/**
* State, county, province, or region.
*/
public static class Company {
/**
* The company's primary address.
*/
@SerializedName("address")
Address address;
/**
* The Kana variation of the company's primary address (Japan only).
*/
@SerializedName("address_kana")
AddressKana addressKana;
/**
* The Kanji variation of the company's primary address (Japan only).
*/
@SerializedName("address_kanji")
AddressKanji addressKanji;
/**
* Whether the company's directors have been provided. Set this Boolean to {@code true} after
* creating all the company's directors with the
* Persons API for accounts with a {@code relationship.director} requirement. This value is
* not automatically set to {@code true} after creating directors, so it needs to be updated to
* indicate all directors have been provided.
*/
@SerializedName("directors_provided")
Boolean directorsProvided;
/**
* Whether the company's executives have been provided. Set this Boolean to {@code true} after
* creating all the company's executives with the
* Persons API for accounts with a {@code relationship.executive} requirement.
*/
@SerializedName("executives_provided")
Boolean executivesProvided;
/**
* 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 company's legal name.
*/
@SerializedName("name")
String name;
/**
* The Kana variation of the company's legal name (Japan only).
*/
@SerializedName("name_kana")
String nameKana;
/**
* The Kanji variation of the company's legal name (Japan only).
*/
@SerializedName("name_kanji")
String nameKanji;
/**
* Whether the company's owners have been provided. Set this Boolean to {@code true} after
* creating all the company's owners with the
* Persons API for accounts with a {@code relationship.owner} requirement.
*/
@SerializedName("owners_provided")
Boolean ownersProvided;
/**
* The company's phone number (used for verification).
*/
@SerializedName("phone")
String phone;
/**
* The category identifying the legal structure of the company or legal entity. See Business
* structure for more details.
*/
@SerializedName("structure")
EnumParam structure;
/**
* The business ID number of the company, as appropriate for the company’s country. (Examples
* are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in
* the UK.)
*/
@SerializedName("tax_id")
String taxId;
/**
* The jurisdiction in which the {@code tax_id} is registered (Germany-based companies only).
*/
@SerializedName("tax_id_registrar")
String taxIdRegistrar;
/**
* The VAT number of the company.
*/
@SerializedName("vat_id")
String vatId;
/**
* Information on the verification state of the company.
*/
@SerializedName("verification")
Verification verification;
private Company(Address address, AddressKana addressKana, AddressKanji addressKanji, Boolean directorsProvided, Boolean executivesProvided, Map extraParams, String name, String nameKana, String nameKanji, Boolean ownersProvided, String phone, EnumParam structure, String taxId, String taxIdRegistrar, String vatId, Verification verification) {
this.address = address;
this.addressKana = addressKana;
this.addressKanji = addressKanji;
this.directorsProvided = directorsProvided;
this.executivesProvided = executivesProvided;
this.extraParams = extraParams;
this.name = name;
this.nameKana = nameKana;
this.nameKanji = nameKanji;
this.ownersProvided = ownersProvided;
this.phone = phone;
this.structure = structure;
this.taxId = taxId;
this.taxIdRegistrar = taxIdRegistrar;
this.vatId = vatId;
this.verification = verification;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Address address;
private AddressKana addressKana;
private AddressKanji addressKanji;
private Boolean directorsProvided;
private Boolean executivesProvided;
private Map extraParams;
private String name;
private String nameKana;
private String nameKanji;
private Boolean ownersProvided;
private String phone;
private EnumParam structure;
private String taxId;
private String taxIdRegistrar;
private String vatId;
private Verification verification;
/**
* Finalize and obtain parameter instance from this builder.
*/
public Company build() {
return new Company(this.address, this.addressKana, this.addressKanji, this.directorsProvided, this.executivesProvided, this.extraParams, this.name, this.nameKana, this.nameKanji, this.ownersProvided, this.phone, this.structure, this.taxId, this.taxIdRegistrar, this.vatId, this.verification);
}
/**
* The company's primary address.
*/
public Builder setAddress(Address address) {
this.address = address;
return this;
}
/**
* The Kana variation of the company's primary address (Japan only).
*/
public Builder setAddressKana(AddressKana addressKana) {
this.addressKana = addressKana;
return this;
}
/**
* The Kanji variation of the company's primary address (Japan only).
*/
public Builder setAddressKanji(AddressKanji addressKanji) {
this.addressKanji = addressKanji;
return this;
}
/**
* Whether the company's directors have been provided. Set this Boolean to {@code true} after
* creating all the company's directors with the
* Persons API for accounts with a {@code relationship.director} requirement. This value
* is not automatically set to {@code true} after creating directors, so it needs to be
* updated to indicate all directors have been provided.
*/
public Builder setDirectorsProvided(Boolean directorsProvided) {
this.directorsProvided = directorsProvided;
return this;
}
/**
* Whether the company's executives have been provided. Set this Boolean to {@code true} after
* creating all the company's executives with the Persons API for accounts with a {@code
* relationship.executive} requirement.
*/
public Builder setExecutivesProvided(Boolean executivesProvided) {
this.executivesProvided = executivesProvided;
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
* AccountCreateParams.Company#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 AccountCreateParams.Company#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 company's legal name.
*/
public Builder setName(String name) {
this.name = name;
return this;
}
/**
* The Kana variation of the company's legal name (Japan only).
*/
public Builder setNameKana(String nameKana) {
this.nameKana = nameKana;
return this;
}
/**
* The Kanji variation of the company's legal name (Japan only).
*/
public Builder setNameKanji(String nameKanji) {
this.nameKanji = nameKanji;
return this;
}
/**
* Whether the company's owners have been provided. Set this Boolean to {@code true} after
* creating all the company's owners with the
* Persons API for accounts with a {@code relationship.owner} requirement.
*/
public Builder setOwnersProvided(Boolean ownersProvided) {
this.ownersProvided = ownersProvided;
return this;
}
/**
* The company's phone number (used for verification).
*/
public Builder setPhone(String phone) {
this.phone = phone;
return this;
}
/**
* The category identifying the legal structure of the company or legal entity. See Business
* structure for more details.
*/
public Builder setStructure(Structure structure) {
this.structure = structure;
return this;
}
/**
* The category identifying the legal structure of the company or legal entity. See Business
* structure for more details.
*/
public Builder setStructure(EmptyParam structure) {
this.structure = structure;
return this;
}
/**
* The business ID number of the company, as appropriate for the company’s country. (Examples
* are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in
* the UK.)
*/
public Builder setTaxId(String taxId) {
this.taxId = taxId;
return this;
}
/**
* The jurisdiction in which the {@code tax_id} is registered (Germany-based companies only).
*/
public Builder setTaxIdRegistrar(String taxIdRegistrar) {
this.taxIdRegistrar = taxIdRegistrar;
return this;
}
/**
* The VAT number of the company.
*/
public Builder setVatId(String vatId) {
this.vatId = vatId;
return this;
}
/**
* Information on the verification state of the company.
*/
public Builder setVerification(Verification verification) {
this.verification = verification;
return this;
}
}
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, county, province, or region.
*/
@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 Address build() {
return new 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 AccountCreateParams.Company.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 AccountCreateParams.Company.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;
}
public Builder setState(String state) {
this.state = state;
return this;
}
}
/**
* City, district, suburb, town, or village.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCity() {
return this.city;
}
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCountry() {
return this.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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* Address line 1 (e.g., street, PO Box, or company name).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine1() {
return this.line1;
}
/**
* Address line 2 (e.g., apartment, suite, unit, or building).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine2() {
return this.line2;
}
/**
* ZIP or postal code.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getPostalCode() {
return this.postalCode;
}
/**
* State, county, province, or region.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getState() {
return this.state;
}
}
/**
* State, county, province, or region.
*/
public static class AddressKana {
/**
* City or ward.
*/
@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;
/**
* Block or building number.
*/
@SerializedName("line1")
String line1;
/**
* Building details.
*/
@SerializedName("line2")
String line2;
/**
* Postal code.
*/
@SerializedName("postal_code")
String postalCode;
/**
* Prefecture.
*/
@SerializedName("state")
String state;
/**
* Town or cho-me.
*/
@SerializedName("town")
String town;
private AddressKana(String city, String country, Map extraParams, String line1, String line2, String postalCode, String state, String town) {
this.city = city;
this.country = country;
this.extraParams = extraParams;
this.line1 = line1;
this.line2 = line2;
this.postalCode = postalCode;
this.state = state;
this.town = town;
}
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;
private String town;
/** Finalize and obtain parameter instance from this builder. */
public AddressKana build() {
return new AddressKana(this.city, this.country, this.extraParams, this.line1, this.line2, this.postalCode, this.state, this.town);
}
/** City or ward. */
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 AccountCreateParams.Company.AddressKana#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 AccountCreateParams.Company.AddressKana#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Block or building number. */
public Builder setLine1(String line1) {
this.line1 = line1;
return this;
}
/** Building details. */
public Builder setLine2(String line2) {
this.line2 = line2;
return this;
}
/** Postal code. */
public Builder setPostalCode(String postalCode) {
this.postalCode = postalCode;
return this;
}
/** Prefecture. */
public Builder setState(String state) {
this.state = state;
return this;
}
public Builder setTown(String town) {
this.town = town;
return this;
}
}
/**
* City or ward.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCity() {
return this.city;
}
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCountry() {
return this.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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* Block or building number.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine1() {
return this.line1;
}
/**
* Building details.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine2() {
return this.line2;
}
/**
* Postal code.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getPostalCode() {
return this.postalCode;
}
/**
* Prefecture.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getState() {
return this.state;
}
/**
* Town or cho-me.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTown() {
return this.town;
}
}
/**
* Town or cho-me.
*/
public static class AddressKanji {
/**
* City or ward.
*/
@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;
/**
* Block or building number.
*/
@SerializedName("line1")
String line1;
/**
* Building details.
*/
@SerializedName("line2")
String line2;
/**
* Postal code.
*/
@SerializedName("postal_code")
String postalCode;
/**
* Prefecture.
*/
@SerializedName("state")
String state;
/**
* Town or cho-me.
*/
@SerializedName("town")
String town;
private AddressKanji(String city, String country, Map extraParams, String line1, String line2, String postalCode, String state, String town) {
this.city = city;
this.country = country;
this.extraParams = extraParams;
this.line1 = line1;
this.line2 = line2;
this.postalCode = postalCode;
this.state = state;
this.town = town;
}
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;
private String town;
/** Finalize and obtain parameter instance from this builder. */
public AddressKanji build() {
return new AddressKanji(this.city, this.country, this.extraParams, this.line1, this.line2, this.postalCode, this.state, this.town);
}
/** City or ward. */
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 AccountCreateParams.Company.AddressKanji#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 AccountCreateParams.Company.AddressKanji#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Block or building number. */
public Builder setLine1(String line1) {
this.line1 = line1;
return this;
}
/** Building details. */
public Builder setLine2(String line2) {
this.line2 = line2;
return this;
}
/** Postal code. */
public Builder setPostalCode(String postalCode) {
this.postalCode = postalCode;
return this;
}
/** Prefecture. */
public Builder setState(String state) {
this.state = state;
return this;
}
public Builder setTown(String town) {
this.town = town;
return this;
}
}
/**
* City or ward.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCity() {
return this.city;
}
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCountry() {
return this.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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* Block or building number.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine1() {
return this.line1;
}
/**
* Building details.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine2() {
return this.line2;
}
/**
* Postal code.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getPostalCode() {
return this.postalCode;
}
/**
* Prefecture.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getState() {
return this.state;
}
/**
* Town or cho-me.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTown() {
return this.town;
}
}
/**
* Town or cho-me.
*/
public static class Verification {
/**
* A document verifying the business.
*/
@SerializedName("document")
Document document;
/**
* 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 Verification(Document document, Map extraParams) {
this.document = document;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Document document;
private Map extraParams;
/**
* Finalize and obtain parameter instance from this builder.
*/
public Verification build() {
return new Verification(this.document, this.extraParams);
}
/**
* A document verifying the business.
*/
public Builder setDocument(Document document) {
this.document = document;
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 AccountCreateParams.Company.Verification#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 AccountCreateParams.Company.Verification#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 static class Document {
/**
* The back of a document returned by a file upload with a {@code purpose}
* value of {@code additional_verification}. The uploaded file needs to be a color image
* (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in
* size.
*/
@SerializedName("back")
String back;
/**
* 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 front of a document returned by a file upload with a {@code purpose}
* value of {@code additional_verification}. The uploaded file needs to be a color image
* (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in
* size.
*/
@SerializedName("front")
String front;
private Document(String back, Map extraParams, String front) {
this.back = back;
this.extraParams = extraParams;
this.front = front;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String back;
private Map extraParams;
private String front;
/** Finalize and obtain parameter instance from this builder. */
public Document build() {
return new Document(this.back, this.extraParams, this.front);
}
/**
* The back of a document returned by a file upload with a {@code purpose}
* value of {@code additional_verification}. The uploaded file needs to be a color image
* (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in
* size.
*/
public Builder setBack(String back) {
this.back = back;
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 AccountCreateParams.Company.Verification.Document#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 AccountCreateParams.Company.Verification.Document#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 Builder setFront(String front) {
this.front = front;
return this;
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getBack() {
return this.back;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getFront() {
return this.front;
}
}
/**
* A document verifying the business.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Document getDocument() {
return this.document;
}
/**
* Map of extra parameters for custom features not available in this client library. The
* content in this map is not serialized under this field's {@code @SerializedName} value.
* Instead, each key/value pair is serialized as if the key is a root-level field (serialized)
* name in this param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
}
/**
* The front of a document returned by a file upload with a {@code purpose}
* value of {@code additional_verification}. The uploaded file needs to be a color image
* (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in
* size.
*/
public enum Structure implements ApiRequestParams.EnumParam {
@SerializedName("government_instrumentality")
GOVERNMENT_INSTRUMENTALITY("government_instrumentality"), @SerializedName("governmental_unit")
GOVERNMENTAL_UNIT("governmental_unit"), @SerializedName("incorporated_non_profit")
INCORPORATED_NON_PROFIT("incorporated_non_profit"), @SerializedName("limited_liability_partnership")
LIMITED_LIABILITY_PARTNERSHIP("limited_liability_partnership"), @SerializedName("multi_member_llc")
MULTI_MEMBER_LLC("multi_member_llc"), @SerializedName("private_company")
PRIVATE_COMPANY("private_company"), @SerializedName("private_corporation")
PRIVATE_CORPORATION("private_corporation"), @SerializedName("private_partnership")
PRIVATE_PARTNERSHIP("private_partnership"), @SerializedName("public_company")
PUBLIC_COMPANY("public_company"), @SerializedName("public_corporation")
PUBLIC_CORPORATION("public_corporation"), @SerializedName("public_partnership")
PUBLIC_PARTNERSHIP("public_partnership"), @SerializedName("sole_proprietorship")
SOLE_PROPRIETORSHIP("sole_proprietorship"), @SerializedName("tax_exempt_government_instrumentality")
TAX_EXEMPT_GOVERNMENT_INSTRUMENTALITY("tax_exempt_government_instrumentality"), @SerializedName("unincorporated_association")
UNINCORPORATED_ASSOCIATION("unincorporated_association"), @SerializedName("unincorporated_non_profit")
UNINCORPORATED_NON_PROFIT("unincorporated_non_profit");
private final String value;
Structure(String value) {
this.value = value;
}
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getValue() {
return this.value;
}
}
/**
* The company's primary address.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Address getAddress() {
return this.address;
}
/**
* The Kana variation of the company's primary address (Japan only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public AddressKana getAddressKana() {
return this.addressKana;
}
/**
* The Kanji variation of the company's primary address (Japan only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public AddressKanji getAddressKanji() {
return this.addressKanji;
}
/**
* Whether the company's directors have been provided. Set this Boolean to {@code true} after
* creating all the company's directors with the
* Persons API for accounts with a {@code relationship.director} requirement. This value is
* not automatically set to {@code true} after creating directors, so it needs to be updated to
* indicate all directors have been provided.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Boolean getDirectorsProvided() {
return this.directorsProvided;
}
/**
* Whether the company's executives have been provided. Set this Boolean to {@code true} after
* creating all the company's executives with the
* Persons API for accounts with a {@code relationship.executive} requirement.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Boolean getExecutivesProvided() {
return this.executivesProvided;
}
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* The company's legal name.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getName() {
return this.name;
}
/**
* The Kana variation of the company's legal name (Japan only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getNameKana() {
return this.nameKana;
}
/**
* The Kanji variation of the company's legal name (Japan only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getNameKanji() {
return this.nameKanji;
}
/**
* Whether the company's owners have been provided. Set this Boolean to {@code true} after
* creating all the company's owners with the
* Persons API for accounts with a {@code relationship.owner} requirement.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Boolean getOwnersProvided() {
return this.ownersProvided;
}
/**
* The company's phone number (used for verification).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getPhone() {
return this.phone;
}
/**
* The category identifying the legal structure of the company or legal entity. See Business
* structure for more details.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public EnumParam getStructure() {
return this.structure;
}
/**
* The business ID number of the company, as appropriate for the company’s country. (Examples
* are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in
* the UK.)
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTaxId() {
return this.taxId;
}
/**
* The jurisdiction in which the {@code tax_id} is registered (Germany-based companies only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTaxIdRegistrar() {
return this.taxIdRegistrar;
}
/**
* The VAT number of the company.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getVatId() {
return this.vatId;
}
/**
* Information on the verification state of the company.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Verification getVerification() {
return this.verification;
}
}
public static class Individual {
/**
* The individual's primary address.
*/
@SerializedName("address")
Address address;
/**
* The Kana variation of the the individual's primary address (Japan only).
*/
@SerializedName("address_kana")
AddressKana addressKana;
/**
* The Kanji variation of the the individual's primary address (Japan only).
*/
@SerializedName("address_kanji")
AddressKanji addressKanji;
/**
* The individual's date of birth.
*/
@SerializedName("dob")
Object dob;
/**
* The individual's email address.
*/
@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 individual's first name.
*/
@SerializedName("first_name")
String firstName;
/**
* The Kana variation of the the individual's first name (Japan only).
*/
@SerializedName("first_name_kana")
String firstNameKana;
/**
* The Kanji variation of the individual's first name (Japan only).
*/
@SerializedName("first_name_kanji")
String firstNameKanji;
/**
* The individual's gender (International regulations require either "male" or
* "female").
*/
@SerializedName("gender")
String gender;
/**
* The government-issued ID number of the individual, as appropriate for the representative’s
* country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in
* Canada). Instead of the number itself, you can also provide a PII token created with
* Stripe.js.
*/
@SerializedName("id_number")
String idNumber;
/**
* The individual's last name.
*/
@SerializedName("last_name")
String lastName;
/**
* The Kana varation of the individual's last name (Japan only).
*/
@SerializedName("last_name_kana")
String lastNameKana;
/**
* The Kanji varation of the individual's last name (Japan only).
*/
@SerializedName("last_name_kanji")
String lastNameKanji;
/**
* The individual's maiden name.
*/
@SerializedName("maiden_name")
String maidenName;
/**
* 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;
/**
* The individual's phone number.
*/
@SerializedName("phone")
String phone;
/**
* The last four digits of the individual's Social Security Number (U.S. only).
*/
@SerializedName("ssn_last_4")
String ssnLast4;
/**
* The individual's verification document information.
*/
@SerializedName("verification")
Verification verification;
private Individual(Address address, AddressKana addressKana, AddressKanji addressKanji, Object dob, String email, Map extraParams, String firstName, String firstNameKana, String firstNameKanji, String gender, String idNumber, String lastName, String lastNameKana, String lastNameKanji, String maidenName, Object metadata, String phone, String ssnLast4, Verification verification) {
this.address = address;
this.addressKana = addressKana;
this.addressKanji = addressKanji;
this.dob = dob;
this.email = email;
this.extraParams = extraParams;
this.firstName = firstName;
this.firstNameKana = firstNameKana;
this.firstNameKanji = firstNameKanji;
this.gender = gender;
this.idNumber = idNumber;
this.lastName = lastName;
this.lastNameKana = lastNameKana;
this.lastNameKanji = lastNameKanji;
this.maidenName = maidenName;
this.metadata = metadata;
this.phone = phone;
this.ssnLast4 = ssnLast4;
this.verification = verification;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Address address;
private AddressKana addressKana;
private AddressKanji addressKanji;
private Object dob;
private String email;
private Map extraParams;
private String firstName;
private String firstNameKana;
private String firstNameKanji;
private String gender;
private String idNumber;
private String lastName;
private String lastNameKana;
private String lastNameKanji;
private String maidenName;
private Object metadata;
private String phone;
private String ssnLast4;
private Verification verification;
/**
* Finalize and obtain parameter instance from this builder.
*/
public Individual build() {
return new Individual(this.address, this.addressKana, this.addressKanji, this.dob, this.email, this.extraParams, this.firstName, this.firstNameKana, this.firstNameKanji, this.gender, this.idNumber, this.lastName, this.lastNameKana, this.lastNameKanji, this.maidenName, this.metadata, this.phone, this.ssnLast4, this.verification);
}
/**
* The individual's primary address.
*/
public Builder setAddress(Address address) {
this.address = address;
return this;
}
/**
* The Kana variation of the the individual's primary address (Japan only).
*/
public Builder setAddressKana(AddressKana addressKana) {
this.addressKana = addressKana;
return this;
}
/**
* The Kanji variation of the the individual's primary address (Japan only).
*/
public Builder setAddressKanji(AddressKanji addressKanji) {
this.addressKanji = addressKanji;
return this;
}
/**
* The individual's date of birth.
*/
public Builder setDob(Dob dob) {
this.dob = dob;
return this;
}
/**
* The individual's date of birth.
*/
public Builder setDob(EmptyParam dob) {
this.dob = dob;
return this;
}
/**
* The individual's email address.
*/
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
* AccountCreateParams.Individual#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 AccountCreateParams.Individual#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 individual's first name.
*/
public Builder setFirstName(String firstName) {
this.firstName = firstName;
return this;
}
/**
* The Kana variation of the the individual's first name (Japan only).
*/
public Builder setFirstNameKana(String firstNameKana) {
this.firstNameKana = firstNameKana;
return this;
}
/**
* The Kanji variation of the individual's first name (Japan only).
*/
public Builder setFirstNameKanji(String firstNameKanji) {
this.firstNameKanji = firstNameKanji;
return this;
}
/**
* The individual's gender (International regulations require either "male" or
* "female").
*/
public Builder setGender(String gender) {
this.gender = gender;
return this;
}
/**
* The government-issued ID number of the individual, as appropriate for the representative’s
* country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number
* in Canada). Instead of the number itself, you can also provide a PII token created with
* Stripe.js.
*/
public Builder setIdNumber(String idNumber) {
this.idNumber = idNumber;
return this;
}
/**
* The individual's last name.
*/
public Builder setLastName(String lastName) {
this.lastName = lastName;
return this;
}
/**
* The Kana varation of the individual's last name (Japan only).
*/
public Builder setLastNameKana(String lastNameKana) {
this.lastNameKana = lastNameKana;
return this;
}
/**
* The Kanji varation of the individual's last name (Japan only).
*/
public Builder setLastNameKanji(String lastNameKanji) {
this.lastNameKanji = lastNameKanji;
return this;
}
/**
* The individual's maiden name.
*/
public Builder setMaidenName(String maidenName) {
this.maidenName = maidenName;
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
* AccountCreateParams.Individual#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 AccountCreateParams.Individual#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;
}
/**
* The individual's phone number.
*/
public Builder setPhone(String phone) {
this.phone = phone;
return this;
}
/**
* The last four digits of the individual's Social Security Number (U.S. only).
*/
public Builder setSsnLast4(String ssnLast4) {
this.ssnLast4 = ssnLast4;
return this;
}
/**
* The individual's verification document information.
*/
public Builder setVerification(Verification verification) {
this.verification = verification;
return this;
}
}
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, county, province, or region.
*/
@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 Address build() {
return new 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 AccountCreateParams.Individual.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 AccountCreateParams.Individual.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;
}
public Builder setState(String state) {
this.state = state;
return this;
}
}
/**
* City, district, suburb, town, or village.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCity() {
return this.city;
}
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCountry() {
return this.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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* Address line 1 (e.g., street, PO Box, or company name).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine1() {
return this.line1;
}
/**
* Address line 2 (e.g., apartment, suite, unit, or building).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine2() {
return this.line2;
}
/**
* ZIP or postal code.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getPostalCode() {
return this.postalCode;
}
/**
* State, county, province, or region.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getState() {
return this.state;
}
}
/**
* State, county, province, or region.
*/
public static class AddressKana {
/**
* City or ward.
*/
@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;
/**
* Block or building number.
*/
@SerializedName("line1")
String line1;
/**
* Building details.
*/
@SerializedName("line2")
String line2;
/**
* Postal code.
*/
@SerializedName("postal_code")
String postalCode;
/**
* Prefecture.
*/
@SerializedName("state")
String state;
/**
* Town or cho-me.
*/
@SerializedName("town")
String town;
private AddressKana(String city, String country, Map extraParams, String line1, String line2, String postalCode, String state, String town) {
this.city = city;
this.country = country;
this.extraParams = extraParams;
this.line1 = line1;
this.line2 = line2;
this.postalCode = postalCode;
this.state = state;
this.town = town;
}
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;
private String town;
/** Finalize and obtain parameter instance from this builder. */
public AddressKana build() {
return new AddressKana(this.city, this.country, this.extraParams, this.line1, this.line2, this.postalCode, this.state, this.town);
}
/** City or ward. */
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 AccountCreateParams.Individual.AddressKana#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 AccountCreateParams.Individual.AddressKana#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Block or building number. */
public Builder setLine1(String line1) {
this.line1 = line1;
return this;
}
/** Building details. */
public Builder setLine2(String line2) {
this.line2 = line2;
return this;
}
/** Postal code. */
public Builder setPostalCode(String postalCode) {
this.postalCode = postalCode;
return this;
}
/** Prefecture. */
public Builder setState(String state) {
this.state = state;
return this;
}
public Builder setTown(String town) {
this.town = town;
return this;
}
}
/**
* City or ward.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCity() {
return this.city;
}
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCountry() {
return this.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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* Block or building number.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine1() {
return this.line1;
}
/**
* Building details.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine2() {
return this.line2;
}
/**
* Postal code.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getPostalCode() {
return this.postalCode;
}
/**
* Prefecture.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getState() {
return this.state;
}
/**
* Town or cho-me.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTown() {
return this.town;
}
}
/**
* Town or cho-me.
*/
public static class AddressKanji {
/**
* City or ward.
*/
@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;
/**
* Block or building number.
*/
@SerializedName("line1")
String line1;
/**
* Building details.
*/
@SerializedName("line2")
String line2;
/**
* Postal code.
*/
@SerializedName("postal_code")
String postalCode;
/**
* Prefecture.
*/
@SerializedName("state")
String state;
/**
* Town or cho-me.
*/
@SerializedName("town")
String town;
private AddressKanji(String city, String country, Map extraParams, String line1, String line2, String postalCode, String state, String town) {
this.city = city;
this.country = country;
this.extraParams = extraParams;
this.line1 = line1;
this.line2 = line2;
this.postalCode = postalCode;
this.state = state;
this.town = town;
}
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;
private String town;
/** Finalize and obtain parameter instance from this builder. */
public AddressKanji build() {
return new AddressKanji(this.city, this.country, this.extraParams, this.line1, this.line2, this.postalCode, this.state, this.town);
}
/** City or ward. */
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 AccountCreateParams.Individual.AddressKanji#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 AccountCreateParams.Individual.AddressKanji#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Block or building number. */
public Builder setLine1(String line1) {
this.line1 = line1;
return this;
}
/** Building details. */
public Builder setLine2(String line2) {
this.line2 = line2;
return this;
}
/** Postal code. */
public Builder setPostalCode(String postalCode) {
this.postalCode = postalCode;
return this;
}
/** Prefecture. */
public Builder setState(String state) {
this.state = state;
return this;
}
public Builder setTown(String town) {
this.town = town;
return this;
}
}
/**
* City or ward.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCity() {
return this.city;
}
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCountry() {
return this.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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* Block or building number.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine1() {
return this.line1;
}
/**
* Building details.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLine2() {
return this.line2;
}
/**
* Postal code.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getPostalCode() {
return this.postalCode;
}
/**
* Prefecture.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getState() {
return this.state;
}
/**
* Town or cho-me.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTown() {
return this.town;
}
}
/**
* Town or cho-me.
*/
public static class Dob {
/**
* The day of birth, between 1 and 31.
*/
@SerializedName("day")
Long day;
/**
* 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 month of birth, between 1 and 12.
*/
@SerializedName("month")
Long month;
/**
* The four-digit year of birth.
*/
@SerializedName("year")
Long year;
private Dob(Long day, Map extraParams, Long month, Long year) {
this.day = day;
this.extraParams = extraParams;
this.month = month;
this.year = year;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long day;
private Map extraParams;
private Long month;
private Long year;
/** Finalize and obtain parameter instance from this builder. */
public Dob build() {
return new Dob(this.day, this.extraParams, this.month, this.year);
}
/** The day of birth, between 1 and 31. */
public Builder setDay(Long day) {
this.day = day;
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 AccountCreateParams.Individual.Dob#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 AccountCreateParams.Individual.Dob#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 month of birth, between 1 and 12. */
public Builder setMonth(Long month) {
this.month = month;
return this;
}
public Builder setYear(Long year) {
this.year = year;
return this;
}
}
/**
* The day of birth, between 1 and 31.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getDay() {
return this.day;
}
/**
* Map of extra parameters for custom features not available in this client library. The
* content in this map is not serialized under this field's {@code @SerializedName} value.
* Instead, each key/value pair is serialized as if the key is a root-level field (serialized)
* name in this param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* The month of birth, between 1 and 12.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getMonth() {
return this.month;
}
/**
* The four-digit year of birth.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getYear() {
return this.year;
}
}
/**
* The four-digit year of birth.
*/
public static class Verification {
/**
* A document showing address, either a passport, local ID card, or utility bill from a
* well-known utility company.
*/
@SerializedName("additional_document")
AdditionalDocument additionalDocument;
/** An identifying document, either a passport or local ID card. */
@SerializedName("document")
Document document;
/**
* 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 Verification(AdditionalDocument additionalDocument, Document document, Map extraParams) {
this.additionalDocument = additionalDocument;
this.document = document;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private AdditionalDocument additionalDocument;
private Document document;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public Verification build() {
return new Verification(this.additionalDocument, this.document, this.extraParams);
}
/**
* A document showing address, either a passport, local ID card, or utility bill from a
* well-known utility company.
*/
public Builder setAdditionalDocument(AdditionalDocument additionalDocument) {
this.additionalDocument = additionalDocument;
return this;
}
/** An identifying document, either a passport or local ID card. */
public Builder setDocument(Document document) {
this.document = document;
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 AccountCreateParams.Individual.Verification#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 AccountCreateParams.Individual.Verification#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 static class AdditionalDocument {
/**
* The back of an ID returned by a file
* upload with a {@code purpose} value of {@code identity_document}. The uploaded file
* needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format,
* and less than 10 MB in size.
*/
@SerializedName("back")
String back;
/**
* 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 front of an ID returned by a file
* upload with a {@code purpose} value of {@code identity_document}. The uploaded file
* needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format,
* and less than 10 MB in size.
*/
@SerializedName("front")
String front;
private AdditionalDocument(String back, Map extraParams, String front) {
this.back = back;
this.extraParams = extraParams;
this.front = front;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String back;
private Map extraParams;
private String front;
/** Finalize and obtain parameter instance from this builder. */
public AdditionalDocument build() {
return new AdditionalDocument(this.back, this.extraParams, this.front);
}
/**
* The back of an ID returned by a file
* upload with a {@code purpose} value of {@code identity_document}. The uploaded file
* needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF
* format, and less than 10 MB in size.
*/
public Builder setBack(String back) {
this.back = back;
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
* AccountCreateParams.Individual.Verification.AdditionalDocument#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
* AccountCreateParams.Individual.Verification.AdditionalDocument#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 front of an ID returned by a file
* upload with a {@code purpose} value of {@code identity_document}. The uploaded file
* needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF
* format, and less than 10 MB in size.
*/
public Builder setFront(String front) {
this.front = front;
return this;
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getBack() {
return this.back;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getFront() {
return this.front;
}
}
public static class Document {
/**
* The back of an ID returned by a file
* upload with a {@code purpose} value of {@code identity_document}. The uploaded file
* needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format,
* and less than 10 MB in size.
*/
@SerializedName("back")
String back;
/**
* 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 front of an ID returned by a file
* upload with a {@code purpose} value of {@code identity_document}. The uploaded file
* needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format,
* and less than 10 MB in size.
*/
@SerializedName("front")
String front;
private Document(String back, Map extraParams, String front) {
this.back = back;
this.extraParams = extraParams;
this.front = front;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String back;
private Map extraParams;
private String front;
/** Finalize and obtain parameter instance from this builder. */
public Document build() {
return new Document(this.back, this.extraParams, this.front);
}
/**
* The back of an ID returned by a file
* upload with a {@code purpose} value of {@code identity_document}. The uploaded file
* needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF
* format, and less than 10 MB in size.
*/
public Builder setBack(String back) {
this.back = back;
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 AccountCreateParams.Individual.Verification.Document#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 AccountCreateParams.Individual.Verification.Document#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 Builder setFront(String front) {
this.front = front;
return this;
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getBack() {
return this.back;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getFront() {
return this.front;
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public AdditionalDocument getAdditionalDocument() {
return this.additionalDocument;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Document getDocument() {
return this.document;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
}
/**
* The individual's primary address.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Address getAddress() {
return this.address;
}
/**
* The Kana variation of the the individual's primary address (Japan only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public AddressKana getAddressKana() {
return this.addressKana;
}
/**
* The Kanji variation of the the individual's primary address (Japan only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public AddressKanji getAddressKanji() {
return this.addressKanji;
}
/**
* The individual's date of birth.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getDob() {
return this.dob;
}
/**
* The individual's email address.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getEmail() {
return this.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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* The individual's first name.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getFirstName() {
return this.firstName;
}
/**
* The Kana variation of the the individual's first name (Japan only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getFirstNameKana() {
return this.firstNameKana;
}
/**
* The Kanji variation of the individual's first name (Japan only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getFirstNameKanji() {
return this.firstNameKanji;
}
/**
* The individual's gender (International regulations require either "male" or
* "female").
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getGender() {
return this.gender;
}
/**
* The government-issued ID number of the individual, as appropriate for the representative’s
* country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in
* Canada). Instead of the number itself, you can also provide a PII token created with
* Stripe.js.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getIdNumber() {
return this.idNumber;
}
/**
* The individual's last name.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLastName() {
return this.lastName;
}
/**
* The Kana varation of the individual's last name (Japan only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLastNameKana() {
return this.lastNameKana;
}
/**
* The Kanji varation of the individual's last name (Japan only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLastNameKanji() {
return this.lastNameKanji;
}
/**
* The individual's maiden name.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getMaidenName() {
return this.maidenName;
}
/**
* 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}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getMetadata() {
return this.metadata;
}
/**
* The individual's phone number.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getPhone() {
return this.phone;
}
/**
* The last four digits of the individual's Social Security Number (U.S. only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getSsnLast4() {
return this.ssnLast4;
}
/**
* The individual's verification document information.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Verification getVerification() {
return this.verification;
}
}
/**
* The front of an ID returned by a file
* upload with a {@code purpose} value of {@code identity_document}. The uploaded file
* needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF
* format, and less than 10 MB in size.
*/
public static class Settings {
/**
* Settings used to apply the account's branding to email receipts, invoices, Checkout, and
* other products.
*/
@SerializedName("branding")
Branding branding;
/**
* Settings specific to card charging on the account.
*/
@SerializedName("card_payments")
CardPayments cardPayments;
/**
* 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;
/**
* Settings that apply across payment methods for charging on the account.
*/
@SerializedName("payments")
Payments payments;
/**
* Settings specific to the account's payouts.
*/
@SerializedName("payouts")
Payouts payouts;
private Settings(Branding branding, CardPayments cardPayments, Map extraParams, Payments payments, Payouts payouts) {
this.branding = branding;
this.cardPayments = cardPayments;
this.extraParams = extraParams;
this.payments = payments;
this.payouts = payouts;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Branding branding;
private CardPayments cardPayments;
private Map extraParams;
private Payments payments;
private Payouts payouts;
/**
* Finalize and obtain parameter instance from this builder.
*/
public Settings build() {
return new Settings(this.branding, this.cardPayments, this.extraParams, this.payments, this.payouts);
}
/**
* Settings used to apply the account's branding to email receipts, invoices, Checkout, and
* other products.
*/
public Builder setBranding(Branding branding) {
this.branding = branding;
return this;
}
/**
* Settings specific to card charging on the account.
*/
public Builder setCardPayments(CardPayments cardPayments) {
this.cardPayments = cardPayments;
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
* AccountCreateParams.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 AccountCreateParams.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;
}
/**
* Settings that apply across payment methods for charging on the account.
*/
public Builder setPayments(Payments payments) {
this.payments = payments;
return this;
}
/**
* Settings specific to the account's payouts.
*/
public Builder setPayouts(Payouts payouts) {
this.payouts = payouts;
return this;
}
}
public static class Branding {
/**
* 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 a file upload) An icon for
* the account. Must be square and at least 128px x 128px.
*/
@SerializedName("icon")
String icon;
/**
* (ID of a file upload) A logo for
* the account that will be used in Checkout instead of the icon and without the account's
* name next to it if provided. Must be at least 128px x 128px.
*/
@SerializedName("logo")
String logo;
/**
* A CSS hex color value representing the primary branding color for this account.
*/
@SerializedName("primary_color")
String primaryColor;
/**
* A CSS hex color value representing the secondary branding color for this account.
*/
@SerializedName("secondary_color")
String secondaryColor;
private Branding(Map extraParams, String icon, String logo, String primaryColor, String secondaryColor) {
this.extraParams = extraParams;
this.icon = icon;
this.logo = logo;
this.primaryColor = primaryColor;
this.secondaryColor = secondaryColor;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private String icon;
private String logo;
private String primaryColor;
private String secondaryColor;
/** Finalize and obtain parameter instance from this builder. */
public Branding build() {
return new Branding(this.extraParams, this.icon, this.logo, this.primaryColor, this.secondaryColor);
}
/**
* 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 AccountCreateParams.Settings.Branding#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 AccountCreateParams.Settings.Branding#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 a file upload) An icon
* for the account. Must be square and at least 128px x 128px.
*/
public Builder setIcon(String icon) {
this.icon = icon;
return this;
}
/**
* (ID of a file upload) A logo for
* the account that will be used in Checkout instead of the icon and without the account's
* name next to it if provided. Must be at least 128px x 128px.
*/
public Builder setLogo(String logo) {
this.logo = logo;
return this;
}
/** A CSS hex color value representing the primary branding color for this account. */
public Builder setPrimaryColor(String primaryColor) {
this.primaryColor = primaryColor;
return this;
}
public Builder setSecondaryColor(String secondaryColor) {
this.secondaryColor = secondaryColor;
return this;
}
}
/**
* Map of extra parameters for custom features not available in this client library. The
* content in this map is not serialized under this field's {@code @SerializedName} value.
* Instead, each key/value pair is serialized as if the key is a root-level field (serialized)
* name in this param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* (ID of a file upload) An icon for
* the account. Must be square and at least 128px x 128px.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getIcon() {
return this.icon;
}
/**
* (ID of a file upload) A logo for
* the account that will be used in Checkout instead of the icon and without the account's
* name next to it if provided. Must be at least 128px x 128px.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getLogo() {
return this.logo;
}
/**
* A CSS hex color value representing the primary branding color for this account.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getPrimaryColor() {
return this.primaryColor;
}
/**
* A CSS hex color value representing the secondary branding color for this account.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getSecondaryColor() {
return this.secondaryColor;
}
}
/**
* A CSS hex color value representing the secondary branding color for this account.
*/
public static class CardPayments {
/**
* Automatically declines certain charge types regardless of whether the card issuer accepted
* or declined the charge.
*/
@SerializedName("decline_on")
DeclineOn declineOn;
/**
* 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 default text that appears on credit card statements when a charge is made. This field
* prefixes any dynamic {@code statement_descriptor} specified on the charge. {@code
* statement_descriptor_prefix} is useful for maximizing descriptor space for the dynamic
* portion.
*/
@SerializedName("statement_descriptor_prefix")
String statementDescriptorPrefix;
private CardPayments(DeclineOn declineOn, Map extraParams, String statementDescriptorPrefix) {
this.declineOn = declineOn;
this.extraParams = extraParams;
this.statementDescriptorPrefix = statementDescriptorPrefix;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private DeclineOn declineOn;
private Map extraParams;
private String statementDescriptorPrefix;
/**
* Finalize and obtain parameter instance from this builder.
*/
public CardPayments build() {
return new CardPayments(this.declineOn, this.extraParams, this.statementDescriptorPrefix);
}
/**
* Automatically declines certain charge types regardless of whether the card issuer
* accepted or declined the charge.
*/
public Builder setDeclineOn(DeclineOn declineOn) {
this.declineOn = declineOn;
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 AccountCreateParams.Settings.CardPayments#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 AccountCreateParams.Settings.CardPayments#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 default text that appears on credit card statements when a charge is made. This field
* prefixes any dynamic {@code statement_descriptor} specified on the charge. {@code
* statement_descriptor_prefix} is useful for maximizing descriptor space for the dynamic
* portion.
*/
public Builder setStatementDescriptorPrefix(String statementDescriptorPrefix) {
this.statementDescriptorPrefix = statementDescriptorPrefix;
return this;
}
}
public static class DeclineOn {
/**
* Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This
* setting only applies when a ZIP or postal code is provided and they fail bank
* verification.
*/
@SerializedName("avs_failure")
Boolean avsFailure;
/**
* Whether Stripe automatically declines charges with an incorrect CVC. This setting only
* applies when a CVC is provided and it fails bank verification.
*/
@SerializedName("cvc_failure")
Boolean cvcFailure;
/**
* 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 DeclineOn(Boolean avsFailure, Boolean cvcFailure, Map extraParams) {
this.avsFailure = avsFailure;
this.cvcFailure = cvcFailure;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Boolean avsFailure;
private Boolean cvcFailure;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public DeclineOn build() {
return new DeclineOn(this.avsFailure, this.cvcFailure, this.extraParams);
}
/**
* Whether Stripe automatically declines charges with an incorrect ZIP or postal code.
* This setting only applies when a ZIP or postal code is provided and they fail bank
* verification.
*/
public Builder setAvsFailure(Boolean avsFailure) {
this.avsFailure = avsFailure;
return this;
}
/**
* Whether Stripe automatically declines charges with an incorrect CVC. This setting only
* applies when a CVC is provided and it fails bank verification.
*/
public Builder setCvcFailure(Boolean cvcFailure) {
this.cvcFailure = cvcFailure;
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 AccountCreateParams.Settings.CardPayments.DeclineOn#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;
}
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Boolean getAvsFailure() {
return this.avsFailure;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Boolean getCvcFailure() {
return this.cvcFailure;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
}
/**
* Automatically declines certain charge types regardless of whether the card issuer accepted
* or declined the charge.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public DeclineOn getDeclineOn() {
return this.declineOn;
}
/**
* Map of extra parameters for custom features not available in this client library. The
* content in this map is not serialized under this field's {@code @SerializedName} value.
* Instead, each key/value pair is serialized as if the key is a root-level field (serialized)
* name in this param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* The default text that appears on credit card statements when a charge is made. This field
* prefixes any dynamic {@code statement_descriptor} specified on the charge. {@code
* statement_descriptor_prefix} is useful for maximizing descriptor space for the dynamic
* portion.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getStatementDescriptorPrefix() {
return this.statementDescriptorPrefix;
}
}
/**
* 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 AccountCreateParams.Settings.CardPayments.DeclineOn#extraParams} for
* the field documentation.
*/
public static class Payments {
/**
* 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 default text that appears on credit card statements when a charge is made. This field
* prefixes any dynamic {@code statement_descriptor} specified on the charge.
*/
@SerializedName("statement_descriptor")
String statementDescriptor;
/**
* The Kana variation of the default text that appears on credit card statements when a charge
* is made (Japan only).
*/
@SerializedName("statement_descriptor_kana")
String statementDescriptorKana;
/**
* The Kanji variation of the default text that appears on credit card statements when a
* charge is made (Japan only).
*/
@SerializedName("statement_descriptor_kanji")
String statementDescriptorKanji;
private Payments(Map extraParams, String statementDescriptor, String statementDescriptorKana, String statementDescriptorKanji) {
this.extraParams = extraParams;
this.statementDescriptor = statementDescriptor;
this.statementDescriptorKana = statementDescriptorKana;
this.statementDescriptorKanji = statementDescriptorKanji;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private String statementDescriptor;
private String statementDescriptorKana;
private String statementDescriptorKanji;
/** Finalize and obtain parameter instance from this builder. */
public Payments build() {
return new Payments(this.extraParams, this.statementDescriptor, this.statementDescriptorKana, this.statementDescriptorKanji);
}
/**
* 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 AccountCreateParams.Settings.Payments#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 AccountCreateParams.Settings.Payments#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 default text that appears on credit card statements when a charge is made. This field
* prefixes any dynamic {@code statement_descriptor} specified on the charge.
*/
public Builder setStatementDescriptor(String statementDescriptor) {
this.statementDescriptor = statementDescriptor;
return this;
}
/**
* The Kana variation of the default text that appears on credit card statements when a
* charge is made (Japan only).
*/
public Builder setStatementDescriptorKana(String statementDescriptorKana) {
this.statementDescriptorKana = statementDescriptorKana;
return this;
}
public Builder setStatementDescriptorKanji(String statementDescriptorKanji) {
this.statementDescriptorKanji = statementDescriptorKanji;
return this;
}
}
/**
* Map of extra parameters for custom features not available in this client library. The
* content in this map is not serialized under this field's {@code @SerializedName} value.
* Instead, each key/value pair is serialized as if the key is a root-level field (serialized)
* name in this param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* The default text that appears on credit card statements when a charge is made. This field
* prefixes any dynamic {@code statement_descriptor} specified on the charge.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getStatementDescriptor() {
return this.statementDescriptor;
}
/**
* The Kana variation of the default text that appears on credit card statements when a charge
* is made (Japan only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getStatementDescriptorKana() {
return this.statementDescriptorKana;
}
/**
* The Kanji variation of the default text that appears on credit card statements when a
* charge is made (Japan only).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getStatementDescriptorKanji() {
return this.statementDescriptorKanji;
}
}
/**
* The Kanji variation of the default text that appears on credit card statements when a
* charge is made (Japan only).
*/
public static class Payouts {
/**
* A Boolean indicating whether Stripe should try to reclaim negative balances from an
* attached bank account. For details, see Understanding Connect Account
* Balances.
*/
@SerializedName("debit_negative_balances")
Boolean debitNegativeBalances;
/**
* 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;
/**
* Details on when funds from charges are available, and when they are paid out to an external
* account. For details, see our Setting Bank and
* Debit Card Payouts documentation.
*/
@SerializedName("schedule")
Schedule schedule;
/**
* The text that appears on the bank account statement for payouts. If not set, this defaults
* to the platform's bank descriptor as set in the Dashboard.
*/
@SerializedName("statement_descriptor")
String statementDescriptor;
private Payouts(Boolean debitNegativeBalances, Map extraParams, Schedule schedule, String statementDescriptor) {
this.debitNegativeBalances = debitNegativeBalances;
this.extraParams = extraParams;
this.schedule = schedule;
this.statementDescriptor = statementDescriptor;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Boolean debitNegativeBalances;
private Map extraParams;
private Schedule schedule;
private String statementDescriptor;
/** Finalize and obtain parameter instance from this builder. */
public Payouts build() {
return new Payouts(this.debitNegativeBalances, this.extraParams, this.schedule, this.statementDescriptor);
}
/**
* A Boolean indicating whether Stripe should try to reclaim negative balances from an
* attached bank account. For details, see Understanding Connect Account
* Balances.
*/
public Builder setDebitNegativeBalances(Boolean debitNegativeBalances) {
this.debitNegativeBalances = debitNegativeBalances;
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 AccountCreateParams.Settings.Payouts#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 AccountCreateParams.Settings.Payouts#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Details on when funds from charges are available, and when they are paid out to an
* external account. For details, see our Setting Bank and
* Debit Card Payouts documentation.
*/
public Builder setSchedule(Schedule schedule) {
this.schedule = schedule;
return this;
}
/**
* The text that appears on the bank account statement for payouts. If not set, this
* defaults to the platform's bank descriptor as set in the Dashboard.
*/
public Builder setStatementDescriptor(String statementDescriptor) {
this.statementDescriptor = statementDescriptor;
return this;
}
}
public static class Schedule {
/**
* The number of days charge funds are held before being paid out. May also be set to {@code
* minimum}, representing the lowest available value for the account country. Default is
* {@code minimum}. The {@code delay_days} parameter does not apply when the {@code
* interval} is {@code manual}.
*/
@SerializedName("delay_days")
Object delayDays;
/**
* 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;
/**
* How frequently available funds are paid out. One of: {@code daily}, {@code manual},
* {@code weekly}, or {@code monthly}. Default is {@code daily}.
*/
@SerializedName("interval")
Interval interval;
/**
* The day of the month when available funds are paid out, specified as a number between
* 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead
* sent on the last day of a shorter month. Required and applicable only if {@code interval}
* is {@code monthly}.
*/
@SerializedName("monthly_anchor")
Long monthlyAnchor;
/**
* The day of the week when available funds are paid out, specified as {@code monday},
* {@code tuesday}, etc. (required and applicable only if {@code interval} is {@code
* weekly}.)
*/
@SerializedName("weekly_anchor")
WeeklyAnchor weeklyAnchor;
private Schedule(Object delayDays, Map extraParams, Interval interval, Long monthlyAnchor, WeeklyAnchor weeklyAnchor) {
this.delayDays = delayDays;
this.extraParams = extraParams;
this.interval = interval;
this.monthlyAnchor = monthlyAnchor;
this.weeklyAnchor = weeklyAnchor;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Object delayDays;
private Map extraParams;
private Interval interval;
private Long monthlyAnchor;
private WeeklyAnchor weeklyAnchor;
/** Finalize and obtain parameter instance from this builder. */
public Schedule build() {
return new Schedule(this.delayDays, this.extraParams, this.interval, this.monthlyAnchor, this.weeklyAnchor);
}
/**
* The number of days charge funds are held before being paid out. May also be set to
* {@code minimum}, representing the lowest available value for the account country.
* Default is {@code minimum}. The {@code delay_days} parameter does not apply when the
* {@code interval} is {@code manual}.
*/
public Builder setDelayDays(DelayDays delayDays) {
this.delayDays = delayDays;
return this;
}
/**
* The number of days charge funds are held before being paid out. May also be set to
* {@code minimum}, representing the lowest available value for the account country.
* Default is {@code minimum}. The {@code delay_days} parameter does not apply when the
* {@code interval} is {@code manual}.
*/
public Builder setDelayDays(Long delayDays) {
this.delayDays = delayDays;
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 AccountCreateParams.Settings.Payouts.Schedule#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 AccountCreateParams.Settings.Payouts.Schedule#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* How frequently available funds are paid out. One of: {@code daily}, {@code manual},
* {@code weekly}, or {@code monthly}. Default is {@code daily}.
*/
public Builder setInterval(Interval interval) {
this.interval = interval;
return this;
}
/**
* The day of the month when available funds are paid out, specified as a number between
* 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead
* sent on the last day of a shorter month. Required and applicable only if {@code
* interval} is {@code monthly}.
*/
public Builder setMonthlyAnchor(Long monthlyAnchor) {
this.monthlyAnchor = monthlyAnchor;
return this;
}
public Builder setWeeklyAnchor(WeeklyAnchor weeklyAnchor) {
this.weeklyAnchor = weeklyAnchor;
return this;
}
}
public enum DelayDays implements ApiRequestParams.EnumParam {
@SerializedName("minimum")
MINIMUM("minimum");
private final String value;
DelayDays(String value) {
this.value = value;
}
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getValue() {
return this.value;
}
}
public enum Interval implements ApiRequestParams.EnumParam {
@SerializedName("daily")
DAILY("daily"), @SerializedName("manual")
MANUAL("manual"), @SerializedName("monthly")
MONTHLY("monthly"), @SerializedName("weekly")
WEEKLY("weekly");
private final String value;
Interval(String value) {
this.value = value;
}
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getValue() {
return this.value;
}
}
public enum WeeklyAnchor implements ApiRequestParams.EnumParam {
@SerializedName("friday")
FRIDAY("friday"), @SerializedName("monday")
MONDAY("monday"), @SerializedName("saturday")
SATURDAY("saturday"), @SerializedName("sunday")
SUNDAY("sunday"), @SerializedName("thursday")
THURSDAY("thursday"), @SerializedName("tuesday")
TUESDAY("tuesday"), @SerializedName("wednesday")
WEDNESDAY("wednesday");
private final String value;
WeeklyAnchor(String value) {
this.value = value;
}
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getValue() {
return this.value;
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getDelayDays() {
return this.delayDays;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Interval getInterval() {
return this.interval;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getMonthlyAnchor() {
return this.monthlyAnchor;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public WeeklyAnchor getWeeklyAnchor() {
return this.weeklyAnchor;
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Boolean getDebitNegativeBalances() {
return this.debitNegativeBalances;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Schedule getSchedule() {
return this.schedule;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getStatementDescriptor() {
return this.statementDescriptor;
}
}
/**
* Settings used to apply the account's branding to email receipts, invoices, Checkout, and
* other products.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Branding getBranding() {
return this.branding;
}
/**
* Settings specific to card charging on the account.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public CardPayments getCardPayments() {
return this.cardPayments;
}
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* Settings that apply across payment methods for charging on the account.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Payments getPayments() {
return this.payments;
}
/**
* Settings specific to the account's payouts.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Payouts getPayouts() {
return this.payouts;
}
}
/**
* The day of the week when available funds are paid out, specified as {@code monday},
* {@code tuesday}, etc. (required and applicable only if {@code interval} is {@code
* weekly}.)
*/
public static class TosAcceptance {
/**
* The Unix timestamp marking when the account representative accepted the Stripe Services
* Agreement.
*/
@SerializedName("date")
Long date;
/**
* 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 from which the account representative accepted the Stripe Services Agreement.
*/
@SerializedName("ip")
String ip;
/**
* The user agent of the browser from which the account representative accepted the Stripe
* Services Agreement.
*/
@SerializedName("user_agent")
String userAgent;
private TosAcceptance(Long date, Map extraParams, String ip, String userAgent) {
this.date = date;
this.extraParams = extraParams;
this.ip = ip;
this.userAgent = userAgent;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long date;
private Map extraParams;
private String ip;
private String userAgent;
/** Finalize and obtain parameter instance from this builder. */
public TosAcceptance build() {
return new TosAcceptance(this.date, this.extraParams, this.ip, this.userAgent);
}
/**
* The Unix timestamp marking when the account representative accepted the Stripe Services
* Agreement.
*/
public Builder setDate(Long date) {
this.date = date;
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
* AccountCreateParams.TosAcceptance#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 AccountCreateParams.TosAcceptance#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 from which the account representative accepted the Stripe Services
* Agreement.
*/
public Builder setIp(String ip) {
this.ip = ip;
return this;
}
public Builder setUserAgent(String userAgent) {
this.userAgent = userAgent;
return this;
}
}
/**
* The Unix timestamp marking when the account representative accepted the Stripe Services
* Agreement.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getDate() {
return this.date;
}
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* The IP address from which the account representative accepted the Stripe Services Agreement.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getIp() {
return this.ip;
}
/**
* The user agent of the browser from which the account representative accepted the Stripe
* Services Agreement.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getUserAgent() {
return this.userAgent;
}
}
/**
* The user agent of the browser from which the account representative accepted the Stripe
* Services Agreement.
*/
public enum BusinessType implements ApiRequestParams.EnumParam {
@SerializedName("company")
COMPANY("company"), @SerializedName("government_entity")
GOVERNMENT_ENTITY("government_entity"), @SerializedName("individual")
INDIVIDUAL("individual"), @SerializedName("non_profit")
NON_PROFIT("non_profit");
private final String value;
BusinessType(String value) {
this.value = value;
}
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getValue() {
return this.value;
}
}
public enum RequestedCapability implements ApiRequestParams.EnumParam {
@SerializedName("au_becs_debit_payments")
AU_BECS_DEBIT_PAYMENTS("au_becs_debit_payments"), @SerializedName("card_issuing")
CARD_ISSUING("card_issuing"), @SerializedName("card_payments")
CARD_PAYMENTS("card_payments"), @SerializedName("jcb_payments")
JCB_PAYMENTS("jcb_payments"), @SerializedName("legacy_payments")
LEGACY_PAYMENTS("legacy_payments"), @SerializedName("tax_reporting_us_1099_k")
TAX_REPORTING_US_1099_K("tax_reporting_us_1099_k"), @SerializedName("tax_reporting_us_1099_misc")
TAX_REPORTING_US_1099_MISC("tax_reporting_us_1099_misc"), @SerializedName("transfers")
TRANSFERS("transfers");
private final String value;
RequestedCapability(String value) {
this.value = value;
}
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getValue() {
return this.value;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("custom")
CUSTOM("custom"), @SerializedName("express")
EXPRESS("express"), @SerializedName("standard")
STANDARD("standard");
private final String value;
Type(String value) {
this.value = value;
}
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getValue() {
return this.value;
}
}
/**
* An account token, used to
* securely provide details to the account.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getAccountToken() {
return this.accountToken;
}
/**
* Business information about the account.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public BusinessProfile getBusinessProfile() {
return this.businessProfile;
}
/**
* The business type.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getBusinessType() {
return this.businessType;
}
/**
* Information about the company or business. This field is null unless {@code business_type} is
* set to {@code company}, {@code government_entity}, or {@code non_profit}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Company getCompany() {
return this.company;
}
/**
* The country in which the account holder resides, or in which the business is legally
* established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the
* United States and the business for which you're creating an account is legally represented in
* Canada, you would use {@code CA} as the country for the account being created.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCountry() {
return this.country;
}
/**
* Three-letter ISO currency code representing the default currency for the account. This must be
* a currency that Stripe supports in the account's
* country.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getDefaultCurrency() {
return this.defaultCurrency;
}
/**
* The email address of the account holder. For Custom accounts, this is only to make the account
* easier to identify to you: Stripe will never directly email your users.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getEmail() {
return this.email;
}
/**
* Specifies which fields in the response should be expanded.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public List getExpand() {
return this.expand;
}
/**
* A card or bank account to attach to the account. You can provide either a token, like the ones
* returned by Stripe.js, or a dictionary, as
* documented in the {@code external_account} parameter for bank account creation.
* <br><br>By default, providing an external account sets it as the new default
* external account for its currency, and deletes the old default if one exists. To add additional
* external accounts without replacing the existing default for the currency, use the bank account
* or card creation API.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getExternalAccount() {
return this.externalAccount;
}
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* Information about the person represented by the account. This field is null unless {@code
* business_type} is set to {@code individual}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Individual getIndividual() {
return this.individual;
}
/**
* 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}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getMetadata() {
return this.metadata;
}
/**
* The set of capabilities you want to unlock for this account. Each capability will be inactive
* until you have provided its specific requirements and Stripe has verified them. An account may
* have some of its requested capabilities be active and some be inactive.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public List getRequestedCapabilities() {
return this.requestedCapabilities;
}
/**
* Options for customizing how the account functions within Stripe.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Settings getSettings() {
return this.settings;
}
/**
* Details on the account's acceptance of the Stripe Services
* Agreement.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public TosAcceptance getTosAcceptance() {
return this.tosAcceptance;
}
/**
* The type of Stripe account to create. Currently must be {@code custom}, as only Custom accounts may be created via
* the API.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Type getType() {
return this.type;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy