Stripe.Resources.Issuing.Cardholder (tiger_stripe v0.3.0)

IssuingCardholder

An Issuing Cardholder object represents an individual or business entity who is issued cards.

Related guide: How to create a cardholder

Summary

Types

billing()

company()

individual()

individual_card_issuing()

individual_card_issuing_user_terms_acceptance()

individual_dob()

individual_verification()

individual_verification_document()

requirements()

spending_controls()

spending_controls_spending_limits()

t()

Functions

expandable_fields()

object_name()

Types

billing()

@type billing() :: %{
  optional(:address) => Stripe.Resources.Address.t() | nil,
  optional(String.t()) => term()
}

address

company()

@type company() :: %{
  optional(:tax_id_provided) => boolean() | nil,
  optional(String.t()) => term()
}

tax_id_provided - Whether the company's business ID number was provided.

individual()

@type individual() :: %{
  optional(:card_issuing) => individual_card_issuing() | nil,
  optional(:dob) => individual_dob() | nil,
  optional(:first_name) => String.t() | nil,
  optional(:last_name) => String.t() | nil,
  optional(:verification) => individual_verification() | nil,
  optional(String.t()) => term()
}

card_issuing - Information related to the card_issuing program for this cardholder. Nullable.
dob - The date of birth of this cardholder. Nullable.
first_name - The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. Max length: 5000. Nullable.
last_name - The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. Max length: 5000. Nullable.
verification - Government-issued ID document for this cardholder. Nullable.

individual_card_issuing()

@type individual_card_issuing() :: %{
  optional(:user_terms_acceptance) =>
    individual_card_issuing_user_terms_acceptance() | nil,
  optional(String.t()) => term()
}

user_terms_acceptance - Information about cardholder acceptance of Celtic Authorized User Terms. Required for cards backed by a Celtic program. Nullable.

individual_card_issuing_user_terms_acceptance()

@type individual_card_issuing_user_terms_acceptance() :: %{
  optional(:date) => integer() | nil,
  optional(:ip) => String.t() | nil,
  optional(:user_agent) => String.t() | nil,
  optional(String.t()) => term()
}

date - The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Format: Unix timestamp. Nullable.
ip - The IP address from which the cardholder accepted the Authorized User Terms. Max length: 5000. Nullable.
user_agent - The user agent of the browser from which the cardholder accepted the Authorized User Terms. Max length: 5000. Nullable.

individual_dob()

@type individual_dob() :: %{
  optional(:day) => integer() | nil,
  optional(:month) => integer() | nil,
  optional(:year) => integer() | nil,
  optional(String.t()) => term()
}

day - The day of birth, between 1 and 31. Nullable.
month - The month of birth, between 1 and 12. Nullable.
year - The four-digit year of birth. Nullable.

individual_verification()

@type individual_verification() :: %{
  optional(:document) => individual_verification_document() | nil,
  optional(String.t()) => term()
}

document - An identifying document, either a passport or local ID card. Nullable.

individual_verification_document()

@type individual_verification_document() :: %{
  optional(:back) => String.t() | Stripe.Resources.File.t() | nil,
  optional(:front) => String.t() | Stripe.Resources.File.t() | nil,
  optional(String.t()) => term()
}

back - The back of a document returned by a file upload with a purpose value of identity_document. Nullable.
front - The front of a document returned by a file upload with a purpose value of identity_document. Nullable.

requirements()

@type requirements() :: %{
  optional(:disabled_reason) => String.t() | nil,
  optional(:past_due) => [String.t()] | nil,
  optional(String.t()) => term()
}

disabled_reason - If disabled_reason is present, all cards will decline authorizations with cardholder_verification_required reason. Possible values: listed, rejected.listed, requirements.past_due, under_review. Nullable.
past_due - Array of fields that need to be collected in order to verify and re-enable the cardholder. Nullable.

spending_controls()

@type spending_controls() :: %{
  optional(:allowed_categories) => [String.t()] | nil,
  optional(:allowed_merchant_countries) => [String.t()] | nil,
  optional(:blocked_categories) => [String.t()] | nil,
  optional(:blocked_merchant_countries) => [String.t()] | nil,
  optional(:spending_limits) => [spending_controls_spending_limits()] | nil,
  optional(:spending_limits_currency) => String.t() | nil,
  optional(String.t()) => term()
}

allowed_categories - Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with blocked_categories. Nullable.
allowed_merchant_countries - Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control. Nullable.
blocked_categories - Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with allowed_categories. Nullable.
blocked_merchant_countries - Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control. Nullable.
spending_limits - Limit spending with amount-based rules that apply across this cardholder's cards. Nullable.
spending_limits_currency - Currency of the amounts within spending_limits. Format: ISO 4217 currency code. Nullable.

spending_controls_spending_limits()

@type spending_controls_spending_limits() :: %{
  optional(:amount) => integer() | nil,
  optional(:categories) => [String.t()] | nil,
  optional(:interval) => String.t() | nil,
  optional(String.t()) => term()
}

amount - Maximum amount allowed to spend per interval. This amount is in the card's currency and in the smallest currency unit.
categories - Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories. Nullable.
interval - Interval (or event) to which the amount applies. Possible values: all_time, daily, monthly, per_authorization, weekly, yearly.

t()

@type t() :: %Stripe.Resources.Issuing.Cardholder{
  billing: billing(),
  company: company(),
  created: integer(),
  email: String.t(),
  id: String.t(),
  individual: individual(),
  livemode: boolean(),
  metadata: %{required(String.t()) => String.t()},
  name: String.t(),
  object: String.t(),
  phone_number: String.t(),
  preferred_locales: [String.t()],
  requirements: requirements(),
  spending_controls: spending_controls(),
  status: String.t(),
  type: String.t()
}

billing - Expandable.
company - Additional information about a company cardholder. Nullable. Expandable.
created - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
email - The cardholder's email address. Max length: 5000. Nullable.
id - Unique identifier for the object. Max length: 5000.
individual - Additional information about an individual cardholder. Nullable. Expandable.
livemode - Has the value true if the object exists in live mode or the value false if the object exists in test mode.
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.
name - The cardholder's name. This will be printed on cards issued to them. Max length: 5000.
object - String representing the object's type. Objects of the same type share the same value. Possible values: issuing.cardholder.
phone_number - The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details. Max length: 5000. Nullable.
preferred_locales - 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. Nullable.
requirements - Expandable.
spending_controls - Rules that control spending across this cardholder's cards. Refer to our documentation for more details. Nullable. Expandable.
status - Specifies whether to permit authorizations on this cardholder's cards. Possible values: active, blocked, inactive.
type - One of individual or company. See Choose a cardholder type for more details. Possible values: company, individual.