Class: Increase::Models::RealTimeDecision::CardAuthorization

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/real_time_decision.rb

Overview

See Also:

Defined Under Namespace

Modules: Decision, Direction, ProcessingCategory Classes: NetworkDetails, NetworkIdentifiers, RequestDetails, Verification

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(card_payment_id: , original_card_authorization_id: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::IncrementalAuthorization for more details.

Fields specific to the category ‘incremental_authorization`.

Parameters:

  • card_payment_id (String) (defaults to: ) —

    The card payment for this authorization and increment.

  • original_card_authorization_id (String) (defaults to: ) —

    The identifier of the card authorization this request is attempting to increment




# File 'lib/increase/models/real_time_decision.rb', line 414

Instance Attribute Details

#account_id ⇒ String

The identifier of the Account the authorization will debit.

Returns:

  • (String) 


249
 
# File 'lib/increase/models/real_time_decision.rb', line 249

required :account_id, String

#card_id ⇒ String

The identifier of the Card that is being authorized.

Returns:

  • (String) 


255
 
# File 'lib/increase/models/real_time_decision.rb', line 255

required :card_id, String

#decision ⇒ Symbol, ...

Whether or not the authorization was approved.

Returns:



261
 
# File 'lib/increase/models/real_time_decision.rb', line 261

required :decision, enum: -> { Increase::RealTimeDecision::CardAuthorization::Decision }, nil?: true

#digital_wallet_token_id ⇒ String?

If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.

Returns:

  • (String, nil) 


268
 
# File 'lib/increase/models/real_time_decision.rb', line 268

required :digital_wallet_token_id, String, nil?: true

#direction ⇒ Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Direction

The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder.

Returns:



275
 
# File 'lib/increase/models/real_time_decision.rb', line 275

required :direction, enum: -> { Increase::RealTimeDecision::CardAuthorization::Direction }

#merchant_acceptor_id ⇒ String

The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.

Returns:

  • (String) 


282
 
# File 'lib/increase/models/real_time_decision.rb', line 282

required :merchant_acceptor_id, String

#merchant_category_code ⇒ String

The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.

Returns:

  • (String) 


289
 
# File 'lib/increase/models/real_time_decision.rb', line 289

required :merchant_category_code, String

#merchant_city ⇒ String?

The city the merchant resides in.

Returns:

  • (String, nil) 


295
 
# File 'lib/increase/models/real_time_decision.rb', line 295

required :merchant_city, String, nil?: true

#merchant_country ⇒ String

The country the merchant resides in.

Returns:

  • (String) 


301
 
# File 'lib/increase/models/real_time_decision.rb', line 301

required :merchant_country, String

#merchant_descriptor ⇒ String

The merchant descriptor of the merchant the card is transacting with.

Returns:

  • (String) 


307
 
# File 'lib/increase/models/real_time_decision.rb', line 307

required :merchant_descriptor, String

#merchant_postal_code ⇒ String?

The merchant’s postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash.

Returns:

  • (String, nil) 


314
 
# File 'lib/increase/models/real_time_decision.rb', line 314

required :merchant_postal_code, String, nil?: true

#merchant_state ⇒ String?

The state the merchant resides in.

Returns:

  • (String, nil) 


320
 
# File 'lib/increase/models/real_time_decision.rb', line 320

required :merchant_state, String, nil?: true

#network_details ⇒ Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails

Fields specific to the ‘network`.

Returns:



326
 
# File 'lib/increase/models/real_time_decision.rb', line 326

required :network_details, -> { Increase::RealTimeDecision::CardAuthorization::NetworkDetails }

#network_identifiers ⇒ Increase::Models::RealTimeDecision::CardAuthorization::NetworkIdentifiers

Network-specific identifiers for a specific request or transaction.

Returns:



332
333
334
335
 
# File 'lib/increase/models/real_time_decision.rb', line 332

required :network_identifiers,
-> {
  Increase::RealTimeDecision::CardAuthorization::NetworkIdentifiers
}

#network_risk_score ⇒ Integer?

The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest.

Returns:

  • (Integer, nil) 


342
 
# File 'lib/increase/models/real_time_decision.rb', line 342

required :network_risk_score, Integer, nil?: true

#physical_card_id ⇒ String?

If the authorization was made in-person with a physical card, the Physical Card that was used.

Returns:

  • (String, nil) 


349
 
# File 'lib/increase/models/real_time_decision.rb', line 349

required :physical_card_id, String, nil?: true

#presentment_amount ⇒ Integer

The amount of the attempted authorization in the currency the card user sees at the time of purchase, in the minor unit of that currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


357
 
# File 'lib/increase/models/real_time_decision.rb', line 357

required :presentment_amount, Integer

#presentment_currency ⇒ String

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the currency the user sees at the time of purchase.

Returns:

  • (String) 


364
 
# File 'lib/increase/models/real_time_decision.rb', line 364

required :presentment_currency, String

#processing_category ⇒ Symbol, Increase::Models::RealTimeDecision::CardAuthorization::ProcessingCategory

The processing category describes the intent behind the authorization, such as whether it was used for bill payments or an automatic fuel dispenser.

Returns:



371
372
 
# File 'lib/increase/models/real_time_decision.rb', line 371

required :processing_category,
enum: -> { Increase::RealTimeDecision::CardAuthorization::ProcessingCategory }

#request_details ⇒ Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails

Fields specific to the type of request, such as an incremental authorization.

Returns:



378
 
# File 'lib/increase/models/real_time_decision.rb', line 378

required :request_details, -> { Increase::RealTimeDecision::CardAuthorization::RequestDetails }

#settlement_amount ⇒ Integer

The amount of the attempted authorization in the currency it will be settled in. This currency is the same as that of the Account the card belongs to.

Returns:

  • (Integer) 


385
 
# File 'lib/increase/models/real_time_decision.rb', line 385

required :settlement_amount, Integer

#settlement_currency ⇒ String

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the currency the transaction will be settled in.

Returns:

  • (String) 


392
 
# File 'lib/increase/models/real_time_decision.rb', line 392

required :settlement_currency, String

#terminal_id ⇒ String?

The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.

Returns:

  • (String, nil) 


399
 
# File 'lib/increase/models/real_time_decision.rb', line 399

required :terminal_id, String, nil?: true

#upcoming_card_payment_id ⇒ String

The identifier of the Card Payment this authorization will belong to. Available in the API once the card authorization has completed.

Returns:

  • (String) 


406
 
# File 'lib/increase/models/real_time_decision.rb', line 406

required :upcoming_card_payment_id, String

#verification ⇒ Increase::Models::RealTimeDecision::CardAuthorization::Verification

Fields related to verification of cardholder-provided values.

Returns:



412
 
# File 'lib/increase/models/real_time_decision.rb', line 412

required :verification, -> { Increase::RealTimeDecision::CardAuthorization::Verification }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/real_time_decision.rb', line 482