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

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/increase/models/real_time_decision.rb

Defined Under Namespace

Classes: NetworkDetails, NetworkIdentifiers, RequestDetails, Verification

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #inspect, #to_h, #to_s

Instance Attribute Details

#account_id ⇒ String

The identifier of the Account the authorization will debit.

Returns:

  • (String) 


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

required :account_id, String

#card_id ⇒ String

The identifier of the Card that is being authorized.

Returns:

  • (String) 


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

required :card_id, String

#decision ⇒ Symbol

Whether or not the authorization was approved.

Returns:

  • (Symbol) 


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

required :decision, Increase::Enum.new(:approve, :decline)

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


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

required :digital_wallet_token_id, String

#merchant_acceptor_id ⇒ String

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

Returns:

  • (String) 


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

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) 


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

required :merchant_category_code, String

#merchant_city ⇒ String

The city the merchant resides in.

Returns:

  • (String) 


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

required :merchant_city, String

#merchant_country ⇒ String

The country the merchant resides in.

Returns:

  • (String) 


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

required :merchant_country, String

#merchant_descriptor ⇒ String

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

Returns:

  • (String) 


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

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) 


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

required :merchant_postal_code, String

#merchant_state ⇒ String

The state the merchant resides in.

Returns:

  • (String) 


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

required :merchant_state, String

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

Fields specific to the network.

Returns:



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

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

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

Network-specific identifiers for a specific request or transaction.

Returns:



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

required :network_identifiers,
-> { Increase::Models::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) 


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

required :network_risk_score, Integer

#physical_card_id ⇒ String

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

Returns:

  • (String) 


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

required :physical_card_id, String

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


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

required :presentment_amount, Integer

#presentment_currency ⇒ String

The ISO 4217 code for the currency the user sees at the time of purchase.

Returns:

  • (String) 


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

required :presentment_currency, String

#processing_category ⇒ Symbol

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

Returns:

  • (Symbol) 


147
148
149
150
151
152
153
154
155
 
# File 'lib/increase/models/real_time_decision.rb', line 147

required :processing_category,
Increase::Enum.new(
  :account_funding,
  :automatic_fuel_dispenser,
  :bill_payment,
  :purchase,
  :quasi_cash,
  :refund
)

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

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

Returns:



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

required :request_details, -> { Increase::Models::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) 


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

required :settlement_amount, Integer

#settlement_currency ⇒ String

The ISO 4217 code for the currency the transaction will be settled in.

Returns:

  • (String) 


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

required :settlement_currency, String

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


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

required :upcoming_card_payment_id, String

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

Fields related to verification of cardholder-provided values.

Returns:



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

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