Class: Increase::Models::CardPayment::Element::CardAuthorization

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

Defined Under Namespace

Classes: NetworkDetails, NetworkIdentifiers, Verification

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

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

Instance Attribute Details

#actioner ⇒ Symbol

Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision.

Returns:

  • (Symbol) 


129
 
# File 'lib/increase/models/card_payment.rb', line 129

required :actioner, Increase::Enum.new(:user, :increase, :network)

#amount ⇒ Integer

The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


134
 
# File 'lib/increase/models/card_payment.rb', line 134

required :amount, Integer

#card_payment_id ⇒ String

The ID of the Card Payment this transaction belongs to.

Returns:

  • (String) 


139
 
# File 'lib/increase/models/card_payment.rb', line 139

required :card_payment_id, String

#currency ⇒ Symbol

The ISO 4217 code for the transaction's currency.

Returns:

  • (Symbol) 


144
 
# File 'lib/increase/models/card_payment.rb', line 144

required :currency, Increase::Enum.new(:CAD, :CHF, :EUR, :GBP, :JPY, :USD)

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


149
 
# File 'lib/increase/models/card_payment.rb', line 149

required :digital_wallet_token_id, String

#direction ⇒ Symbol

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

Returns:

  • (Symbol) 


154
 
# File 'lib/increase/models/card_payment.rb', line 154

required :direction, Increase::Enum.new(:settlement, :refund)

#expires_at ⇒ String

The ISO 8601 when this authorization will expire and the pending transaction will be released.

Returns:

  • (String) 


159
 
# File 'lib/increase/models/card_payment.rb', line 159

required :expires_at, String

#id ⇒ String

The Card Authorization identifier.

Returns:

  • (String) 


124
 
# File 'lib/increase/models/card_payment.rb', line 124

required :id, String

#merchant_acceptor_id ⇒ String

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

Returns:

  • (String) 


164
 
# File 'lib/increase/models/card_payment.rb', line 164

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) 


169
 
# File 'lib/increase/models/card_payment.rb', line 169

required :merchant_category_code, String

#merchant_city ⇒ String

The city the merchant resides in.

Returns:

  • (String) 


174
 
# File 'lib/increase/models/card_payment.rb', line 174

required :merchant_city, String

#merchant_country ⇒ String

The country the merchant resides in.

Returns:

  • (String) 


179
 
# File 'lib/increase/models/card_payment.rb', line 179

required :merchant_country, String

#merchant_descriptor ⇒ String

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

Returns:

  • (String) 


184
 
# File 'lib/increase/models/card_payment.rb', line 184

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) 


189
 
# File 'lib/increase/models/card_payment.rb', line 189

required :merchant_postal_code, String

#merchant_state ⇒ String

The state the merchant resides in.

Returns:

  • (String) 


194
 
# File 'lib/increase/models/card_payment.rb', line 194

required :merchant_state, String

#network_details ⇒ Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails

Fields specific to the network.

Returns:



199
200
 
# File 'lib/increase/models/card_payment.rb', line 199

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

#network_identifiers ⇒ Increase::Models::CardPayment::Element::CardAuthorization::NetworkIdentifiers

Network-specific identifiers for a specific request or transaction.

Returns:



205
206
 
# File 'lib/increase/models/card_payment.rb', line 205

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


211
 
# File 'lib/increase/models/card_payment.rb', line 211

required :network_risk_score, Integer

#pending_transaction_id ⇒ String

The identifier of the Pending Transaction associated with this Transaction.

Returns:

  • (String) 


216
 
# File 'lib/increase/models/card_payment.rb', line 216

required :pending_transaction_id, String

#physical_card_id ⇒ String

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

Returns:

  • (String) 


221
 
# File 'lib/increase/models/card_payment.rb', line 221

required :physical_card_id, String

#presentment_amount ⇒ Integer

The pending amount in the minor unit of the transaction's presentment currency.

Returns:

  • (Integer) 


226
 
# File 'lib/increase/models/card_payment.rb', line 226

required :presentment_amount, Integer

#presentment_currency ⇒ String

The ISO 4217 code for the transaction's presentment currency.

Returns:

  • (String) 


231
 
# File 'lib/increase/models/card_payment.rb', line 231

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) 


236
237
238
239
240
241
242
243
244
 
# File 'lib/increase/models/card_payment.rb', line 236

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

#real_time_decision_id ⇒ String

The identifier of the Real-Time Decision sent to approve or decline this transaction.

Returns:

  • (String) 


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

required :real_time_decision_id, String

#type ⇒ Symbol

A constant representing the object's type. For this resource it will always be card_authorization.

Returns:

  • (Symbol) 


254
 
# File 'lib/increase/models/card_payment.rb', line 254

required :type, Increase::Enum.new(:card_authorization)

#verification ⇒ Increase::Models::CardPayment::Element::CardAuthorization::Verification

Fields related to verification of cardholder-provided values.

Returns:



259
 
# File 'lib/increase/models/card_payment.rb', line 259

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