Cards

Type Members

1. sealed abstract class Brand extends EnumEntry

   

2. case class Card(id: String, brand: Brand, expMonth: Int, expYear: Int, funding: Funding, last4: String, account: Option[String] = None, addressCity: Option[String] = None, addressCountry: Option[String] = None, addressLine1: Option[String] = None, addressLine1Check: Option[Check] = None, addressLine2: Option[String] = None, addressState: Option[String] = None, addressZip: Option[String] = None, addressZipCheck: Option[Check] = None, country: Option[String] = None, currency: Option[Currency] = None, customer: Option[String] = None, cvcCheck: Option[Check] = None, defaultForCurrency: Option[Boolean] = None, dynamicLast4: Option[String] = None, fingerprint: Option[String] = None, metadata: Option[Map[String, String]] = None, name: Option[String] = None, recipient: Option[String] = None, tokenizationMethod: Option[TokenizationMethod] = None) extends StripeObject with PaymentSource with Product with Serializable

   
   id

   ID of card (used in conjunction with a customer or recipient ID)

   brand

   Card brand. Can be Brand.Visa, Express]], Brand.MasterCard, Brand.Discover, Brand.JCB, Club]], or Brand.Unknown

   funding

   Card funding type. Can be Funding.Credit, Funding.Debit, Funding.Prepaid, or Funding.Unknown

   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.

   addressCountry

   Billing address country, if provided when creating card

   addressLine1Check

   If addressLine1 was provided, results of the check: Check.Pass, Check.Fail, Check.Unavailable, or Check.Unchecked.

   addressZipCheck

   If addressZip was provided, results of the check: Check.Pass, Check.Fail, Check.Unavailable, or Check.Unchecked.

   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.

   currency

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

   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.

   cvcCheck

   If a CVC was provided, results of the check: Check.Pass, Check.Fail, Check.Unavailable, or Check.Unchecked

   defaultForCurrency

   Only applicable on accounts (not customers or recipients). This indicates whether or not this card is the default external account for its currency.

   dynamicLast4

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

   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.

   metadata

   A set of key/value pairs that you can attach to a card object. It can be useful for storing additional information about the card in a structured format.

   name

   Cardholder name

   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.

   tokenizationMethod

   If the card number is tokenized, this is the method that was used. Can be TokenizationMethod.ApplePay or TokenizationMethod.AndroidPay.

   See also

   https://stripe.com/docs/api#card_object

3. sealed abstract class CardData extends AnyRef

   

4. case class CardInput(cardData: CardData, metadata: Option[Map[String, String]] = None, defaultForCurrency: Option[Boolean] = None) extends Product with Serializable

   
   cardData

   When adding a card to a customer, the parameter name is CardData.Source. When adding to an account, the parameter name is CardData.ExternalAccount. The value can either be a token, like the ones returned by our Stripe.js, or a dictionary containing a user’s credit card details (with the options shown below). Stripe will automatically validate the card.

   metadata

   A set of key/value pairs that you can attach to a card object. It can be useful for storing additional information about the card in a structured format.

   defaultForCurrency

   Only applicable on accounts (not customers or recipients). If you set this to true (or if this is the first external account being added in this currency) this card will become the default external account for its currency.

   See also

   https://stripe.com/docs/api#create_card

5. case class CardList(url: String, hasMore: Boolean, data: List[Card], totalCount: Option[Long]) extends List[Card] with Product with Serializable

   

6. case class CardListInput(endingBefore: Option[String] = None, limit: Option[Long] = None, startingAfter: Option[String] = None) extends Product with Serializable

   
   endingBefore

   A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

   limit

   A limit on the number of objects to be returned. Limit can range between 1 and 100 items.

   startingAfter

   A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next page of the list.

   See also

   https://stripe.com/docs/api#list_cards

7. sealed abstract class Check extends EnumEntry

   

8. sealed abstract class Funding extends EnumEntry

   

9. sealed abstract class TokenizationMethod extends EnumEntry