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: 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.



217
218
219
 
# File 'lib/stripe/resources/issuing/card.rb', line 217

def brand
  @brand
end

#cancellation_reason ⇒ Object (readonly)

The reason why the card was canceled.



219
220
221
 
# File 'lib/stripe/resources/issuing/card.rb', line 219

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)



223
224
225
 
# File 'lib/stripe/resources/issuing/card.rb', line 223

def cardholder
  @cardholder
end

#created ⇒ Object (readonly)

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



225
226
227
 
# File 'lib/stripe/resources/issuing/card.rb', line 225

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.



227
228
229
 
# File 'lib/stripe/resources/issuing/card.rb', line 227

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.



229
230
231
 
# File 'lib/stripe/resources/issuing/card.rb', line 229

def cvc
  @cvc
end

#exp_month ⇒ Object (readonly)

The expiration month of the card.



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

def exp_month
  @exp_month
end

#exp_year ⇒ Object (readonly)

The expiration year of the card.



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

def exp_year
  @exp_year
end

#financial_account ⇒ Object (readonly)

The financial account this card is attached to.



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

def 
  @financial_account
end

#id ⇒ Object (readonly)

Unique identifier for the object.



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

def id
  @id
end

#last4 ⇒ Object (readonly)

The last 4 digits of the card number.



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

def last4
  @last4
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.



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

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.



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

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.



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

def number
  @number
end

#object ⇒ Object (readonly)

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



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

def object
  @object
end

#personalization_design ⇒ Object (readonly)

The personalization design object belonging to this card.



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

def personalization_design
  @personalization_design
end

#replaced_by ⇒ Object (readonly)

The latest card that replaces this card, if any.



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

def replaced_by
  @replaced_by
end

#replacement_for ⇒ Object (readonly)

The card this card replaces, if any.



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

def replacement_for
  @replacement_for
end

#replacement_reason ⇒ Object (readonly)

The reason why the previous card needed to be replaced.



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

def replacement_reason
  @replacement_reason
end

#second_line ⇒ Object (readonly)

Text separate from cardholder name, printed on the card.



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

def second_line
  @second_line
end

#shipping ⇒ Object (readonly)

Where and how the card will be shipped.



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

def shipping
  @shipping
end

#spending_controls ⇒ Object (readonly)

Attribute for field spending_controls



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

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`.



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

def status
  @status
end

#type ⇒ Object (readonly)

The type of the card.



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

def type
  @type
end

#wallets ⇒ Object (readonly)

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



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

def wallets
  @wallets
end

Class Method Details

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

Creates an Issuing Card object.



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

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

.field_remappings ⇒ Object 



408
409
410
 
# File 'lib/stripe/resources/issuing/card.rb', line 408

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



400
401
402
403
404
405
406
 
# File 'lib/stripe/resources/issuing/card.rb', line 400

def self.inner_class_types
  @inner_class_types = {
    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.



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

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.



280
281
282
283
284
285
286
287
 
# File 'lib/stripe/resources/issuing/card.rb', line 280

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 



289
290
291
 
# File 'lib/stripe/resources/issuing/card.rb', line 289

def test_helpers
  TestHelpers.new(self)
end