Package com.stripe.model.issuing

Class Cardholder

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.issuing.Cardholder
All Implemented Interfaces:
HasId, MetadataStore<Cardholder>, StripeObjectInterface
public class Cardholder
extends ApiResource
implements HasId, MetadataStore<Cardholder>

  • Constructor Details

  • Method Details

    • list

      public static CardholderCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params) throws StripeException
      Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
      Throws:
      StripeException

    • list

      public static CardholderCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params, RequestOptions options) throws StripeException
      Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
      Throws:
      StripeException

    • list

      public static CardholderCollection list​(CardholderListParams params) throws StripeException
      Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
      Throws:
      StripeException

    • list

      public static CardholderCollection list​(CardholderListParams params, RequestOptions options) throws StripeException
      Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
      Throws:
      StripeException

    • create

      public static Cardholder create​(java.util.Map<java.lang.String,​java.lang.Object> params) throws StripeException
      Creates a new Issuing Cardholder object that can be issued cards.
      Throws:
      StripeException

    • create

      public static Cardholder create​(java.util.Map<java.lang.String,​java.lang.Object> params, RequestOptions options) throws StripeException
      Creates a new Issuing Cardholder object that can be issued cards.
      Throws:
      StripeException

    • create

      public static Cardholder create​(CardholderCreateParams params) throws StripeException
      Creates a new Issuing Cardholder object that can be issued cards.
      Throws:
      StripeException

    • create

      public static Cardholder create​(CardholderCreateParams params, RequestOptions options) throws StripeException
      Creates a new Issuing Cardholder object that can be issued cards.
      Throws:
      StripeException

    • retrieve

      public static Cardholder retrieve​(java.lang.String cardholder) throws StripeException
      Retrieves an Issuing Cardholder object.
      Throws:
      StripeException

    • retrieve

      public static Cardholder retrieve​(java.lang.String cardholder, RequestOptions options) throws StripeException
      Retrieves an Issuing Cardholder object.
      Throws:
      StripeException

    • retrieve

      public static Cardholder retrieve​(java.lang.String cardholder, java.util.Map<java.lang.String,​java.lang.Object> params, RequestOptions options) throws StripeException
      Retrieves an Issuing Cardholder object.
      Throws:
      StripeException

    • retrieve

      public static Cardholder retrieve​(java.lang.String cardholder, CardholderRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves an Issuing Cardholder object.
      Throws:
      StripeException

    • update

      public Cardholder update​(java.util.Map<java.lang.String,​java.lang.Object> params) throws StripeException
      Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      Specified by:
      update in interface MetadataStore<Cardholder>
      Throws:
      StripeException

    • update

      public Cardholder update​(java.util.Map<java.lang.String,​java.lang.Object> params, RequestOptions options) throws StripeException
      Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      Specified by:
      update in interface MetadataStore<Cardholder>
      Throws:
      StripeException

    • update

      public Cardholder update​(CardholderUpdateParams params) throws StripeException
      Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      Throws:
      StripeException

    • update

      public Cardholder update​(CardholderUpdateParams params, RequestOptions options) throws StripeException
      Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      Throws:
      StripeException

    • getAuthorizationControls

      public Cardholder.AuthorizationControls getAuthorizationControls()
      Spending rules that give you some control over how this cardholder's cards can be used. Refer to our [authorizations](https://stripe.com/docs/issuing/authorizations) documentation for more details.

    • getBilling

      public Cardholder.Billing getBilling()

    • getCompany

      public Cardholder.Company getCompany()
      Additional information about a `business_entity` cardholder.

    • getCreated

      public java.lang.Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getEmail

      public java.lang.String getEmail()
      The cardholder's email address.

    • getIndividual

      public Cardholder.Individual getIndividual()
      Additional information about an `individual` cardholder.

    • getIsDefault

      public java.lang.Boolean getIsDefault()
      Whether or not this cardholder is the default cardholder.

    • getLivemode

      public java.lang.Boolean getLivemode()
      Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

    • getName

      public java.lang.String getName()
      The cardholder's name. This will be printed on cards issued to them.

    • getObject

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

      Equal to `issuing.cardholder`.

    • getPhoneNumber

      public java.lang.String getPhoneNumber()
      The cardholder's phone number.

    • getRequirements

      public Cardholder.Requirements getRequirements()

    • getStatus

      public java.lang.String getStatus()
      Specifies whether to permit authorizations on this cardholder's cards.

      One of `active`, `blocked`, or `inactive`.

    • getType

      public java.lang.String getType()
      One of `individual` or `business_entity`.

    • setAuthorizationControls

      public void setAuthorizationControls​(Cardholder.AuthorizationControls authorizationControls)
      Spending rules that give you some control over how this cardholder's cards can be used. Refer to our [authorizations](https://stripe.com/docs/issuing/authorizations) documentation for more details.

    • setBilling

      public void setBilling​(Cardholder.Billing billing)

    • setCompany

      public void setCompany​(Cardholder.Company company)
      Additional information about a `business_entity` cardholder.

    • setCreated

      public void setCreated​(java.lang.Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setEmail

      public void setEmail​(java.lang.String email)
      The cardholder's email address.

    • setId

      public void setId​(java.lang.String id)
      Unique identifier for the object.

    • setIndividual

      public void setIndividual​(Cardholder.Individual individual)
      Additional information about an `individual` cardholder.

    • setIsDefault

      public void setIsDefault​(java.lang.Boolean isDefault)
      Whether or not this cardholder is the default cardholder.

    • setLivemode

      public void setLivemode​(java.lang.Boolean livemode)
      Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

    • setMetadata

      public void setMetadata​(java.util.Map<java.lang.String,​java.lang.String> metadata)
      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.

    • setName

      public void setName​(java.lang.String name)
      The cardholder's name. This will be printed on cards issued to them.

    • setObject

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

      Equal to `issuing.cardholder`.

    • setPhoneNumber

      public void setPhoneNumber​(java.lang.String phoneNumber)
      The cardholder's phone number.

    • setRequirements

      public void setRequirements​(Cardholder.Requirements requirements)

    • setStatus

      public void setStatus​(java.lang.String status)
      Specifies whether to permit authorizations on this cardholder's cards.

      One of `active`, `blocked`, or `inactive`.

    • setType

      public void setType​(java.lang.String type)
      One of `individual` or `business_entity`.

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • canEqual

      protected boolean canEqual​(java.lang.Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • getId

      public java.lang.String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId

    • getMetadata

      public java.util.Map<java.lang.String,​java.lang.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.
      Specified by:
      getMetadata in interface MetadataStore<Cardholder>