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, Type Classes: Cashback, Interchange, NetworkIdentifiers, PurchaseDetails

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, 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(acquirer_business_id: , acquirer_reference_number: , transaction_id: ) ⇒ Object

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

Network-specific identifiers for this refund.

Parameters:

  • acquirer_business_id (String) (defaults to: ) —

    A network assigned business ID that identifies the acquirer that processed this

  • acquirer_reference_number (String) (defaults to: ) —

    A globally unique identifier for this settlement.

  • transaction_id (String, nil) (defaults to: ) —

    A globally unique transaction identifier provided by the card network, used acro




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

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) 


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

required :amount, Integer

#card_authorization ⇒ String?

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

Returns:

  • (String, nil) 


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

required :card_authorization, String, nil?: true

#card_payment_id ⇒ String

The ID of the Card Payment this transaction belongs to.

Returns:

  • (String) 


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

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:



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

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:



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

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

#id ⇒ String

The Card Settlement identifier.

Returns:

  • (String) 


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

required :id, String

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

Interchange assessed as a part of this transaction.

Returns:



5561
5562
5563
5564
5565
 
# File 'lib/increase/models/card_payment.rb', line 5561

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) 


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

required :merchant_acceptor_id, String

#merchant_category_code ⇒ String

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

Returns:

  • (String) 


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

required :merchant_category_code, String

#merchant_city ⇒ String

The city the merchant resides in.

Returns:

  • (String) 


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

required :merchant_city, String

#merchant_country ⇒ String

The country the merchant resides in.

Returns:

  • (String) 


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

required :merchant_country, String

#merchant_name ⇒ String

The name of the merchant.

Returns:

  • (String) 


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

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) 


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

required :merchant_postal_code, String, nil?: true

#merchant_state ⇒ String?

The state the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_state, String, nil?: true

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

Network-specific identifiers for this refund.

Returns:



5614
5615
5616
5617
 
# File 'lib/increase/models/card_payment.rb', line 5614

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) 


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

required :pending_transaction_id, String, nil?: true

#presentment_amount ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


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

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:



5643
5644
5645
 
# File 'lib/increase/models/card_payment.rb', line 5643

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

#transaction_id ⇒ String

The identifier of the Transaction associated with this Transaction.

Returns:

  • (String) 


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

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:



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

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 5767