Class: Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline

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

Overview

See Also:

Defined Under Namespace

Modules: Currency, Reason

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(amount: , creditor_name: , currency: , debtor_account_number: , debtor_name: , debtor_routing_number: , reason: , remittance_information: , transaction_identification: , transfer_id: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline for more details.

An Inbound Real-Time Payments Transfer Decline object. This field will be present in the JSON response if and only if ‘category` is equal to `inbound_real_time_payments_transfer_decline`.

Parameters:

  • amount (Integer) (defaults to: ) —

    The declined amount in the minor unit of the destination account currency. For d

  • creditor_name (String) (defaults to: ) —

    The name the sender of the transfer specified as the recipient of the transfer.

  • currency (Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Currency) (defaults to: ) —

    The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code of the declined tran

  • debtor_account_number (String) (defaults to: ) —

    The account number of the account that sent the transfer.

  • debtor_name (String) (defaults to: ) —

    The name provided by the sender of the transfer.

  • debtor_routing_number (String) (defaults to: ) —

    The routing number of the account that sent the transfer.

  • reason (Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Reason) (defaults to: ) —

    Why the transfer was declined.

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

    Additional information included with the transfer.

  • transaction_identification (String) (defaults to: ) —

    The Real-Time Payments network identification of the declined transfer.

  • transfer_id (String) (defaults to: ) —

    The identifier of the Real-Time Payments Transfer that led to this Transaction.




# File 'lib/increase/models/transaction.rb', line 5043

Instance Attribute Details

#amount ⇒ Integer

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

Returns:

  • (Integer) 


4981
 
# File 'lib/increase/models/transaction.rb', line 4981

required :amount, Integer

#creditor_name ⇒ String

The name the sender of the transfer specified as the recipient of the transfer.

Returns:

  • (String) 


4987
 
# File 'lib/increase/models/transaction.rb', line 4987

required :creditor_name, String

#currency ⇒ Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Currency

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code of the declined transfer’s currency. This will always be “USD” for a Real-Time Payments transfer.

Returns:



4995
4996
4997
4998
 
# File 'lib/increase/models/transaction.rb', line 4995

required :currency,
enum: -> {
  Increase::Transaction::Source::InboundRealTimePaymentsTransferDecline::Currency
}

#debtor_account_number ⇒ String

The account number of the account that sent the transfer.

Returns:

  • (String) 


5004
 
# File 'lib/increase/models/transaction.rb', line 5004

required :debtor_account_number, String

#debtor_name ⇒ String

The name provided by the sender of the transfer.

Returns:

  • (String) 


5010
 
# File 'lib/increase/models/transaction.rb', line 5010

required :debtor_name, String

#debtor_routing_number ⇒ String

The routing number of the account that sent the transfer.

Returns:

  • (String) 


5016
 
# File 'lib/increase/models/transaction.rb', line 5016

required :debtor_routing_number, String

#reason ⇒ Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Reason

Why the transfer was declined.

Returns:



5022
5023
 
# File 'lib/increase/models/transaction.rb', line 5022

required :reason,
enum: -> { Increase::Transaction::Source::InboundRealTimePaymentsTransferDecline::Reason }

#remittance_information ⇒ String?

Additional information included with the transfer.

Returns:

  • (String, nil) 


5029
 
# File 'lib/increase/models/transaction.rb', line 5029

required :remittance_information, String, nil?: true

#transaction_identification ⇒ String

The Real-Time Payments network identification of the declined transfer.

Returns:

  • (String) 


5035
 
# File 'lib/increase/models/transaction.rb', line 5035

required :transaction_identification, String

#transfer_id ⇒ String

The identifier of the Real-Time Payments Transfer that led to this Transaction.

Returns:

  • (String) 


5041
 
# File 'lib/increase/models/transaction.rb', line 5041

required :transfer_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/transaction.rb', line 5098