Class: Increase::Models::RealTimeDecision::CardBalanceInquiry

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

Overview

See Also:

  • Increase::Models::RealTimeDecision#card_balance_inquiry

Defined Under Namespace

Modules: Decision Classes: AdditionalAmounts, Approval, NetworkDetails, NetworkIdentifiers, 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(authorization_identification_response:, retrieval_reference_number:, trace_number:, transaction_id:) ⇒ Object

Network-specific identifiers for a specific request or transaction.

Parameters:

  • authorization_identification_response (String, nil) —

    The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.

  • retrieval_reference_number (String, nil) —

    A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter.

  • trace_number (String, nil) —

    A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time.

  • transaction_id (String, nil) —

    A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.




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

Instance Attribute Details

#account_id ⇒ String

The identifier of the Account the authorization will debit.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :account_id, String

#additional_amounts ⇒ Increase::Models::RealTimeDecision::CardBalanceInquiry::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.

Parameters:

  • value (Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts)

Returns:



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

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

#approval ⇒ Increase::Models::RealTimeDecision::CardBalanceInquiry::Approval?

Present if and only if decision is approve. Contains information related to the approval of the balance inquiry.

Parameters:

  • value (Increase::RealTimeDecision::CardBalanceInquiry::Approval, nil)

Returns:



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

required :approval, -> { Increase::RealTimeDecision::CardBalanceInquiry::Approval }, nil?: true

#card_id ⇒ String

The identifier of the Card that is being authorized.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :card_id, String

#decision ⇒ Symbol, ...

Whether or not the authorization was approved.

Parameters:

  • value (Increase::Models::RealTimeDecision::CardBalanceInquiry::decision, nil)

Returns:



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

required :decision, enum: -> { Increase::RealTimeDecision::CardBalanceInquiry::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.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :digital_wallet_token_id, String, nil?: true

#merchant_acceptor_id ⇒ String

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

Parameters:

  • value (String)

Returns:

  • (String) 


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

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.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :merchant_category_code, String

#merchant_city ⇒ String?

The city the merchant resides in.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :merchant_city, String, nil?: true

#merchant_country ⇒ String

The country the merchant resides in.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :merchant_country, String

#merchant_descriptor ⇒ String

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

Parameters:

  • value (String)

Returns:

  • (String) 


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

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.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :merchant_postal_code, String, nil?: true

#merchant_state ⇒ String?

The state the merchant resides in.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :merchant_state, String, nil?: true

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

Fields specific to the network.

Parameters:

  • value (Increase::RealTimeDecision::CardBalanceInquiry::NetworkDetails)

Returns:



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

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

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

Network-specific identifiers for a specific request or transaction.

Parameters:

  • value (Increase::RealTimeDecision::CardBalanceInquiry::NetworkIdentifiers)

Returns:



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

required :network_identifiers, -> { Increase::RealTimeDecision::CardBalanceInquiry::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. For Pulse the score is from 0 to 999, where 999 is the riskiest.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


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

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.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :physical_card_id, String, nil?: true

#terminal_id ⇒ String?

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

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

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.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :upcoming_card_payment_id, String

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

Fields related to verification of cardholder-provided values.

Parameters:

  • value (Increase::RealTimeDecision::CardBalanceInquiry::Verification)

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


1836
 
# File 'sig/increase/models/real_time_decision.rbs', line 1836

def to_hash: -> {