Class CountrySpec

All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface

public class CountrySpec extends ApiResource implements HasId
Stripe needs to collect certain pieces of information about each account created. These requirements can differ depending on the account's country. The Country Specs API makes these rules available to your integration.

You can also view the information from this API call as an online guide.

  • Constructor Details

    • CountrySpec

      public CountrySpec()
  • Method Details

    • list

      public static CountrySpecCollection list(Map<String,Object> params) throws StripeException
      Lists all Country Spec objects available in the API.
      Throws:
      StripeException
    • list

      public static CountrySpecCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Lists all Country Spec objects available in the API.
      Throws:
      StripeException
    • list

      public static CountrySpecCollection list(CountrySpecListParams params) throws StripeException
      Lists all Country Spec objects available in the API.
      Throws:
      StripeException
    • list

      public static CountrySpecCollection list(CountrySpecListParams params, RequestOptions options) throws StripeException
      Lists all Country Spec objects available in the API.
      Throws:
      StripeException
    • retrieve

      public static CountrySpec retrieve(String country) throws StripeException
      Returns a Country Spec for a given Country code.
      Throws:
      StripeException
    • retrieve

      public static CountrySpec retrieve(String country, RequestOptions options) throws StripeException
      Returns a Country Spec for a given Country code.
      Throws:
      StripeException
    • retrieve

      public static CountrySpec retrieve(String country, Map<String,Object> params, RequestOptions options) throws StripeException
      Returns a Country Spec for a given Country code.
      Throws:
      StripeException
    • retrieve

      public static CountrySpec retrieve(String country, CountrySpecRetrieveParams params, RequestOptions options) throws StripeException
      Returns a Country Spec for a given Country code.
      Throws:
      StripeException
    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Fields which every account must eventually provide.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.
    • getDefaultCurrency

      public String getDefaultCurrency()
      The default currency for this country. This applies to both payment methods and bank accounts.
    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to country_spec.

    • getSupportedBankAccountCurrencies

      public Map<String,List<String>> getSupportedBankAccountCurrencies()
      Currencies that can be accepted in the specific country (for transfers).
    • getSupportedPaymentCurrencies

      public List<String> getSupportedPaymentCurrencies()
      Currencies that can be accepted in the specified country (for payments).
    • getSupportedPaymentMethods

      public List<String> getSupportedPaymentMethods()
      Payment methods available in the specified country. You may need to enable some payment methods (e.g., ACH) on your account before they appear in this list. The stripe payment method refers to charging through your platform.
    • getSupportedTransferCountries

      public List<String> getSupportedTransferCountries()
      Countries that can accept transfers from the specified country.
    • getVerificationFields

      public CountrySpec.VerificationFields getVerificationFields()
    • setDefaultCurrency

      public void setDefaultCurrency(String defaultCurrency)
      The default currency for this country. This applies to both payment methods and bank accounts.
    • setId

      public void setId(String id)
      Unique identifier for the object. Represented as the ISO country code for this country.
    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to country_spec.

    • setSupportedBankAccountCurrencies

      public void setSupportedBankAccountCurrencies(Map<String,List<String>> supportedBankAccountCurrencies)
      Currencies that can be accepted in the specific country (for transfers).
    • setSupportedPaymentCurrencies

      public void setSupportedPaymentCurrencies(List<String> supportedPaymentCurrencies)
      Currencies that can be accepted in the specified country (for payments).
    • setSupportedPaymentMethods

      public void setSupportedPaymentMethods(List<String> supportedPaymentMethods)
      Payment methods available in the specified country. You may need to enable some payment methods (e.g., ACH) on your account before they appear in this list. The stripe payment method refers to charging through your platform.
    • setSupportedTransferCountries

      public void setSupportedTransferCountries(List<String> supportedTransferCountries)
      Countries that can accept transfers from the specified country.
    • setVerificationFields

      public void setVerificationFields(CountrySpec.VerificationFields verificationFields)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • canEqual

      protected boolean canEqual(Object other)
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • getId

      public String getId()
      Unique identifier for the object. Represented as the ISO country code for this country.
      Specified by:
      getId in interface HasId