Class: Increase::Models::CardPayment::Element::CardSettlement

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

Overview

See Also:

Defined Under Namespace

Modules: Currency, Network, Type Classes: Cashback, Interchange, NetworkIdentifiers, PurchaseDetails, 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/card_payment.rb', line 8458

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) 


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

required :amount, Integer

#card_authorization ⇒ String?

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

Returns:

  • (String, nil) 


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

required :card_authorization, String, nil?: true

#card_payment_id ⇒ String

The ID of the Card Payment this transaction belongs to.

Returns:

  • (String) 


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

required :card_payment_id, String

#cashback ⇒ Increase::Models::CardPayment::Element::CardSettlement::Cashback?

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

Returns:



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

required :cashback, -> { Increase::CardPayment::Element::CardSettlement::Cashback }, nil?: true

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

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

Returns:



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

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

#id ⇒ String

The Card Settlement identifier.

Returns:

  • (String) 


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

required :id, String

#interchange ⇒ Increase::Models::CardPayment::Element::CardSettlement::Interchange?

Interchange assessed as a part of this transaction.

Returns:



8348
8349
8350
8351
8352
 
# File 'lib/increase/models/card_payment.rb', line 8348

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


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

required :merchant_acceptor_id, String

#merchant_category_code ⇒ String

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

Returns:

  • (String) 


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

required :merchant_category_code, String

#merchant_city ⇒ String

The city the merchant resides in.

Returns:

  • (String) 


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

required :merchant_city, String

#merchant_country ⇒ String

The country the merchant resides in.

Returns:

  • (String) 


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

required :merchant_country, String

#merchant_name ⇒ String

The name of the merchant.

Returns:

  • (String) 


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

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) 


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

required :merchant_postal_code, String, nil?: true

#merchant_state ⇒ String?

The state the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_state, String, nil?: true

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

The card network on which this transaction was processed.

Returns:



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

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

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

Network-specific identifiers for this refund.

Returns:



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

required :network_identifiers, -> { Increase::CardPayment::Element::CardSettlement::NetworkIdentifiers }

#pending_transaction_id ⇒ String?

The identifier of the Pending Transaction associated with this Transaction.

Returns:

  • (String, nil) 


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

required :pending_transaction_id, String, nil?: true

#presentment_amount ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


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

required :presentment_currency, String

#purchase_details ⇒ Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails?

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

Returns:



8433
8434
8435
 
# File 'lib/increase/models/card_payment.rb', line 8433

required :purchase_details,
-> { Increase::CardPayment::Element::CardSettlement::PurchaseDetails },
nil?: true

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



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

required :surcharge, -> { Increase::CardPayment::Element::CardSettlement::Surcharge }, nil?: true

#transaction_id ⇒ String

The identifier of the Transaction associated with this Transaction.

Returns:

  • (String) 


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

required :transaction_id, String

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

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

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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