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: AdditionalAmounts, 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, meta_info, 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 419

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

#additional_amounts ⇒ Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts

Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the ‘amount` field and are used to provide more detailed information about the transaction.

Returns:



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

required :additional_amounts, -> { Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts }

#card_id ⇒ String

The identifier of the Card that is being authorized.

Returns:

  • (String) 


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

required :card_id, String

#decision ⇒ Symbol, ...

Whether or not the authorization was approved.

Returns:



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

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) 


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

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:



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

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) 


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

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) 


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

required :merchant_category_code, String

#merchant_city ⇒ String?

The city the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_city, String, nil?: true

#merchant_country ⇒ String

The country the merchant resides in.

Returns:

  • (String) 


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

required :merchant_country, String

#merchant_descriptor ⇒ String

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

Returns:

  • (String) 


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

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) 


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

required :merchant_postal_code, String, nil?: true

#merchant_state ⇒ String?

The state the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_state, String, nil?: true

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

Fields specific to the ‘network`.

Returns:



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

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

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

Network-specific identifiers for a specific request or transaction.

Returns:



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

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) 


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

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) 


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

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) 


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

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) 


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

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:



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

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:



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

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) 


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

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) 


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

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) 


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

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) 


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

required :upcoming_card_payment_id, String

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

Fields related to verification of cardholder-provided values.

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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