Class: Increase::Models::Transaction::Source::CardSettlement

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/transaction.rb,
sig/increase/models/transaction.rbs

Overview

See Also:

  • Increase::Models::Transaction::Source#card_settlement

Defined Under Namespace

Modules: Currency, Network, Type Classes: Cashback, Interchange, NetworkIdentifiers, PurchaseDetails, SchemeFee, Surcharge

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(amount:, presentment_amount:) ⇒ Object

Surcharge amount details, if applicable. The amount is positive if the surcharge is added to the overall transaction amount (surcharge), and negative if the surcharge is deducted from the overall transaction amount (discount).

Parameters:

  • amount (Integer) —

    The surcharge amount in the minor unit of the transaction's settlement currency.

  • presentment_amount (Integer) —

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




# File 'lib/increase/models/transaction.rb', line 5015

Instance Attribute Details

#amount ⇒ Integer

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

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


4869
 
# File 'lib/increase/models/transaction.rb', line 4869

required :amount, Integer

#card_authorization ⇒ String?

The Card Authorization that was created prior to this Card Settlement, if one exists.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


4876
 
# File 'lib/increase/models/transaction.rb', line 4876

required :card_authorization, String, nil?: true

#card_payment_id ⇒ String

The ID of the Card Payment this transaction belongs to.

Parameters:

  • value (String)

Returns:

  • (String) 


4882
 
# File 'lib/increase/models/transaction.rb', line 4882

required :card_payment_id, String

#cashback ⇒ Increase::Models::Transaction::Source::CardSettlement::Cashback?

Cashback earned on this transaction, if eligible. Cashback is paid out in aggregate, monthly.

Parameters:

  • value (Increase::Transaction::Source::CardSettlement::Cashback, nil)

Returns:



4889
 
# File 'lib/increase/models/transaction.rb', line 4889

required :cashback, -> { Increase::Transaction::Source::CardSettlement::Cashback }, nil?: true

#currency ⇒ Symbol, Increase::Models::Transaction::Source::CardSettlement::Currency

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

Parameters:

  • value (Increase::Models::Transaction::Source::CardSettlement::currency)

Returns:



4896
 
# File 'lib/increase/models/transaction.rb', line 4896

required :currency, enum: -> { Increase::Transaction::Source::CardSettlement::Currency }

#id ⇒ String

The Card Settlement identifier.

Parameters:

  • value (String)

Returns:

  • (String) 


4862
 
# File 'lib/increase/models/transaction.rb', line 4862

required :id, String

#interchange ⇒ Increase::Models::Transaction::Source::CardSettlement::Interchange?

Interchange assessed as a part of this transaction.

Parameters:

  • value (Increase::Transaction::Source::CardSettlement::Interchange, nil)

Returns:



4902
 
# File 'lib/increase/models/transaction.rb', line 4902

required :interchange, -> { Increase::Transaction::Source::CardSettlement::Interchange }, nil?: true

#merchant_acceptor_id ⇒ String

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

Parameters:

  • value (String)

Returns:

  • (String) 


4909
 
# File 'lib/increase/models/transaction.rb', line 4909

required :merchant_acceptor_id, String

#merchant_category_code ⇒ String

The 4-digit MCC describing the merchant's business.

Parameters:

  • value (String)

Returns:

  • (String) 


4915
 
# File 'lib/increase/models/transaction.rb', line 4915

required :merchant_category_code, String

#merchant_city ⇒ String

The city the merchant resides in.

Parameters:

  • value (String)

Returns:

  • (String) 


4921
 
# File 'lib/increase/models/transaction.rb', line 4921

required :merchant_city, String

#merchant_country ⇒ String

The country the merchant resides in.

Parameters:

  • value (String)

Returns:

  • (String) 


4927
 
# File 'lib/increase/models/transaction.rb', line 4927

required :merchant_country, String

#merchant_name ⇒ String

The name of the merchant.

Parameters:

  • value (String)

Returns:

  • (String) 


4933
 
# File 'lib/increase/models/transaction.rb', line 4933

required :merchant_name, String

