Cards

Type Members

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

id
ID of card (used in conjunction with a customer or recipient ID)
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.
brand
Card brand. Can be Brand.Visa, Express]], Brand.MasterCard, Brand.Discover, Brand.JCB, Club]], or Brand.Unknown
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.
funding
Card funding type. Can be Funding.Credit, Funding.Debit, Funding.Prepaid, or Funding.Unknown
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
sealed abstract class CardData extends AnyRef
case class CardInput(cardData: CardData, metadata: Option[Map[String, String]], defaultForCurrency: Option[Boolean]) 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
case class CardList(url: String, hasMore: Boolean, data: List[Card], totalCount: Option[Long]) extends List[Card] with Product with Serializable
case class CardListInput(endingBefore: Option[String], limit: Option[Long], startingAfter: Option[String]) 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
sealed abstract class Check extends EnumEntry
sealed abstract class Funding extends EnumEntry
sealed abstract class TokenizationMethod extends EnumEntry

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object Brand extends Enum[Brand]
object Card extends Serializable
object CardData
object CardInput extends Serializable
object CardList extends ListJsonMappers[Card] with Serializable
object CardListInput extends Serializable
object Check extends Enum[Check]
object Funding extends Enum[Funding]
object TokenizationMethod extends Enum[TokenizationMethod]
final def asInstanceOf[T0]: T0

Definition Classes
Any
implicit val brandFormats: Format[Brand]
implicit val cardDataWrites: Writes[CardData]
implicit val cardInputReads: Reads[CardInput]
implicit val cardInputWrites: Writes[CardInput]
implicit val cardReads: Reads[Card]
implicit val cardWrites: Writes[Card]
implicit val checkFormats: Format[Check]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def create(customerId: String, cardInput: CardInput)(idempotencyKey: Option[IdempotencyKey] = None)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[Card]]
def delete(customerId: String, cardId: String)(idempotencyKey: Option[IdempotencyKey] = None)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[DeleteResponse]]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
implicit val fundingFormats: Format[Funding]
def get(customerId: String, cardId: String)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[Card]]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def list(customerId: String, cardListInput: CardListInput, includeTotalCount: Boolean)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[CardList]]
lazy val logger: Logger

Attributes
protected
Definition Classes
LazyLogging
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
implicit val tokenizationMethodFormats: Format[TokenizationMethod]
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package v1

object Cards extends LazyLogging

Type Members

sealed abstract class Brand extends EnumEntry

sealed abstract class CardData extends AnyRef

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

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

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

sealed abstract class Check extends EnumEntry

sealed abstract class Funding extends EnumEntry

sealed abstract class TokenizationMethod extends EnumEntry

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Brand extends Enum[Brand]

object Card extends Serializable

object CardData

object CardInput extends Serializable

object CardList extends ListJsonMappers[Card] with Serializable

object CardListInput extends Serializable

object Check extends Enum[Check]

object Funding extends Enum[Funding]

object TokenizationMethod extends Enum[TokenizationMethod]

final def asInstanceOf[T0]: T0

implicit val brandFormats: Format[Brand]

implicit val cardDataWrites: Writes[CardData]

implicit val cardInputReads: Reads[CardInput]

implicit val cardInputWrites: Writes[CardInput]

implicit val cardReads: Reads[Card]

implicit val cardWrites: Writes[Card]

implicit val checkFormats: Format[Check]

def clone(): AnyRef

def create(customerId: String, cardInput: CardInput)(idempotencyKey: Option[IdempotencyKey] = None)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[Card]]

def delete(customerId: String, cardId: String)(idempotencyKey: Option[IdempotencyKey] = None)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[DeleteResponse]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

implicit val fundingFormats: Format[Funding]

def get(customerId: String, cardId: String)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[Card]]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def list(customerId: String, cardListInput: CardListInput, includeTotalCount: Boolean)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[CardList]]

lazy val logger: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

implicit val tokenizationMethodFormats: Format[TokenizationMethod]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped