Class: Lithic::Models::CardAuthorization

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/card_authorization.rb

Defined Under Namespace

Modules: AccountType, Network, Status, TransactionInitiator Classes: Amounts, Avs, Card, FleetInfo, LatestChallenge, Merchant, NetworkSpecificData, Pos, ServiceLocation

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(business_application_identifier: nil) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::CardAuthorization::NetworkSpecificData::Visa for more details.

Parameters:

  • business_application_identifier (String, nil) (defaults to: nil) —

    Identifies the purpose or category of a transaction, used to classify and proces




# File 'lib/lithic/models/card_authorization.rb', line 236

Instance Attribute Details

#account_type ⇒ Symbol, ...

Returns:



147
 
# File 'lib/lithic/models/card_authorization.rb', line 147

optional :account_type, enum: -> { Lithic::CardAuthorization::AccountType }

#acquirer_fee ⇒ Integer

Fee (in cents) assessed by the merchant and paid for by the cardholder. Will be zero if no fee is assessed. Rebates may be transmitted as a negative value to indicate credited fees.

Returns:

  • (Integer) 


18
 
# File 'lib/lithic/models/card_authorization.rb', line 18

required :acquirer_fee, Integer

#amount ⇒ Integer

Deprecated.

Deprecated, use ‘amounts`. Authorization amount of the transaction (in cents), including any acquirer fees. The contents of this field are identical to `authorization_amount`.

Returns:

  • (Integer) 


28
 
# File 'lib/lithic/models/card_authorization.rb', line 28

required :amount, Integer

#amounts ⇒ Lithic::Models::CardAuthorization::Amounts

Structured amounts for this authorization. The ‘cardholder` and `merchant` amounts reflect the original network authorization values. For programs with hold adjustments enabled (e.g., automated fuel dispensers or tipping MCCs), the `hold` amount may exceed the `cardholder` and `merchant` amounts to account for anticipated final transaction amounts such as tips or fuel fill-ups

Returns:



38
 
# File 'lib/lithic/models/card_authorization.rb', line 38

required :amounts, -> { Lithic::CardAuthorization::Amounts }

#authorization_amount ⇒ Integer

Deprecated.

Deprecated, use ‘amounts`. The base transaction amount (in cents) plus the acquirer fee field. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.

Returns:

  • (Integer) 


48
 
# File 'lib/lithic/models/card_authorization.rb', line 48

required :authorization_amount, Integer

#avs ⇒ Lithic::Models::CardAuthorization::Avs

Returns:



53
 
# File 'lib/lithic/models/card_authorization.rb', line 53

required :avs, -> { Lithic::CardAuthorization::Avs }

#card ⇒ Lithic::Models::CardAuthorization::Card

Card object in ASA

Returns:



59
 
# File 'lib/lithic/models/card_authorization.rb', line 59

required :card, -> { Lithic::CardAuthorization::Card }

#cardholder_authentication ⇒ Lithic::Models::CardholderAuthentication?

Returns:



152
 
# File 'lib/lithic/models/card_authorization.rb', line 152

optional :cardholder_authentication, -> { Lithic::CardholderAuthentication }

#cardholder_currency ⇒ String

Deprecated.

Deprecated, use ‘amounts`. 3-character alphabetic ISO 4217 code for cardholder’s billing currency.

Returns:

  • (String) 


68
 
# File 'lib/lithic/models/card_authorization.rb', line 68

required :cardholder_currency, String

#cash_amount ⇒ Integer

The portion of the transaction requested as cash back by the cardholder, and does not include any acquirer fees. The amount field includes the purchase amount, the requested cash back amount, and any acquirer fees.

If no cash back was requested, the value of this field will be 0, and the field will always be present.

Returns:

  • (Integer) 


79
 
# File 'lib/lithic/models/card_authorization.rb', line 79

required :cash_amount, Integer

#cashback ⇒ Integer?

Deprecated, use ‘cash_amount`.

Returns:

  • (Integer, nil) 


158
 
# File 'lib/lithic/models/card_authorization.rb', line 158

optional :cashback, Integer

#conversion_rate ⇒ Float?

Deprecated.

Deprecated, use ‘amounts`. If the transaction was requested in a currency other than the settlement currency, this field will be populated to indicate the rate used to translate the merchant_amount to the amount (i.e., `merchant_amount` x `conversion_rate` = `amount`). Note that the `merchant_amount` is in the local currency and the amount is in the settlement currency.

Returns:

  • (Float, nil) 


170
 
# File 'lib/lithic/models/card_authorization.rb', line 170

optional :conversion_rate, Float

#created ⇒ Time

Date and time when the transaction first occurred in UTC.

Returns:

  • (Time) 


85
 
# File 'lib/lithic/models/card_authorization.rb', line 85

required :created, Time

#event_token ⇒ String?

The event token associated with the authorization. This field is only set for programs enrolled into the beta.

Returns:

  • (String, nil) 


177
 
# File 'lib/lithic/models/card_authorization.rb', line 177

optional :event_token, String

