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: 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 2605

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:



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

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

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


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

required :amount, Integer

#card_authorization_id ⇒ String

The identifier for the Card Authorization this increments.

Returns:

  • (String) 


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

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:



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

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

#id ⇒ String

The Card Increment identifier.

Returns:

  • (String) 


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

required :id, String

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

The card network used to process this card authorization.

Returns:



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

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:



2566
2567
2568
2569
 
# File 'lib/increase/models/card_payment.rb', line 2566

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) 


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

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) 


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

required :pending_transaction_id, String, nil?: true

#real_time_decision_id ⇒ String?

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

Returns:

  • (String, nil) 


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

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:



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

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) 


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

required :updated_authorization_amount, Integer

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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