StripeAPI.Types.Card

Contains the types generated from the schema Card

Documentation

data Card

Defines the object schema located at components.schemas.card in the specification.

You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.

Related guide: Card Payments with Sources.

Constructors

Card

Fields

• cardAccount :: Maybe CardAccount'Variants

  account: The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

• cardAddressCity :: Maybe Text

  address_city: City/District/Suburb/Town/Village.

  Constraints:

  • Maximum length of 5000
• cardAddressCountry :: Maybe Text

  address_country: Billing address country, if provided when creating card.

  Constraints:

  • Maximum length of 5000
• cardAddressLine1 :: Maybe Text

  address_line1: Address line 1 (Street address/PO Box/Company name).

  Constraints:

  • Maximum length of 5000
• cardAddressLine1Check :: Maybe Text

  address_line1_check: If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

  Constraints:

  • Maximum length of 5000
• cardAddressLine2 :: Maybe Text

  address_line2: Address line 2 (Apartment/Suite/Unit/Building).

  Constraints:

  • Maximum length of 5000
• cardAddressState :: Maybe Text

  address_state: State/County/Province/Region.

  Constraints:

  • Maximum length of 5000
• cardAddressZip :: Maybe Text

  address_zip: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• cardAddressZipCheck :: Maybe Text

  address_zip_check: If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

  Constraints:

  • Maximum length of 5000
