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: CreateParams, DeliverCardParams, FailCardParams, ListParams, ReturnCardParams, ShipCardParams, Shipping, SpendingControls, SubmitCardParams, TestHelpers, UpdateParams, 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

#==, #[], #[]=, 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.



624
625
626
 
# File 'lib/stripe/resources/issuing/card.rb', line 624

def brand
  @brand
end

#cancellation_reason ⇒ Object (readonly)

The reason why the card was canceled.



626
627
628
 
# File 'lib/stripe/resources/issuing/card.rb', line 626

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)



630
631
632
 
# File 'lib/stripe/resources/issuing/card.rb', line 630

def cardholder
  @cardholder
end

#created ⇒ Object (readonly)

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



632
633
634
 
# File 'lib/stripe/resources/issuing/card.rb', line 632

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.



634
635
636
 
# File 'lib/stripe/resources/issuing/card.rb', line 634

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.



636
637
638
 
# File 'lib/stripe/resources/issuing/card.rb', line 636

def cvc
  @cvc
end

#exp_month ⇒ Object (readonly)

The expiration month of the card.



638
639
640
 
# File 'lib/stripe/resources/issuing/card.rb', line 638

def exp_month
  @exp_month
end

#exp_year ⇒ Object (readonly)

The expiration year of the card.



640
641
642
 
# File 'lib/stripe/resources/issuing/card.rb', line 640

def exp_year
  @exp_year
end

#financial_account ⇒ Object (readonly)

The financial account this card is attached to.



642
643
644
 
# File 'lib/stripe/resources/issuing/card.rb', line 642

def 
  @financial_account
end

#id ⇒ Object (readonly)

Unique identifier for the object.



644
645
646
 
# File 'lib/stripe/resources/issuing/card.rb', line 644

def id
  @id
end

#last4 ⇒ Object (readonly)

The last 4 digits of the card number.



646
647
648
 
# File 'lib/stripe/resources/issuing/card.rb', line 646

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.



648
649
650
 
# File 'lib/stripe/resources/issuing/card.rb', line 648

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.



650
651
652
 
# File 'lib/stripe/resources/issuing/card.rb', line 650

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.



652
653
654
 
# File 'lib/stripe/resources/issuing/card.rb', line 652

def number
  @number
end

#object ⇒ Object (readonly)

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



654
655
656
 
# File 'lib/stripe/resources/issuing/card.rb', line 654

def object
  @object
end

#personalization_design ⇒ Object (readonly)

The personalization design object belonging to this card.



656
657
658
 
# File 'lib/stripe/resources/issuing/card.rb', line 656

def personalization_design
  @personalization_design
end

#replaced_by ⇒ Object (readonly)

The latest card that replaces this card, if any.



658
659
660
 
# File 'lib/stripe/resources/issuing/card.rb', line 658

def replaced_by
  @replaced_by
end

#replacement_for ⇒ Object (readonly)

The card this card replaces, if any.



660
661
662
 
# File 'lib/stripe/resources/issuing/card.rb', line 660

def replacement_for
  @replacement_for
end

#replacement_reason ⇒ Object (readonly)

The reason why the previous card needed to be replaced.



662
663
664
 
# File 'lib/stripe/resources/issuing/card.rb', line 662

def replacement_reason
  @replacement_reason
end

#shipping ⇒ Object (readonly)

Where and how the card will be shipped.



664
665
666
 
# File 'lib/stripe/resources/issuing/card.rb', line 664

def shipping
  @shipping
end

#spending_controls ⇒ Object (readonly)

Attribute for field spending_controls



666
667
668
 
# File 'lib/stripe/resources/issuing/card.rb', line 666

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



668
669
670
 
# File 'lib/stripe/resources/issuing/card.rb', line 668

def status
  @status
end

#type ⇒ Object (readonly)

The type of the card.



670
671
672
 
# File 'lib/stripe/resources/issuing/card.rb', line 670

def type
  @type
end

#wallets ⇒ Object (readonly)

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



672
673
674
 
# File 'lib/stripe/resources/issuing/card.rb', line 672

def wallets
  @wallets
end

Class Method Details

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

Creates an Issuing Card object.



675
676
677
 
# File 'lib/stripe/resources/issuing/card.rb', line 675

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/issuing/cards", params: params, opts: opts)
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.



680
681
682
 
# File 'lib/stripe/resources/issuing/card.rb', line 680

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.



685
686
687
688
689
690
691
692
 
# File 'lib/stripe/resources/issuing/card.rb', line 685

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 



694
695
696
 
# File 'lib/stripe/resources/issuing/card.rb', line 694

def test_helpers
  TestHelpers.new(self)
end