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:

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

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




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

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:

Returns:



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

required :amount, Integer

#card_authorization ⇒ String?

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

Parameters:

Returns:



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

required :card_authorization, String, nil?: true

#card_payment_id ⇒ String

The ID of the Card Payment this transaction belongs to.

Parameters:

Returns:



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

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:

Returns:



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

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:

Returns:



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

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

#id ⇒ String

The Card Settlement identifier.

Parameters:

Returns:



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

required :id, String

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

Interchange assessed as a part of this transaction.

Parameters:

Returns:



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

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:

Returns:



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

required :merchant_acceptor_id, String

#merchant_category_code ⇒ String

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

Parameters:

Returns:



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

required :merchant_category_code, String

#merchant_city ⇒ String

The city the merchant resides in.

Parameters:

Returns:



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

required :merchant_city, String

#merchant_country ⇒ String

The country the merchant resides in.

Parameters:

Returns:



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

required :merchant_country, String

#merchant_name ⇒ String

The name of the merchant.

Parameters:

Returns:



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

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:

Returns:



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

required :merchant_postal_code, String, nil?: true

#merchant_state ⇒ String?

The state the merchant resides in.

Parameters:

Returns:



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

required :merchant_state, String, nil?: true

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

The card network on which this transaction was processed.

Parameters:

Returns:



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

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

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

Network-specific identifiers for this refund.

Parameters:

Returns:



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

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

#pending_transaction_id ⇒ String?

The identifier of the Pending Transaction associated with this Transaction.

Parameters:

Returns:



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

required :pending_transaction_id, String, nil?: true

#presentment_amount ⇒ Integer

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

Parameters:

Returns:



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

required :presentment_amount, Integer

#presentment_currency ⇒ String

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

Parameters:

Returns:



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

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:

Returns:



5049
5050
5051
 
# File 'lib/increase/models/transaction.rb', line 5049

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:

Returns:



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

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:

Returns:



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

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

#transaction_id ⇒ String

The identifier of the Transaction associated with this Transaction.

Parameters:

Returns:



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

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:

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:




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

Instance Method Details

#to_hash ⇒ {

Returns:



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

def to_hash: -> {