Class: Stripe::Issuing::AuthorizationCreateParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/issuing/authorization_create_params.rb

Defined Under Namespace

Classes: AmountDetails, Fleet, Fuel, MerchantData, NetworkData, RiskAssessment, VerificationData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, amount_details: nil, authorization_method: nil, card: nil, currency: nil, expand: nil, fleet: nil, fraud_disputability_likelihood: nil, fuel: nil, is_amount_controllable: nil, merchant_amount: nil, merchant_currency: nil, merchant_data: nil, network_data: nil, risk_assessment: nil, verification_data: nil, wallet: nil) ⇒ AuthorizationCreateParams

Returns a new instance of AuthorizationCreateParams.



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 333

def initialize(
  amount: nil,
  amount_details: nil,
  authorization_method: nil,
  card: nil,
  currency: nil,
  expand: nil,
  fleet: nil,
  fraud_disputability_likelihood: nil,
  fuel: nil,
  is_amount_controllable: nil,
  merchant_amount: nil,
  merchant_currency: nil,
  merchant_data: nil,
  network_data: nil,
  risk_assessment: nil,
  verification_data: nil,
  wallet: nil
)
  @amount = amount
  @amount_details = amount_details
  @authorization_method = authorization_method
  @card = card
  @currency = currency
  @expand = expand
  @fleet = fleet
  @fraud_disputability_likelihood = fraud_disputability_likelihood
  @fuel = fuel
  @is_amount_controllable = is_amount_controllable
  @merchant_amount = merchant_amount
  @merchant_currency = merchant_currency
  @merchant_data = merchant_data
  @network_data = network_data
  @risk_assessment = risk_assessment
  @verification_data = verification_data
  @wallet = wallet
end

Instance Attribute Details

#amount ⇒ Object

The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card’s currency, and in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal).



299
300
301
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 299

def amount
  @amount
end

#amount_details ⇒ Object

Detailed breakdown of amount components. These amounts are denominated in ‘currency` and in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal).



301
302
303
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 301

def amount_details
  @amount_details
end

#authorization_method ⇒ Object

How the card details were provided. Defaults to online.



303
304
305
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 303

def authorization_method
  @authorization_method
end

#card ⇒ Object

Card associated with this authorization.



305
306
307
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 305

def card
  @card
end

#currency ⇒ Object

The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



307
308
309
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 307

def currency
  @currency
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



309
310
311
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 309

def expand
  @expand
end

#fleet ⇒ Object

Fleet-specific information for authorizations using Fleet cards.



311
312
313
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 311

def fleet
  @fleet
end

#fraud_disputability_likelihood ⇒ Object

Probability that this transaction can be disputed in the event of fraud. Assessed by comparing the characteristics of the authorization to card network rules.



313
314
315
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 313

def fraud_disputability_likelihood
  @fraud_disputability_likelihood
end

#fuel ⇒ Object

Information about fuel that was purchased with this transaction.



315
316
317
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 315

def fuel
  @fuel
end

#is_amount_controllable ⇒ Object

If set ‘true`, you may provide [amount](stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.



317
318
319
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 317

def is_amount_controllable
  @is_amount_controllable
end

#merchant_amount ⇒ Object

The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal).



319
320
321
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 319

def merchant_amount
  @merchant_amount
end

#merchant_currency ⇒ Object

The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



321
322
323
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 321

def merchant_currency
  @merchant_currency
end

#merchant_data ⇒ Object

Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.



323
324
325
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 323

def merchant_data
  @merchant_data
end

#network_data ⇒ Object

Details about the authorization, such as identifiers, set by the card network.



325
326
327
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 325

def network_data
  @network_data
end

#risk_assessment ⇒ Object

Stripe’s assessment of the fraud risk for this authorization.



327
328
329
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 327

def risk_assessment
  @risk_assessment
end

#verification_data ⇒ Object

Verifications that Stripe performed on information that the cardholder provided to the merchant.



329
330
331
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 329

def verification_data
  @verification_data
end

#wallet ⇒ Object

The digital wallet used for this transaction. One of ‘apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.



331
332
333
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 331

def wallet
  @wallet
end