#merchant_postal_code ⇒ String?

The merchant's postal code. For US merchants this is always a 5-digit ZIP code.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


4939
 
# File 'lib/increase/models/transaction.rb', line 4939

required :merchant_postal_code, String, nil?: true

#merchant_state ⇒ String?

The state the merchant resides in.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


4945
 
# File 'lib/increase/models/transaction.rb', line 4945

required :merchant_state, String, nil?: true

#network ⇒ Symbol, Increase::Models::Transaction::Source::CardSettlement::Network

The card network on which this transaction was processed.

Parameters:

  • value (Increase::Models::Transaction::Source::CardSettlement::network)

Returns:



4951
 
# File 'lib/increase/models/transaction.rb', line 4951

required :network, enum: -> { Increase::Transaction::Source::CardSettlement::Network }

#network_identifiers ⇒ Increase::Models::Transaction::Source::CardSettlement::NetworkIdentifiers

Network-specific identifiers for this refund.

Parameters:

  • value (Increase::Transaction::Source::CardSettlement::NetworkIdentifiers)

Returns:



4957
 
# File 'lib/increase/models/transaction.rb', line 4957

required :network_identifiers, -> { Increase::Transaction::Source::CardSettlement::NetworkIdentifiers }

#pending_transaction_id ⇒ String?

The identifier of the Pending Transaction associated with this Transaction.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


4963
 
# File 'lib/increase/models/transaction.rb', line 4963

required :pending_transaction_id, String, nil?: true

#presentment_amount ⇒ Integer

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

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


4969
 
# File 'lib/increase/models/transaction.rb', line 4969

required :presentment_amount, Integer

#presentment_currency ⇒ String

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

Parameters:

  • value (String)

Returns:

  • (String) 


4976
 
# File 'lib/increase/models/transaction.rb', line 4976

required :presentment_currency, String

#purchase_details ⇒ Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails?

Additional details about the card purchase, such as tax and industry-specific fields.

Parameters:

  • value (Increase::Transaction::Source::CardSettlement::PurchaseDetails, nil)

Returns:



4983
4984
4985
 
# File 'lib/increase/models/transaction.rb', line 4983

required :purchase_details,
-> { Increase::Transaction::Source::CardSettlement::PurchaseDetails },
nil?: true

#scheme_fees ⇒ Array<Increase::Models::Transaction::Source::CardSettlement::SchemeFee>

The scheme fees associated with this card settlement.

Parameters:

  • value (::Array[Increase::Transaction::Source::CardSettlement::SchemeFee])

Returns:



4991
4992
 
# File 'lib/increase/models/transaction.rb', line 4991

required :scheme_fees,
-> { Increase::Internal::Type::ArrayOf[Increase::Transaction::Source::CardSettlement::SchemeFee] }

#surcharge ⇒ Increase::Models::Transaction::Source::CardSettlement::Surcharge?

Surcharge amount details, if applicable. The amount is positive if the surcharge is added to the overall transaction amount (surcharge), and negative if the surcharge is deducted from the overall transaction amount (discount).

Parameters:

  • value (Increase::Transaction::Source::CardSettlement::Surcharge, nil)

Returns:



5000
 
# File 'lib/increase/models/transaction.rb', line 5000

required :surcharge, -> { Increase::Transaction::Source::CardSettlement::Surcharge }, nil?: true

#transaction_id ⇒ String

The identifier of the Transaction associated with this Transaction.

Parameters:

  • value (String)

Returns:

  • (String) 


5006
 
# File 'lib/increase/models/transaction.rb', line 5006

required :transaction_id, String

#type ⇒ Symbol, Increase::Models::Transaction::Source::CardSettlement::Type

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

Parameters:

  • value (Increase::Models::Transaction::Source::CardSettlement::type_)

Returns:



5013
 
# File 'lib/increase/models/transaction.rb', line 5013

required :type, enum: -> { Increase::Transaction::Source::CardSettlement::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/transaction.rb', line 5133

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


3482
 
# File 'sig/increase/models/transaction.rbs', line 3482

def to_hash: -> {