Class CardholderCreateParams


public class CardholderCreateParams extends ApiRequestParams
  • Method Details

    • builder

      public static CardholderCreateParams.Builder builder()
    • getBilling

      public CardholderCreateParams.Billing getBilling()
      Required. The cardholder's billing address.
    • getCompany

      public CardholderCreateParams.Company getCompany()
      Additional information about a company cardholder.
    • getEmail

      public String getEmail()
      The cardholder's email address.
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExtraParams

      public Map<String,Object> getExtraParams()
      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 @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.
    • getIndividual

      public CardholderCreateParams.Individual getIndividual()
      Additional information about an individual cardholder.
    • getMetadata

      public Map<String,String> getMetadata()
      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 metadata.
    • getName

      public String getName()
      Required. The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers.
    • getPhoneNumber

      public String getPhoneNumber()
      The cardholder's phone number. This will be transformed to E.164 if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.
    • getPreferredLocales

      public List<CardholderCreateParams.PreferredLocale> getPreferredLocales()
      The cardholder’s preferred locales (languages), ordered by preference. Locales can be de, en, es, fr, or it. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder.
    • getSpendingControls

      public CardholderCreateParams.SpendingControls getSpendingControls()
      Rules that control spending across this cardholder's cards. Refer to our documentation for more details.
    • getStatus

      public CardholderCreateParams.Status getStatus()
      Specifies whether to permit authorizations on this cardholder's cards. Defaults to active.
    • getType

      public CardholderCreateParams.Type getType()
      One of individual or company. See Choose a cardholder type for more details.