Class: Increase::Models::CardPayment::Element::CardReversal

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

Overview

See Also:

Defined Under Namespace

Modules: Currency, Network, ReversalReason, Type Classes: NetworkIdentifiers

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(retrieval_reference_number: , trace_number: , transaction_id: ) ⇒ Object

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

Network-specific identifiers for a specific request or transaction.

Parameters:

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

    A life-cycle identifier used across e.g., an authorization and a reversal. Expec

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

    A counter used to verify an individual authorization. Expected to be unique per

  • 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 4215

Instance Attribute Details

#card_authorization_id ⇒ String

The identifier for the Card Authorization this reverses.

Returns:

  • (String) 


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

required :card_authorization_id, String

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

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

Returns:



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

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

#id ⇒ String

The Card Reversal identifier.

Returns:

  • (String) 


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

required :id, String

#merchant_acceptor_id ⇒ String

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

Returns:

  • (String) 


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

required :merchant_acceptor_id, String

#merchant_category_code ⇒ String

The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.

Returns:

  • (String) 


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

required :merchant_category_code, String

#merchant_city ⇒ String?

The city the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_city, String, nil?: true

#merchant_country ⇒ String?

The country the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_country, String, nil?: true

#merchant_descriptor ⇒ String

The merchant descriptor of the merchant the card is transacting with.

Returns:

  • (String) 


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

required :merchant_descriptor, String

#merchant_postal_code ⇒ String?

The merchant’s postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash.

Returns:

  • (String, nil) 


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

required :merchant_postal_code, String, nil?: true

#merchant_state ⇒ String?

The state the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_state, String, nil?: true

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

The card network used to process this card authorization.

Returns:



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

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

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

Network-specific identifiers for a specific request or transaction.

Returns:



4168
4169
4170
4171
 
# File 'lib/increase/models/card_payment.rb', line 4168

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

#pending_transaction_id ⇒ String?

The identifier of the Pending Transaction associated with this Card Reversal.

Returns:

  • (String, nil) 


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

required :pending_transaction_id, String, nil?: true

#reversal_amount ⇒ Integer

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

Returns:

  • (Integer) 


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

required :reversal_amount, Integer

#reversal_reason ⇒ Symbol, ...

Why this reversal was initiated.

Returns:



4190
4191
4192
 
# File 'lib/increase/models/card_payment.rb', line 4190

required :reversal_reason,
enum: -> { Increase::CardPayment::Element::CardReversal::ReversalReason },
nil?: true

#terminal_id ⇒ String?

The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.

Returns:

  • (String, nil) 


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

required :terminal_id, String, nil?: true

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

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

Returns:



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

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

#updated_authorization_amount ⇒ Integer

The amount left pending on the Card Authorization in the minor unit of the transaction’s currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


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

required :updated_authorization_amount, Integer

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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