Class: Stripe::Issuing::CardCreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/issuing/card_create_params.rb

Defined Under Namespace

Classes: LifecycleControls, Pin, Shipping, SpendingControls

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(cardholder: nil, currency: nil, exp_month: nil, exp_year: nil, expand: nil, financial_account: nil, lifecycle_controls: nil, metadata: nil, personalization_design: nil, pin: nil, replacement_for: nil, replacement_reason: nil, second_line: nil, shipping: nil, spending_controls: nil, status: nil, type: nil) ⇒ CardCreateParams

Returns a new instance of CardCreateParams.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 195

def initialize(
  cardholder: nil,
  currency: nil,
  exp_month: nil,
  exp_year: nil,
  expand: nil,
  financial_account: nil,
  lifecycle_controls: nil,
  metadata: nil,
  personalization_design: nil,
  pin: nil,
  replacement_for: nil,
  replacement_reason: nil,
  second_line: nil,
  shipping: nil,
  spending_controls: nil,
  status: nil,
  type: nil
)
  @cardholder = cardholder
  @currency = currency
  @exp_month = exp_month
  @exp_year = exp_year
  @expand = expand
  @financial_account = 
  @lifecycle_controls = lifecycle_controls
  @metadata = metadata
  @personalization_design = personalization_design
  @pin = pin
  @replacement_for = replacement_for
  @replacement_reason = replacement_reason
  @second_line = second_line
  @shipping = shipping
  @spending_controls = spending_controls
  @status = status
  @type = type
end

Instance Attribute Details

#cardholder ⇒ Object

The [Cardholder](docs.stripe.com/api#issuing_cardholder_object) object with which the card will be associated.



161
162
163
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 161

def cardholder
  @cardholder
end

#currency ⇒ Object

The currency for the card.



163
164
165
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 163

def currency
  @currency
end

#exp_month ⇒ Object

The desired expiration month (1-12) for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates).



165
166
167
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 165

def exp_month
  @exp_month
end

#exp_year ⇒ Object

The desired 4-digit expiration year for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates).



167
168
169
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 167

def exp_year
  @exp_year
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



169
170
171
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 169

def expand
  @expand
end

#financial_account ⇒ Object

The new financial account ID the card will be associated with. This field allows a card to be reassigned to a different financial account.



171
172
173
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 171

def 
  @financial_account
end

#lifecycle_controls ⇒ Object

Rules that control the lifecycle of this card, such as automatic cancellation. Refer to our [documentation](/issuing/controls/lifecycle-controls) for more details.



173
174
175
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 173

def lifecycle_controls
  @lifecycle_controls
end

#metadata ⇒ Object

Set of [key-value pairs](docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



175
176
177
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 175

def metadata
  @metadata
end

#personalization_design ⇒ Object

The personalization design object belonging to this card.



177
178
179
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 177

def personalization_design
  @personalization_design
end

#pin ⇒ Object

The desired PIN for this card.



179
180
181
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 179

def pin
  @pin
end

#replacement_for ⇒ Object

The card this is meant to be a replacement for (if any).



181
182
183
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 181

def replacement_for
  @replacement_for
end

#replacement_reason ⇒ Object

If ‘replacement_for` is specified, this should indicate why that card is being replaced.



183
184
185
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 183

def replacement_reason
  @replacement_reason
end

#second_line ⇒ Object

The second line to print on the card. Max length: 24 characters.



185
186
187
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 185

def second_line
  @second_line
end

#shipping ⇒ Object

The address where the card will be shipped.



187
188
189
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 187

def shipping
  @shipping
end

#spending_controls ⇒ Object

Rules that control spending for this card. Refer to our [documentation](docs.stripe.com/issuing/controls/spending-controls) for more details.



189
190
191
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 189

def spending_controls
  @spending_controls
end

#status ⇒ Object

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



191
192
193
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 191

def status
  @status
end

#type ⇒ Object

The type of card to issue. Possible values are ‘physical` or `virtual`.



193
194
195
 
# File 'lib/stripe/params/issuing/card_create_params.rb', line 193

def type
  @type
end