Class: Increase::Models::DeclinedTransaction

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

Overview

See Also:

Defined Under Namespace

Modules: Currency, RouteType, Type Classes: Source

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(id: , account_id: , amount: , created_at: , currency: , description: , route_id: , route_type: , source: , type: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::DeclinedTransaction for more details.

Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.

Parameters:

  • id (String) (defaults to: ) —

    The Declined Transaction identifier.

  • account_id (String) (defaults to: ) —

    The identifier for the Account the Declined Transaction belongs to.

  • amount (Integer) (defaults to: ) —

    The Declined Transaction amount in the minor unit of its currency. For dollars,

  • created_at (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date on which the Transac

  • currency (Symbol, Increase::Models::DeclinedTransaction::Currency) (defaults to: ) —

    The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the Declined Tra

  • description (String) (defaults to: ) —

    This is the description the vendor provides.

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

    The identifier for the route this Declined Transaction came through. Routes are

  • route_type (Symbol, Increase::Models::DeclinedTransaction::RouteType, nil) (defaults to: ) —

    The type of the route this Declined Transaction came through.

  • source (Increase::Models::DeclinedTransaction::Source) (defaults to: ) —

    This is an object giving more details on the network-level event that caused the

  • type (Symbol, Increase::Models::DeclinedTransaction::Type) (defaults to: ) —

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




# File 'lib/increase/models/declined_transaction.rb', line 77

Instance Attribute Details

#account_id ⇒ String

The identifier for the Account the Declined Transaction belongs to.

Returns:

  • (String) 


17
 
# File 'lib/increase/models/declined_transaction.rb', line 17

required :account_id, String

#amount ⇒ Integer

The Declined Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


24
 
# File 'lib/increase/models/declined_transaction.rb', line 24

required :amount, Integer

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occurred.

Returns:

  • (Time) 


31
 
# File 'lib/increase/models/declined_transaction.rb', line 31

required :created_at, Time

#currency ⇒ Symbol, Increase::Models::DeclinedTransaction::Currency

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the Declined Transaction’s currency. This will match the currency on the Declined Transaction’s Account.

Returns:



39
 
# File 'lib/increase/models/declined_transaction.rb', line 39

required :currency, enum: -> { Increase::DeclinedTransaction::Currency }

#description ⇒ String

This is the description the vendor provides.

Returns:

  • (String) 


45
 
# File 'lib/increase/models/declined_transaction.rb', line 45

required :description, String

#id ⇒ String

The Declined Transaction identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/declined_transaction.rb', line 11

required :id, String

#route_id ⇒ String?

The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details.

Returns:

  • (String, nil) 


52
 
# File 'lib/increase/models/declined_transaction.rb', line 52

required :route_id, String, nil?: true

#route_type ⇒ Symbol, ...

The type of the route this Declined Transaction came through.

Returns:



58
 
# File 'lib/increase/models/declined_transaction.rb', line 58

required :route_type, enum: -> { Increase::DeclinedTransaction::RouteType }, nil?: true

#source ⇒ Increase::Models::DeclinedTransaction::Source

This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant’s industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.

Returns:



68
 
# File 'lib/increase/models/declined_transaction.rb', line 68

required :source, -> { Increase::DeclinedTransaction::Source }

#type ⇒ Symbol, Increase::Models::DeclinedTransaction::Type

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

Returns:



75
 
# File 'lib/increase/models/declined_transaction.rb', line 75

required :type, enum: -> { Increase::DeclinedTransaction::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/declined_transaction.rb', line 116