Class: Increase::Models::CardPayment::Element::CardRefund

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, 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(acquirer_business_id:, acquirer_reference_number:, authorization_identification_response:, 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) —

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

  • acquirer_reference_number (String) —

    A globally unique identifier for this settlement.

  • authorization_identification_response (String, nil) —

    The randomly generated 6-character Authorization Identification Response code se

  • transaction_id (String, nil) —

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




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

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) 


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

required :amount, Integer

#card_payment_id ⇒ String

The ID of the Card Payment this transaction belongs to.

Returns:

  • (String) 


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

required :card_payment_id, String

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

Cashback debited for this transaction, if eligible. Cashback is paid out in aggregate, monthly.

Returns:



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

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

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

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

Returns:



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

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

#id ⇒ String

The Card Refund identifier.

Returns:

  • (String) 


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

required :id, String

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

Interchange assessed as a part of this transaction.

Returns:



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

required :interchange, -> { Increase::CardPayment::Element::CardRefund::Interchange }, nil?: true

#merchant_acceptor_id ⇒ String

The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.

Returns:

  • (String) 


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

required :merchant_acceptor_id, String

#merchant_category_code ⇒ String

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

Returns:

  • (String) 


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

required :merchant_category_code, String

#merchant_city ⇒ String

The city the merchant resides in.

Returns:

  • (String) 


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

required :merchant_city, String

#merchant_country ⇒ String

The country the merchant resides in.

Returns:

  • (String) 


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

required :merchant_country, String

#merchant_name ⇒ String

The name of the merchant.

Returns:

  • (String) 


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

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) 


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

required :merchant_postal_code, String, nil?: true

#merchant_state ⇒ String?

The state the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_state, String, nil?: true

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

Network-specific identifiers for this refund.

Returns:



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

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

#presentment_amount ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


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

required :presentment_currency, String

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

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

Returns:



6780
6781
6782
6783
6784
 
# File 'lib/increase/models/card_payment.rb', line 6780

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

#transaction_id ⇒ String

The identifier of the Transaction associated with this Transaction.

Returns:

  • (String) 


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

required :transaction_id, String

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

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

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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