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.



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 318

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



284
285
286
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 284

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



286
287
288
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 286

def amount_details
  @amount_details
end

#authorization_method ⇒ Object

How the card details were provided. Defaults to online.



288
289
290
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 288

def authorization_method
  @authorization_method
end

#card ⇒ Object

Card associated with this authorization.



290
291
292
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 290

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



292
293
294
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 292

def currency
  @currency
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



294
295
296
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 294

def expand
  @expand
end

#fleet ⇒ Object

Fleet-specific information for authorizations using Fleet cards.



296
297
298
 
# File 'lib/stripe/params/issuing/authorization_create_params.rb', line 296

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.



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

def fraud_disputability_likelihood
  @fraud_disputability_likelihood
end

#fuel ⇒ Object

Information about fuel that was purchased with this transaction.



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

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.



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

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



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

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



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

def merchant_currency
  @merchant_currency
end

#merchant_data ⇒ Object

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



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

def merchant_data
  @merchant_data
end

#network_data ⇒ Object

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



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

def network_data
  @network_data
end

#risk_assessment ⇒ Object

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



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

def risk_assessment
  @risk_assessment
end

#verification_data ⇒ Object

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



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

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.



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

def wallet
  @wallet
end