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, PartialApprovalCapability, ProcessingCategory Classes: AdditionalAmounts, Approval, Decline, 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 ⇒ Object

Fields specific to the category ‘initial_authorization`.




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

Instance Attribute Details

#account_id ⇒ String

The identifier of the Account the authorization will debit.

Returns:

  • (String) 


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

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:



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

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

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

Present if and only if ‘decision` is `approve`. Contains information related to the approval of the authorization.

Returns:



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

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

#card_id ⇒ String

The identifier of the Card that is being authorized.

Returns:

  • (String) 


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

required :card_id, String

#decision ⇒ Symbol, ...

Whether or not the authorization was approved.

Returns:



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

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

#decline ⇒ Increase::Models::RealTimeDecision::CardAuthorization::Decline?

Present if and only if ‘decision` is `decline`. Contains information related to the reason the authorization was declined.

Returns:



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

required :decline, -> { Increase::RealTimeDecision::CardAuthorization::Decline }, 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) 


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

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:



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

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) 


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

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) 


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

required :merchant_category_code, String

#merchant_city ⇒ String?

The city the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_city, String, nil?: true

#merchant_country ⇒ String

The country the merchant resides in.

Returns:

  • (String) 


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

required :merchant_country, String

#merchant_descriptor ⇒ String

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

Returns:

  • (String) 


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

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) 


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

required :merchant_postal_code, String, nil?: true

#merchant_state ⇒ String?

The state the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_state, String, nil?: true

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

Fields specific to the ‘network`.

Returns:



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

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

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

Network-specific identifiers for a specific request or transaction.

Returns:



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

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. For Pulse the score is from 0 to 999, where 999 is the riskiest.

Returns:

  • (Integer, nil) 


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

required :network_risk_score, Integer, nil?: true

#partial_approval_capability ⇒ Symbol, Increase::Models::RealTimeDecision::CardAuthorization::PartialApprovalCapability

Whether or not the authorization supports partial approvals.

Returns:



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

required :partial_approval_capability,
enum: -> { Increase::RealTimeDecision::CardAuthorization::PartialApprovalCapability }

#physical_card_id ⇒ String?

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

Returns:

  • (String, nil) 


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

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) 


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

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) 


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

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:



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

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:



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

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) 


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

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) 


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

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) 


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

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) 


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

required :upcoming_card_payment_id, String

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

Fields related to verification of cardholder-provided values.

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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