#fleet_info ⇒ Lithic::Models::CardAuthorization::FleetInfo?

Optional Object containing information if the Card is a part of a Fleet managed program

Returns:



184
 
# File 'lib/lithic/models/card_authorization.rb', line 184

optional :fleet_info, -> { Lithic::CardAuthorization::FleetInfo }, nil?: true

#latest_challenge ⇒ Lithic::Models::CardAuthorization::LatestChallenge?

The latest Authorization Challenge that was issued to the cardholder for this merchant.

Returns:



191
 
# File 'lib/lithic/models/card_authorization.rb', line 191

optional :latest_challenge, -> { Lithic::CardAuthorization::LatestChallenge }

#merchant ⇒ Lithic::Models::CardAuthorization::Merchant

Merchant information including full location details.

Returns:



91
 
# File 'lib/lithic/models/card_authorization.rb', line 91

required :merchant, -> { Lithic::CardAuthorization::Merchant }

#merchant_amount ⇒ Integer

Deprecated.

Deprecated, use ‘amounts`. The amount that the merchant will receive, denominated in `merchant_currency` and in the smallest currency unit. Note the amount includes `acquirer_fee`, similar to `authorization_amount`. It will be different from `authorization_amount` if the merchant is taking payment in a different currency.

Returns:

  • (Integer) 


103
 
# File 'lib/lithic/models/card_authorization.rb', line 103

required :merchant_amount, Integer

#merchant_currency ⇒ String

Deprecated.

3-character alphabetic ISO 4217 code for the local currency of the transaction.

Returns:

  • (String) 


111
 
# File 'lib/lithic/models/card_authorization.rb', line 111

required :merchant_currency, String

#network ⇒ Symbol, ...

Card network of the authorization.

Returns:



197
 
# File 'lib/lithic/models/card_authorization.rb', line 197

optional :network, enum: -> { Lithic::CardAuthorization::Network }

#network_risk_score ⇒ Integer?

Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.

Returns:

  • (Integer, nil) 


207
 
# File 'lib/lithic/models/card_authorization.rb', line 207

optional :network_risk_score, Integer, nil?: true

#network_specific_data ⇒ Lithic::Models::CardAuthorization::NetworkSpecificData?

Contains raw data provided by the card network, including attributes that provide further context about the authorization. If populated by the network, data is organized by Lithic and passed through without further modification. Please consult the official network documentation for more details about these values and how to use them. This object is only available to certain programs- contact your Customer Success Manager to discuss enabling access.

Returns:



218
 
# File 'lib/lithic/models/card_authorization.rb', line 218

optional :network_specific_data, -> { Lithic::CardAuthorization::NetworkSpecificData }, nil?: true

#pos ⇒ Lithic::Models::CardAuthorization::Pos?

Returns:



223
 
# File 'lib/lithic/models/card_authorization.rb', line 223

optional :pos, -> { Lithic::CardAuthorization::Pos }

#service_location ⇒ Lithic::Models::CardAuthorization::ServiceLocation?

Where the cardholder received the service, when different from the card acceptor location. This is populated from network data elements such as Mastercard DE-122 SE1 SF9-14 and Visa F34 DS02.

Returns:



119
 
# File 'lib/lithic/models/card_authorization.rb', line 119

required :service_location, -> { Lithic::CardAuthorization::ServiceLocation }, nil?: true

#settled_amount ⇒ Integer

Deprecated.

Deprecated, use ‘amounts`. Amount (in cents) of the transaction that has been settled, including any acquirer fees.

Returns:

  • (Integer) 


128
 
# File 'lib/lithic/models/card_authorization.rb', line 128

required :settled_amount, Integer

#status ⇒ Symbol, Lithic::Models::CardAuthorization::Status

The type of authorization request that this request is for. Note that ‘CREDIT_AUTHORIZATION` and `FINANCIAL_CREDIT_AUTHORIZATION` is only available to users with credit decisioning via ASA enabled.

Returns:



136
 
# File 'lib/lithic/models/card_authorization.rb', line 136

required :status, enum: -> { Lithic::CardAuthorization::Status }

#token ⇒ String

The provisional transaction group uuid associated with the authorization

Returns:

  • (String) 


10
 
# File 'lib/lithic/models/card_authorization.rb', line 10

required :token, String

#token_info ⇒ Lithic::Models::TokenInfo?

Returns:



228
 
# File 'lib/lithic/models/card_authorization.rb', line 228

optional :token_info, -> { Lithic::TokenInfo }, nil?: true

#transaction_initiator ⇒ Symbol, Lithic::Models::CardAuthorization::TransactionInitiator

The entity that initiated the transaction.

Returns:



142
 
# File 'lib/lithic/models/card_authorization.rb', line 142

required :transaction_initiator, enum: -> { Lithic::CardAuthorization::TransactionInitiator }

#ttl ⇒ Time?

Deprecated: approximate time-to-live for the authorization.

Returns:

  • (Time, nil) 


234
 
# File 'lib/lithic/models/card_authorization.rb', line 234

optional :ttl, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/card_authorization.rb', line 473