• cardAvailablePayoutMethods :: Maybe [CardAvailablePayoutMethods']

  available_payout_methods: A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.

• cardBrand :: Text

  brand: Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.

  Constraints:

  • Maximum length of 5000
• cardCountry :: Maybe Text

  country: Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.

  Constraints:

  • Maximum length of 5000
• cardCurrency :: Maybe Text

  currency: Three-letter ISO code for currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.

• cardCustomer :: Maybe CardCustomer'Variants

  customer: The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.

• cardCvcCheck :: Maybe Text

  cvc_check: If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.

  Constraints:

  • Maximum length of 5000
• cardDefaultForCurrency :: Maybe Bool

  default_for_currency: Whether this card is the default external account for its currency.

• cardDynamicLast4 :: Maybe Text

  dynamic_last4: (For tokenized numbers only.) The last four digits of the device account number.

  Constraints:

  • Maximum length of 5000
• cardExpMonth :: Int

  exp_month: Two-digit number representing the card's expiration month.

• cardExpYear :: Int

  exp_year: Four-digit number representing the card's expiration year.

• cardFingerprint :: Maybe Text

  fingerprint: Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

  • Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*

  Constraints:

  • Maximum length of 5000
• cardFunding :: Text

  funding: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.

  Constraints:

  • Maximum length of 5000
• cardId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• cardLast4 :: Text

  last4: The last four digits of the card.

  Constraints:

  • Maximum length of 5000
• cardMetadata :: Maybe Object

  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.

• cardName :: Maybe Text

  name: Cardholder name.

  Constraints:

  • Maximum length of 5000
• cardRecipient :: Maybe CardRecipient'Variants

  recipient: The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.

• cardTokenizationMethod :: Maybe Text

  tokenization_method: If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.

  Constraints:

  • Maximum length of 5000

Instances

Eq Card

Defined in StripeAPI.Types.Card

Methods

(==) :: Card -> Card -> Bool

(/=) :: Card -> Card -> Bool

Show Card

Defined in StripeAPI.Types.Card

Methods

showsPrec :: Int -> Card -> ShowS

show :: Card -> String

showList :: [Card] -> ShowS

ToJSON Card

Defined in StripeAPI.Types.Card

Methods

toJSON :: Card -> Value

toEncoding :: Card -> Encoding

toJSONList :: [Card] -> Value

toEncodingList :: [Card] -> Encoding

FromJSON Card

Defined in StripeAPI.Types.Card

Methods

parseJSON :: Value -> Parser Card

parseJSONList :: Value -> Parser [Card]

mkCard

Arguments

:: Text

cardBrand

-> Int

cardExpMonth

-> Int

cardExpYear

-> Text

cardFunding

-> Text

cardId

-> Text

cardLast4

-> Card

Create a new Card with all required fields.

data CardAccount'Variants

Defines the oneOf schema located at components.schemas.card.properties.account.anyOf in the specification.

The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

Constructors

CardAccount'Text Text

CardAccount'Account Account

Instances

Eq CardAccount'Variants

Defined in StripeAPI.Types.Card

Methods

(==) :: CardAccount'Variants -> CardAccount'Variants -> Bool

(/=) :: CardAccount'Variants -> CardAccount'Variants -> Bool

Show CardAccount'Variants

Defined in StripeAPI.Types.Card

Methods

showsPrec :: Int -> CardAccount'Variants -> ShowS

show :: CardAccount'Variants -> String

showList :: [CardAccount'Variants] -> ShowS

ToJSON CardAccount'Variants

Defined in StripeAPI.Types.Card

Methods

toJSON :: CardAccount'Variants -> Value

toEncoding :: CardAccount'Variants -> Encoding

toJSONList :: [CardAccount'Variants] -> Value

toEncodingList :: [CardAccount'Variants] -> Encoding

FromJSON CardAccount'Variants

Defined in StripeAPI.Types.Card

Methods

parseJSON :: Value -> Parser CardAccount'Variants

parseJSONList :: Value -> Parser [CardAccount'Variants]

data CardAvailablePayoutMethods'

Defines the enum schema located at components.schemas.card.properties.available_payout_methods.items in the specification.

Constructors

CardAvailablePayoutMethods'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

CardAvailablePayoutMethods'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

CardAvailablePayoutMethods'EnumInstant

Represents the JSON value "instant"

CardAvailablePayoutMethods'EnumStandard

Represents the JSON value "standard"

Instances

Eq CardAvailablePayoutMethods'

Defined in StripeAPI.Types.Card

Methods

(==) :: CardAvailablePayoutMethods' -> CardAvailablePayoutMethods' -> Bool

(/=) :: CardAvailablePayoutMethods' -> CardAvailablePayoutMethods' -> Bool

Show CardAvailablePayoutMethods'

Defined in StripeAPI.Types.Card

Methods

showsPrec :: Int -> CardAvailablePayoutMethods' -> ShowS

show :: CardAvailablePayoutMethods' -> String

showList :: [CardAvailablePayoutMethods'] -> ShowS

ToJSON CardAvailablePayoutMethods'

Defined in StripeAPI.Types.Card

Methods

toJSON :: CardAvailablePayoutMethods' -> Value

toEncoding :: CardAvailablePayoutMethods' -> Encoding

toJSONList :: [CardAvailablePayoutMethods'] -> Value

toEncodingList :: [CardAvailablePayoutMethods'] -> Encoding

FromJSON CardAvailablePayoutMethods'

Defined in StripeAPI.Types.Card

Methods

parseJSON :: Value -> Parser CardAvailablePayoutMethods'

parseJSONList :: Value -> Parser [CardAvailablePayoutMethods']

data CardCustomer'Variants

Defines the oneOf schema located at components.schemas.card.properties.customer.anyOf in the specification.

The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.

Constructors

CardCustomer'Text Text

CardCustomer'Customer Customer

CardCustomer'DeletedCustomer DeletedCustomer

Instances

Eq CardCustomer'Variants

Defined in StripeAPI.Types.Card

Methods

(==) :: CardCustomer'Variants -> CardCustomer'Variants -> Bool

(/=) :: CardCustomer'Variants -> CardCustomer'Variants -> Bool

Show CardCustomer'Variants

Defined in StripeAPI.Types.Card

Methods

showsPrec :: Int -> CardCustomer'Variants -> ShowS

show :: CardCustomer'Variants -> String

showList :: [CardCustomer'Variants] -> ShowS

ToJSON CardCustomer'Variants

Defined in StripeAPI.Types.Card

Methods

toJSON :: CardCustomer'Variants -> Value

toEncoding :: CardCustomer'Variants -> Encoding

toJSONList :: [CardCustomer'Variants] -> Value

toEncodingList :: [CardCustomer'Variants] -> Encoding

FromJSON CardCustomer'Variants

Defined in StripeAPI.Types.Card

Methods

parseJSON :: Value -> Parser CardCustomer'Variants

parseJSONList :: Value -> Parser [CardCustomer'Variants]

data CardRecipient'Variants

Defines the oneOf schema located at components.schemas.card.properties.recipient.anyOf in the specification.

The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.

Constructors

CardRecipient'Text Text

CardRecipient'Recipient Recipient

Instances

Eq CardRecipient'Variants

Defined in StripeAPI.Types.Card

Methods

(==) :: CardRecipient'Variants -> CardRecipient'Variants -> Bool

(/=) :: CardRecipient'Variants -> CardRecipient'Variants -> Bool

Show CardRecipient'Variants

Defined in StripeAPI.Types.Card

Methods

showsPrec :: Int -> CardRecipient'Variants -> ShowS

show :: CardRecipient'Variants -> String

showList :: [CardRecipient'Variants] -> ShowS

ToJSON CardRecipient'Variants

Defined in StripeAPI.Types.Card

Methods

toJSON :: CardRecipient'Variants -> Value

toEncoding :: CardRecipient'Variants -> Encoding

toJSONList :: [CardRecipient'Variants] -> Value

toEncodingList :: [CardRecipient'Variants] -> Encoding

FromJSON CardRecipient'Variants

Defined in StripeAPI.Types.Card

Methods

parseJSON :: Value -> Parser CardRecipient'Variants

parseJSONList :: Value -> Parser [CardRecipient'Variants]