Class: Stripe::Issuing::Card

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/issuing/card.rb

Overview

You can [create physical or virtual cards](stripe.com/docs/issuing) that are issued to cardholders.

Defined Under Namespace

Classes: LatestFraudWarning, Shipping, SpendingControls, TestHelpers, Wallets

Constant Summary collapse

OBJECT_NAME = 
"issuing.card"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#brand ⇒ Object (readonly)

The brand of the card.



232
233
234
 
# File 'lib/stripe/resources/issuing/card.rb', line 232

def brand
  @brand
end

#cancellation_reason ⇒ Object (readonly)

The reason why the card was canceled.



234
235
236
 
# File 'lib/stripe/resources/issuing/card.rb', line 234

def cancellation_reason
  @cancellation_reason
end

#cardholder ⇒ Object (readonly)

An Issuing ‘Cardholder` object represents an individual or business entity who is [issued](stripe.com/docs/issuing) cards.

Related guide: [How to create a cardholder](stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder)



238
239
240
 
# File 'lib/stripe/resources/issuing/card.rb', line 238

def cardholder
  @cardholder
end

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



240
241
242
 
# File 'lib/stripe/resources/issuing/card.rb', line 240

def created
  @created
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are ‘usd` in the US, `eur` in the EU, and `gbp` in the UK.



242
243
244
 
# File 'lib/stripe/resources/issuing/card.rb', line 242

def currency
  @currency
end

#cvc ⇒ Object (readonly)

The card’s CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the ‘expand` parameter](stripe.com/docs/api/expanding_objects). Additionally, it’s only available via the [“Retrieve a card” endpoint](stripe.com/docs/api/issuing/cards/retrieve), not via “List all cards” or any other endpoint.



244
245
246
 
# File 'lib/stripe/resources/issuing/card.rb', line 244

def cvc
  @cvc
end

#exp_month ⇒ Object (readonly)

The expiration month of the card.



246
247
248
 
# File 'lib/stripe/resources/issuing/card.rb', line 246

def exp_month
  @exp_month
end

#exp_year ⇒ Object (readonly)

The expiration year of the card.



248
249
250
 
# File 'lib/stripe/resources/issuing/card.rb', line 248

def exp_year
  @exp_year
end

#financial_account ⇒ Object (readonly)

The financial account this card is attached to.



250
251
252
 
# File 'lib/stripe/resources/issuing/card.rb', line 250

def 
  
end

#id ⇒ Object (readonly)

Unique identifier for the object.



252
253
254
 
# File 'lib/stripe/resources/issuing/card.rb', line 252

def id
  @id
end

#last4 ⇒ Object (readonly)

The last 4 digits of the card number.



254
255
256
 
# File 'lib/stripe/resources/issuing/card.rb', line 254

def last4
  @last4
end

#latest_fraud_warning ⇒ Object (readonly)

Stripe’s assessment of whether this card’s details have been compromised. If this property isn’t null, cancel and reissue the card to prevent fraudulent activity risk.



256
257
258
 
# File 'lib/stripe/resources/issuing/card.rb', line 256

def latest_fraud_warning
  @latest_fraud_warning
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



258
259
260
 
# File 'lib/stripe/resources/issuing/card.rb', line 258

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



260
261
262
 
# File 'lib/stripe/resources/issuing/card.rb', line 260

def metadata
  @metadata
end

#number ⇒ Object (readonly)

The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the ‘expand` parameter](stripe.com/docs/api/expanding_objects). Additionally, it’s only available via the [“Retrieve a card” endpoint](stripe.com/docs/api/issuing/cards/retrieve), not via “List all cards” or any other endpoint.



262
263
264
 
# File 'lib/stripe/resources/issuing/card.rb', line 262

def number
  @number
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



264
265
266
 
# File 'lib/stripe/resources/issuing/card.rb', line 264

def object
  @object
end

#personalization_design ⇒ Object (readonly)

The personalization design object belonging to this card.



266
267
268
 
# File 'lib/stripe/resources/issuing/card.rb', line 266

def personalization_design
  @personalization_design
end

#replaced_by ⇒ Object (readonly)

The latest card that replaces this card, if any.



268
269
270
 
# File 'lib/stripe/resources/issuing/card.rb', line 268

def replaced_by
  @replaced_by
end

#replacement_for ⇒ Object (readonly)

The card this card replaces, if any.



270
271
272
 
# File 'lib/stripe/resources/issuing/card.rb', line 270

def replacement_for
  @replacement_for
end

#replacement_reason ⇒ Object (readonly)

The reason why the previous card needed to be replaced.



272
273
274
 
# File 'lib/stripe/resources/issuing/card.rb', line 272

def replacement_reason
  @replacement_reason
end

#second_line ⇒ Object (readonly)

Text separate from cardholder name, printed on the card.



274
275
276
 
# File 'lib/stripe/resources/issuing/card.rb', line 274

def second_line
  @second_line
end

#shipping ⇒ Object (readonly)

Where and how the card will be shipped.



276
277
278
 
# File 'lib/stripe/resources/issuing/card.rb', line 276

def shipping
  @shipping
end

#spending_controls ⇒ Object (readonly)

Attribute for field spending_controls



278
279
280
 
# File 'lib/stripe/resources/issuing/card.rb', line 278

def spending_controls
  @spending_controls
end

#status ⇒ Object (readonly)

Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to ‘inactive`.



280
281
282
 
# File 'lib/stripe/resources/issuing/card.rb', line 280

def status
  @status
end

#type ⇒ Object (readonly)

The type of the card.



282
283
284
 
# File 'lib/stripe/resources/issuing/card.rb', line 282

def type
  @type
end

#wallets ⇒ Object (readonly)

Information relating to digital wallets (like Apple Pay and Google Pay).



284
285
286
 
# File 'lib/stripe/resources/issuing/card.rb', line 284

def wallets
  @wallets
end

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Creates an Issuing Card object.



287
288
289
 
# File 'lib/stripe/resources/issuing/card.rb', line 287

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/issuing/cards", params: params, opts: opts)
end

.field_remappings ⇒ Object 



426
427
428
 
# File 'lib/stripe/resources/issuing/card.rb', line 426

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



417
418
419
420
421
422
423
424
 
# File 'lib/stripe/resources/issuing/card.rb', line 417

def self.inner_class_types
  @inner_class_types = {
    latest_fraud_warning: LatestFraudWarning,
    shipping: Shipping,
    spending_controls: SpendingControls,
    wallets: Wallets,
  }
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.



292
293
294
 
# File 'lib/stripe/resources/issuing/card.rb', line 292

def self.list(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/issuing/cards", params: params, opts: opts)
end

.object_name ⇒ Object 



13
14
15
 
# File 'lib/stripe/resources/issuing/card.rb', line 13

def self.object_name
  "issuing.card"
end

.update(card, params = {}, opts = {}) ⇒ Object

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.



297
298
299
300
301
302
303
304
 
# File 'lib/stripe/resources/issuing/card.rb', line 297

def self.update(card, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/issuing/cards/%<card>s", { card: CGI.escape(card) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#test_helpers ⇒ Object 



306
307
308
 
# File 'lib/stripe/resources/issuing/card.rb', line 306

def test_helpers
  TestHelpers.new(self)
end