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 to the overall transaction amount (surcharge), and negative if the surcharge is deducted from the overall transaction amount (discount).

Parameters:

  • amount (Integer) (defaults to: ) —

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

  • presentment_amount (Integer) (defaults to: ) —

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




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

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) 


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

required :amount, Integer

#card_authorization ⇒ String?

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

Returns:

  • (String, nil) 


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

required :card_authorization, String, nil?: true

#card_payment_id ⇒ String

The ID of the Card Payment this transaction belongs to.

Returns:

  • (String) 


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

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:



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

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:



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

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

#id ⇒ String

The Card Settlement identifier.

Returns:

  • (String) 


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

required :id, String

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

Interchange assessed as a part of this transaction.

Returns:



5792
5793
5794
5795
5796
 
# File 'lib/increase/models/card_payment.rb', line 5792

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) 


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

required :merchant_acceptor_id, String

#merchant_category_code ⇒ String

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

Returns:

  • (String) 


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

required :merchant_category_code, String

#merchant_city ⇒ String

The city the merchant resides in.

Returns:

  • (String) 


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

required :merchant_city, String

#merchant_country ⇒ String

The country the merchant resides in.

Returns:

  • (String) 


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

required :merchant_country, String

#merchant_name ⇒ String

The name of the merchant.

Returns:

  • (String) 


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

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) 


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

required :merchant_postal_code, String, nil?: true

#merchant_state ⇒ String?

The state the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_state, String, nil?: true

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

The card network on which this transaction was processed.

Returns:



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

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

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

Network-specific identifiers for this refund.

Returns:



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

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) 


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

required :pending_transaction_id, String, nil?: true

#presentment_amount ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


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

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:



5877
5878
5879
 
# File 'lib/increase/models/card_payment.rb', line 5877

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 to the overall transaction amount (surcharge), and negative if the surcharge is deducted from the overall transaction amount (discount).

Returns:



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

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

#transaction_id ⇒ String

The identifier of the Transaction associated with this Transaction.

Returns:

  • (String) 


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

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:



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

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 6010