Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Card

Contains the types generated from the schema Card

5 types
1 value

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceCard.hs

datadata 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
- cardAccount :: Maybe (Nullable CardAccount'NonNullableVariants)
  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 (Nullable Text)
  address_city: City/District/Suburb/Town/Village.
  Constraints:
  - Maximum length of 5000
- cardAddressCountry :: Maybe (Nullable Text)
  address_country: Billing address country, if provided when creating card.
  Constraints:
  - Maximum length of 5000
- cardAddressLine1 :: Maybe (Nullable Text)
  address_line1: Address line 1 (Street address/PO Box/Company name).
  Constraints:
  - Maximum length of 5000
- cardAddressLine1Check :: Maybe (Nullable 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 (Nullable Text)
  address_line2: Address line 2 (Apartment/Suite/Unit/Building).
  Constraints:
  - Maximum length of 5000
- cardAddressState :: Maybe (Nullable Text)
  address_state: State/County/Province/Region.
  Constraints:
  - Maximum length of 5000
- cardAddressZip :: Maybe (Nullable Text)
  address_zip: ZIP or postal code.
  Constraints:
  - Maximum length of 5000
- cardAddressZipCheck :: Maybe (Nullable 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 (Nullable [CardAvailablePayoutMethods'NonNullable])
  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 (Nullable 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 (Nullable 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 (Nullable CardCustomer'NonNullableVariants)
  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 (Nullable 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 (Nullable Bool)
  default_for_currency: Whether this card is the default external account for its currency.
- cardDynamicLast4 :: Maybe (Nullable 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 (Nullable 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 (Nullable 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 (Nullable Text)
  name: Cardholder name.
  Constraints:
  - Maximum length of 5000
- cardRecipient :: Maybe (Nullable CardRecipient'NonNullableVariants)
  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.
- cardStatus :: Maybe (Nullable Text)
  status: For external accounts, possible values are `new` and `errored`. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.
  Constraints:
  - Maximum length of 5000
- cardTokenizationMethod :: Maybe (Nullable 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

Instances4Eq, Show, FromJSON, ToJSON

Eq CardDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
Show CardDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
FromJSON CardDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
ToJSON CardDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card

valuemkCard

:: Text
cardBrand
-> Int
cardExpMonth
-> Int
cardExpYear
-> Text
cardFunding
-> Text
cardId
-> Text
cardLast4
-> Card

Create a new Card with all required fields.

datadata CardAccount'NonNullableVariants

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'NonNullableText Text
CardAccount'NonNullableAccount Account

Instances4Eq, Show, FromJSON, ToJSON

Eq CardAccount'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
Show CardAccount'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
FromJSON CardAccount'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
ToJSON CardAccount'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card

datadata CardAvailablePayoutMethods'NonNullable

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

Constructors

CardAvailablePayoutMethods'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CardAvailablePayoutMethods'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
CardAvailablePayoutMethods'NonNullableEnumInstant
Represents the JSON value "instant"
CardAvailablePayoutMethods'NonNullableEnumStandard
Represents the JSON value "standard"

Instances4Eq, Show, FromJSON, ToJSON

Eq CardAvailablePayoutMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
Show CardAvailablePayoutMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
FromJSON CardAvailablePayoutMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
ToJSON CardAvailablePayoutMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card

datadata CardCustomer'NonNullableVariants

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'NonNullableText Text
CardCustomer'NonNullableCustomer Customer
CardCustomer'NonNullableDeletedCustomer DeletedCustomer

Instances4Eq, Show, FromJSON, ToJSON

Eq CardCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
Show CardCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
FromJSON CardCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
ToJSON CardCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card

datadata CardRecipient'NonNullableVariants

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'NonNullableText Text
CardRecipient'NonNullableRecipient Recipient

Instances4Eq, Show, FromJSON, ToJSON

Eq CardRecipient'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
Show CardRecipient'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
FromJSON CardRecipient'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card
ToJSON CardRecipient'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Card