Class: Increase::Models::CardPayment::Element::CardIncrement

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/card_payment.rb

Overview

See Also:

Defined Under Namespace

Modules: Actioner, Currency, Network, Type Classes: AdditionalAmounts, NetworkIdentifiers

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, 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(retrieval_reference_number: , trace_number: , transaction_id: ) ⇒ Object

Some parameter documentations has been truncated, see NetworkIdentifiers for more details.

Network-specific identifiers for a specific request or transaction.

Parameters:

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

    A life-cycle identifier used across e.g., an authorization and a reversal. Expec

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

    A counter used to verify an individual authorization. Expected to be unique per

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

    A globally unique transaction identifier provided by the card network, used acro




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

Instance Attribute Details

#actioner ⇒ Symbol, Increase::Models::CardPayment::Element::CardIncrement::Actioner

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

Returns:



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

required :actioner, enum: -> { Increase::CardPayment::Element::CardIncrement::Actioner }

#additional_amounts ⇒ Increase::Models::CardPayment::Element::CardIncrement::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:



3273
3274
3275
3276
 
# File 'lib/increase/models/card_payment.rb', line 3273

required :additional_amounts,
-> {
  Increase::CardPayment::Element::CardIncrement::AdditionalAmounts
}

#amount ⇒ Integer

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

Returns:

  • (Integer) 


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

required :amount, Integer

#card_authorization_id ⇒ String

The identifier for the Card Authorization this increments.

Returns:

  • (String) 


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

required :card_authorization_id, String

#currency ⇒ Symbol, Increase::Models::CardPayment::Element::CardIncrement::Currency

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the increment’s currency.

Returns:



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

required :currency, enum: -> { Increase::CardPayment::Element::CardIncrement::Currency }

#id ⇒ String

The Card Increment identifier.

Returns:

  • (String) 


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

required :id, String

#network ⇒ Symbol, Increase::Models::CardPayment::Element::CardIncrement::Network

The card network used to process this card authorization.

Returns:



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

required :network, enum: -> { Increase::CardPayment::Element::CardIncrement::Network }

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

Network-specific identifiers for a specific request or transaction.

Returns:



3308
3309
3310
3311
 
# File 'lib/increase/models/card_payment.rb', line 3308

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


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

required :network_risk_score, Integer, nil?: true

#pending_transaction_id ⇒ String?

The identifier of the Pending Transaction associated with this Card Increment.

Returns:

  • (String, nil) 


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

required :pending_transaction_id, String, nil?: true

#presentment_amount ⇒ Integer

The amount of this increment in the minor unit of the transaction’s presentment currency.

Returns:

  • (Integer) 


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

required :presentment_amount, Integer

#presentment_currency ⇒ String

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the transaction’s presentment currency.

Returns:

  • (String) 


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

required :presentment_currency, String

#real_time_decision_id ⇒ String?

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

Returns:

  • (String, nil) 


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

required :real_time_decision_id, String, nil?: true

#type ⇒ Symbol, Increase::Models::CardPayment::Element::CardIncrement::Type

A constant representing the object’s type. For this resource it will always be ‘card_increment`.

Returns:



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

required :type, enum: -> { Increase::CardPayment::Element::CardIncrement::Type }

#updated_authorization_amount ⇒ Integer

The updated authorization amount after this increment, in the minor unit of the transaction’s currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


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

required :updated_authorization_amount, Integer

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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