Class: Increase::Models::CardPayment::Element::CardDecline

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

Overview

See Also:

Defined Under Namespace

Modules: Actioner, Currency, Direction, ProcessingCategory, RealTimeDecisionReason, Reason Classes: NetworkDetails, NetworkIdentifiers, Verification

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 1687

Instance Attribute Details

#actioner ⇒ Symbol, Increase::Models::CardPayment::Element::CardDecline::Actioner

Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision.

Returns:



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

required :actioner, enum: -> { Increase::CardPayment::Element::CardDecline::Actioner }

#amount ⇒ Integer

The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#card_payment_id ⇒ String

The ID of the Card Payment this transaction belongs to.

Returns:

  • (String) 


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

required :card_payment_id, String

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

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.

Returns:



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

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

#declined_transaction_id ⇒ String

The identifier of the declined transaction created for this Card Decline.

Returns:

  • (String) 


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

required :declined_transaction_id, String

#digital_wallet_token_id ⇒ String?

If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.

Returns:

  • (String, nil) 


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

required :digital_wallet_token_id, String, nil?: true

#direction ⇒ Symbol, Increase::Models::CardPayment::Element::CardDecline::Direction

The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder.

Returns:



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

required :direction, enum: -> { Increase::CardPayment::Element::CardDecline::Direction }

#id ⇒ String

The Card Decline identifier.

Returns:

  • (String) 


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

required :id, String

#merchant_acceptor_id ⇒ String

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

Returns:

  • (String) 


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

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) 


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

required :merchant_category_code, String

#merchant_city ⇒ String?

The city the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_city, String, nil?: true

#merchant_country ⇒ String

The country the merchant resides in.

Returns:

  • (String) 


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

required :merchant_country, String

#merchant_descriptor ⇒ String

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

Returns:

  • (String) 


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

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) 


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

required :merchant_postal_code, String, nil?: true

#merchant_state ⇒ String?

The state the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_state, String, nil?: true

#network_details ⇒ Increase::Models::CardPayment::Element::CardDecline::NetworkDetails

Fields specific to the ‘network`.

Returns:



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

required :network_details, -> { Increase::CardPayment::Element::CardDecline::NetworkDetails }

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

Network-specific identifiers for a specific request or transaction.

Returns:



1612
1613
1614
1615
 
# File 'lib/increase/models/card_payment.rb', line 1612

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

#network_risk_score ⇒ Integer?

The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest.

Returns:

  • (Integer, nil) 


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

required :network_risk_score, Integer, nil?: true

#physical_card_id ⇒ String?

If the authorization was made in-person with a physical card, the Physical Card that was used.

Returns:

  • (String, nil) 


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

required :physical_card_id, String, nil?: true

#presentment_amount ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


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

required :presentment_currency, String

#processing_category ⇒ Symbol, Increase::Models::CardPayment::Element::CardDecline::ProcessingCategory

The processing category describes the intent behind the authorization, such as whether it was used for bill payments or an automatic fuel dispenser.

Returns:



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

required :processing_category,
enum: -> { Increase::CardPayment::Element::CardDecline::ProcessingCategory }

#real_time_decision_id ⇒ String?

The identifier of the Real-Time Decision sent to approve or decline this transaction.

Returns:

  • (String, nil) 


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

required :real_time_decision_id, String, nil?: true

#real_time_decision_reason ⇒ Symbol, ...

This is present if a specific decline reason was given in the real-time decision.

Returns:



1664
1665
1666
 
# File 'lib/increase/models/card_payment.rb', line 1664

required :real_time_decision_reason,
enum: -> { Increase::CardPayment::Element::CardDecline::RealTimeDecisionReason },
nil?: true

#reason ⇒ Symbol, Increase::Models::CardPayment::Element::CardDecline::Reason

Why the transaction was declined.

Returns:



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

required :reason, enum: -> { Increase::CardPayment::Element::CardDecline::Reason }

#terminal_id ⇒ String?

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

Returns:

  • (String, nil) 


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

required :terminal_id, String, nil?: true

#verification ⇒ Increase::Models::CardPayment::Element::CardDecline::Verification

Fields related to verification of cardholder-provided values.

Returns:



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

required :verification, -> { Increase::CardPayment::Element::CardDecline::Verification }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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