Class: Increase::Models::InboundWireTransfer

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

Overview

See Also:

Defined Under Namespace

Modules: Status, Type Classes: Reversal

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:, account_number_id:, amount:, created_at:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, reversal:, status:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:, wire_drawdown_request_id:) ⇒ Object

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

An Inbound Wire Transfer is a wire transfer initiated outside of Increase to your account.

Parameters:

  • id (String) —

    The inbound wire transfer’s identifier.

  • account_id (String) —

    The Account to which the transfer belongs.

  • account_number_id (String) —

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

  • amount (Integer) —

    The amount in USD cents.

  • created_at (Time) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which th

  • creditor_address_line1 (String, nil) —

    A free-form address field set by the sender.

  • creditor_address_line2 (String, nil) —

    A free-form address field set by the sender.

  • creditor_address_line3 (String, nil) —

    A free-form address field set by the sender.

  • creditor_name (String, nil) —

    A name set by the sender.

  • debtor_address_line1 (String, nil) —

    A free-form address field set by the sender.

  • debtor_address_line2 (String, nil) —

    A free-form address field set by the sender.

  • debtor_address_line3 (String, nil) —

    A free-form address field set by the sender.

  • debtor_name (String, nil) —

    A name set by the sender.

  • description (String) —

    An Increase-constructed description of the transfer.

  • end_to_end_identification (String, nil) —

    A free-form reference string set by the sender, to help identify the transfer.

  • input_message_accountability_data (String, nil) —

    A unique identifier available to the originating and receiving banks, commonly a

  • instructing_agent_routing_number (String, nil) —

    The American Banking Association (ABA) routing number of the bank that sent the

  • instruction_identification (String, nil) —

    The sending bank’s identifier for the wire transfer.

  • reversal (Increase::Models::InboundWireTransfer::Reversal, nil) —

    Information about the reversal of the inbound wire transfer if it has been rever

  • status (Symbol, Increase::Models::InboundWireTransfer::Status) —

    The status of the transfer.

  • type (Symbol, Increase::Models::InboundWireTransfer::Type) —

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

  • unique_end_to_end_transaction_reference (String, nil) —

    The Unique End-to-end Transaction Reference ([UETR](www.swift.com/paymen

  • unstructured_remittance_information (String, nil) —

    A free-form message set by the sender.

  • wire_drawdown_request_id (String, nil) —

    The wire drawdown request the inbound wire transfer is fulfilling.




# File 'lib/increase/models/inbound_wire_transfer.rb', line 159

Instance Attribute Details

#account_id ⇒ String

The Account to which the transfer belongs.

Returns:

  • (String) 


17
 
# File 'lib/increase/models/inbound_wire_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_wire_transfer.rb', line 23

required :account_number_id, String

#amount ⇒ Integer

The amount in USD cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#created_at ⇒ Time

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

Returns:

  • (Time) 


36
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 36

required :created_at, Time

#creditor_address_line1 ⇒ String?

A free-form address field set by the sender.

Returns:

  • (String, nil) 


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

required :creditor_address_line1, String, nil?: true

#creditor_address_line2 ⇒ String?

A free-form address field set by the sender.

Returns:

  • (String, nil) 


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

required :creditor_address_line2, String, nil?: true

#creditor_address_line3 ⇒ String?

A free-form address field set by the sender.

Returns:

  • (String, nil) 


54
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 54

required :creditor_address_line3, String, nil?: true

#creditor_name ⇒ String?

A name set by the sender.

Returns:

  • (String, nil) 


60
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 60

required :creditor_name, String, nil?: true

#debtor_address_line1 ⇒ String?

A free-form address field set by the sender.

Returns:

  • (String, nil) 


66
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 66

required :debtor_address_line1, String, nil?: true

#debtor_address_line2 ⇒ String?

A free-form address field set by the sender.

Returns:

  • (String, nil) 


72
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 72

required :debtor_address_line2, String, nil?: true

#debtor_address_line3 ⇒ String?

A free-form address field set by the sender.

Returns:

  • (String, nil) 


78
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 78

required :debtor_address_line3, String, nil?: true

#debtor_name ⇒ String?

A name set by the sender.

Returns:

  • (String, nil) 


84
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 84

required :debtor_name, String, nil?: true

#description ⇒ String

An Increase-constructed description of the transfer.

Returns:

  • (String) 


90
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 90

required :description, String

#end_to_end_identification ⇒ String?

A free-form reference string set by the sender, to help identify the transfer.

Returns:

  • (String, nil) 


96
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 96

required :end_to_end_identification, String, nil?: true

#id ⇒ String

The inbound wire transfer’s identifier.

Returns:

  • (String) 


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

required :id, String

#input_message_accountability_data ⇒ String?

A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD. It is created when the wire is submitted to the Fedwire service and is helpful when debugging wires with the originating bank.

Returns:

  • (String, nil) 


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

required :input_message_accountability_data, String, nil?: true

#instructing_agent_routing_number ⇒ String?

The American Banking Association (ABA) routing number of the bank that sent the wire.

Returns:

  • (String, nil) 


111
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 111

required :instructing_agent_routing_number, String, nil?: true

#instruction_identification ⇒ String?

The sending bank’s identifier for the wire transfer.

Returns:

  • (String, nil) 


117
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 117

required :instruction_identification, String, nil?: true

#reversal ⇒ Increase::Models::InboundWireTransfer::Reversal?

Information about the reversal of the inbound wire transfer if it has been reversed.

Returns:



124
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 124

required :reversal, -> { Increase::InboundWireTransfer::Reversal }, nil?: true

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

The status of the transfer.

Returns:



130
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 130

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

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

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

Returns:



137
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 137

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

#unique_end_to_end_transaction_reference ⇒ String?

The Unique End-to-end Transaction Reference ([UETR](www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer.

Returns:

  • (String, nil) 


145
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 145

required :unique_end_to_end_transaction_reference, String, nil?: true

#unstructured_remittance_information ⇒ String?

A free-form message set by the sender.

Returns:

  • (String, nil) 


151
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 151

required :unstructured_remittance_information, String, nil?: true

#wire_drawdown_request_id ⇒ String?

The wire drawdown request the inbound wire transfer is fulfilling.

Returns:

  • (String, nil) 


157
 
# File 'lib/increase/models/inbound_wire_transfer.rb', line 157

required :wire_drawdown_request_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/inbound_wire_transfer.rb', line 255