Class: Increase::Models::InboundRealTimePaymentsTransfer

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

Overview

See Also:

Defined Under Namespace

Modules: Currency, Status, Type Classes: Confirmation, Decline

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

If your transfer is confirmed, this will contain details of the confirmation.

Parameters:

  • confirmed_at (Time) (defaults to: ) —

    The time at which the transfer was confirmed.

  • transaction_id (String) (defaults to: ) —

    The id of the transaction for the confirmed transfer.




# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 106

Instance Attribute Details

#account_id ⇒ String

The Account to which the transfer was sent.

Returns:

  • (String) 


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

required :account_id, String

#account_number_id ⇒ String

The identifier of the Account Number to which this transfer was sent.

Returns:

  • (String) 


23
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 23

required :account_number_id, String

#amount ⇒ Integer

The amount in USD cents.

Returns:

  • (Integer) 


29
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 29

required :amount, Integer

#confirmation ⇒ Increase::Models::InboundRealTimePaymentsTransfer::Confirmation?

If your transfer is confirmed, this will contain details of the confirmation.

Returns:



35
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 35

required :confirmation, -> { Increase::InboundRealTimePaymentsTransfer::Confirmation }, nil?: true

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.

Returns:

  • (Time) 


42
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 42

required :created_at, Time

#creditor_name ⇒ String

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

Returns:

  • (String) 


48
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 48

required :creditor_name, String

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

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

Returns:



55
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 55

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

#debtor_account_number ⇒ String

The account number of the account that sent the transfer.

Returns:

  • (String) 


61
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 61

required :debtor_account_number, String

#debtor_name ⇒ String

The name provided by the sender of the transfer.

Returns:

  • (String) 


67
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 67

required :debtor_name, String

#debtor_routing_number ⇒ String

The routing number of the account that sent the transfer.

Returns:

  • (String) 


73
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 73

required :debtor_routing_number, String

#decline ⇒ Increase::Models::InboundRealTimePaymentsTransfer::Decline?

If your transfer is declined, this will contain details of the decline.

Returns:



79
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 79

required :decline, -> { Increase::InboundRealTimePaymentsTransfer::Decline }, nil?: true

#id ⇒ String

The inbound Real-Time Payments transfer’s identifier.

Returns:

  • (String) 


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

required :id, String

#remittance_information ⇒ String?

Additional information included with the transfer.

Returns:

  • (String, nil) 


85
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 85

required :remittance_information, String, nil?: true

#status ⇒ Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Status

The lifecycle status of the transfer.

Returns:



91
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 91

required :status, enum: -> { Increase::InboundRealTimePaymentsTransfer::Status }

#transaction_identification ⇒ String

The Real-Time Payments network identification of the transfer.

Returns:

  • (String) 


97
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 97

required :transaction_identification, String

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

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

Returns:



104
 
# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 104

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/inbound_real_time_payments_transfer.rb', line 177