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

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

Overview

See Also:

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

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

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 4655

Instance Attribute Details

#amount ⇒ Integer

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

Returns:

  • (Integer) 


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

required :amount, Integer

#card_authorization ⇒ String?

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

Returns:

  • (String, nil) 


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

required :card_authorization, String, nil?: true

#card_payment_id ⇒ String

The ID of the Card Payment this transaction belongs to.

Returns:

  • (String) 


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

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.

Returns:



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

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

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

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

Returns:



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

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

#id ⇒ String

The Card Settlement identifier.

Returns:

  • (String) 


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

required :id, String

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

Interchange assessed as a part of this transaction.

Returns:



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

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.

Returns:

  • (String) 


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

required :merchant_acceptor_id, String

#merchant_category_code ⇒ String

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

Returns:

  • (String) 


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

required :merchant_category_code, String

#merchant_city ⇒ String

The city the merchant resides in.

Returns:

  • (String) 


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

required :merchant_city, String

#merchant_country ⇒ String

The country the merchant resides in.

Returns:

  • (String) 


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

required :merchant_country, String

#merchant_name ⇒ String

The name of the merchant.

Returns:

  • (String) 


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

required :merchant_name, String

#merchant_postal_code ⇒ String?

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

Returns:

  • (String, nil) 


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

required :merchant_postal_code, String, nil?: true

#merchant_state ⇒ String?

The state the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_state, String, nil?: true

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

The card network on which this transaction was processed.

Returns:



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

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

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

Network-specific identifiers for this refund.

Returns:



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

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

#pending_transaction_id ⇒ String?

The identifier of the Pending Transaction associated with this Transaction.

Returns:

  • (String, nil) 


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

required :pending_transaction_id, String, nil?: true

#presentment_amount ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


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

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.

Returns:



4623
4624
4625
 
# File 'lib/increase/models/transaction.rb', line 4623

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.

Returns:



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

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

Returns:



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

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

#transaction_id ⇒ String

The identifier of the Transaction associated with this Transaction.

Returns:

  • (String) 


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

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`.

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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