Class: Increase::Models::InboundWireTransfer

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::InboundWireTransfer

Defined in:

lib/increase/models/inbound_wire_transfer.rb

Overview

See Also:

• Resources::InboundWireTransfers#retrieve

Defined Under Namespace

Modules: Status, Type Classes: Reversal

Instance Attribute Summary

• #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.

• #beneficiary_address_line1 ⇒ String^?

  A free-form address field set by the sender.

• #beneficiary_address_line2 ⇒ String^?

  A free-form address field set by the sender.

• #beneficiary_address_line3 ⇒ String^?

  A free-form address field set by the sender.

• #beneficiary_name ⇒ String^?

  A name set by the sender.

• #beneficiary_reference ⇒ String^?

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

• #created_at ⇒ Time

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

• #creditor_address_line1 ⇒ String^?

  A free-form address field set by the sender.

• #creditor_address_line2 ⇒ String^?

  A free-form address field set by the sender.

• #creditor_address_line3 ⇒ String^?

  A free-form address field set by the sender.

• #creditor_name ⇒ String^?

  A name set by the sender.

• #debtor_address_line1 ⇒ String^?

  A free-form address field set by the sender.

• #debtor_address_line2 ⇒ String^?

  A free-form address field set by the sender.

• #debtor_address_line3 ⇒ String^?

  A free-form address field set by the sender.

• #debtor_name ⇒ String^?

  A name set by the sender.

• #description ⇒ String

  An Increase-constructed description of the transfer.

• #end_to_end_identification ⇒ String^?

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

• #id ⇒ String

  The inbound wire transfer’s identifier.

• #input_message_accountability_data ⇒ String^?

  A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD.

• #instructing_agent_routing_number ⇒ String^?

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

• #instruction_identification ⇒ String^?

  The sending bank’s identifier for the wire transfer.

• #originator_address_line1 ⇒ String^?

  The address of the wire originator, set by the sending bank.

• #originator_address_line2 ⇒ String^?

  The address of the wire originator, set by the sending bank.

• #originator_address_line3 ⇒ String^?

  The address of the wire originator, set by the sending bank.

• #originator_name ⇒ String^?

  The originator of the wire, set by the sending bank.

• #originator_routing_number ⇒ String^?

  The American Banking Association (ABA) routing number of the bank originating the transfer.

• #originator_to_beneficiary_information ⇒ String^?

  An Increase-created concatenation of the Originator-to-Beneficiary lines.

• #originator_to_beneficiary_information_line1 ⇒ String^?

  A free-form message set by the wire originator.

• #originator_to_beneficiary_information_line2 ⇒ String^?

  A free-form message set by the wire originator.

• #originator_to_beneficiary_information_line3 ⇒ String^?

  A free-form message set by the wire originator.

• #originator_to_beneficiary_information_line4 ⇒ String^?

  A free-form message set by the wire originator.

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

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

• #sender_reference ⇒ String^?

  The sending bank’s reference number for the wire transfer.

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

  The status of the transfer.

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

  A constant representing the object’s 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.

• #unstructured_remittance_information ⇒ String^?

  A free-form message set by the sender.

• #wire_drawdown_request_id ⇒ String^?

  The wire drawdown request the inbound wire transfer is fulfilling.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id: , account_id: , account_number_id: , amount: , beneficiary_address_line1: , beneficiary_address_line2: , beneficiary_address_line3: , beneficiary_name: , beneficiary_reference: , 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: , originator_address_line1: , originator_address_line2: , originator_address_line3: , originator_name: , originator_routing_number: , originator_to_beneficiary_information: , originator_to_beneficiary_information_line1: , originator_to_beneficiary_information_line2: , originator_to_beneficiary_information_line3: , originator_to_beneficiary_information_line4: , reversal: , sender_reference: , status: , type: , unique_end_to_end_transaction_reference: , unstructured_remittance_information: , wire_drawdown_request_id: ) ⇒ Object constructor

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

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: , beneficiary_address_line1: , beneficiary_address_line2: , beneficiary_address_line3: , beneficiary_name: , beneficiary_reference: , 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: , originator_address_line1: , originator_address_line2: , originator_address_line3: , originator_name: , originator_routing_number: , originator_to_beneficiary_information: , originator_to_beneficiary_information_line1: , originator_to_beneficiary_information_line2: , originator_to_beneficiary_information_line3: , originator_to_beneficiary_information_line4: , reversal: , sender_reference: , 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) (defaults to: ) —

  The inbound wire transfer’s identifier.

• account_id (String) (defaults to: ) —

  The Account to which the transfer belongs.

• account_number_id (String) (defaults to: ) —

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

• amount (Integer) (defaults to: ) —

  The amount in USD cents.

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

  A free-form address field set by the sender.

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

  A free-form address field set by the sender.

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

  A free-form address field set by the sender.

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

  A name set by the sender.

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

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

• created_at (Time) (defaults to: ) —

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

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

  A free-form address field set by the sender.

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

  A free-form address field set by the sender.

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

  A free-form address field set by the sender.

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

  A name set by the sender.

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

  A free-form address field set by the sender.

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

  A free-form address field set by the sender.

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

  A free-form address field set by the sender.

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

  A name set by the sender.

• description (String) (defaults to: ) —

  An Increase-constructed description of the transfer.

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

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

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

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

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

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

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

  The sending bank’s identifier for the wire transfer.

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

  The address of the wire originator, set by the sending bank.

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

  The address of the wire originator, set by the sending bank.

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

  The address of the wire originator, set by the sending bank.

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

  The originator of the wire, set by the sending bank.

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

  The American Banking Association (ABA) routing number of the bank originating th

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

  An Increase-created concatenation of the Originator-to-Beneficiary lines.

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

  A free-form message set by the wire originator.

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

  A free-form message set by the wire originator.

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

  A free-form message set by the wire originator.

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

  A free-form message set by the wire originator.

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

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

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

  The sending bank’s reference number for the wire transfer.

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

  The status of the transfer.

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

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

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

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

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

  A free-form message set by the sender.

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

  The wire drawdown request the inbound wire transfer is fulfilling.

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

Instance Attribute Details

#account_id ⇒ String

The Account to which the transfer belongs.

Returns:

• (String)

# 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)

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

required :account_number_id, String

#amount ⇒ Integer

The amount in USD cents.

Returns:

• (Integer)

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

required :amount, Integer

#beneficiary_address_line1 ⇒ String^?

A free-form address field set by the sender.

Returns:

• (String, nil)

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

required :beneficiary_address_line1, String, nil?: true

#beneficiary_address_line2 ⇒ String^?

A free-form address field set by the sender.

Returns:

• (String, nil)

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

required :beneficiary_address_line2, String, nil?: true

#beneficiary_address_line3 ⇒ String^?

A free-form address field set by the sender.

Returns:

• (String, nil)

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

required :beneficiary_address_line3, String, nil?: true

#beneficiary_name ⇒ String^?

A name set by the sender.

Returns:

• (String, nil)

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

required :beneficiary_name, String, nil?: true

#beneficiary_reference ⇒ String^?

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

Returns:

• (String, nil)

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

required :beneficiary_reference, String, nil?: true

#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)

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

required :created_at, Time

#creditor_address_line1 ⇒ String^?

A free-form address field set by the sender.

Returns:

• (String, nil)

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

required :creditor_address_line1, String, nil?: true

#creditor_address_line2 ⇒ String^?

A free-form address field set by the sender.

Returns:

• (String, nil)

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

required :creditor_address_line2, String, nil?: true

#creditor_address_line3 ⇒ String^?

A free-form address field set by the sender.

Returns:

• (String, nil)

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

required :creditor_address_line3, String, nil?: true

#creditor_name ⇒ String^?

A name set by the sender.

Returns:

• (String, nil)

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

required :creditor_name, String, nil?: true

#debtor_address_line1 ⇒ String^?

A free-form address field set by the sender.

Returns:

• (String, nil)

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

required :debtor_address_line1, String, nil?: true

#debtor_address_line2 ⇒ String^?

A free-form address field set by the sender.

Returns:

• (String, nil)

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

required :debtor_address_line2, String, nil?: true

#debtor_address_line3 ⇒ String^?

A free-form address field set by the sender.

Returns:

• (String, nil)

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

required :debtor_address_line3, String, nil?: true

#debtor_name ⇒ String^?

A name set by the sender.

Returns:

• (String, nil)

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

required :debtor_name, String, nil?: true

#description ⇒ String

An Increase-constructed description of the transfer.

Returns:

• (String)

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

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)

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

required :end_to_end_identification, String, nil?: true

#id ⇒ String

The inbound wire transfer’s identifier.

Returns:

• (String)

# 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)

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

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)

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

required :instructing_agent_routing_number, String, nil?: true

#instruction_identification ⇒ String^?

The sending bank’s identifier for the wire transfer.

Returns:

• (String, nil)

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

required :instruction_identification, String, nil?: true

#originator_address_line1 ⇒ String^?

The address of the wire originator, set by the sending bank.

Returns:

• (String, nil)

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

required :originator_address_line1, String, nil?: true

#originator_address_line2 ⇒ String^?

The address of the wire originator, set by the sending bank.

Returns:

• (String, nil)

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

required :originator_address_line2, String, nil?: true

#originator_address_line3 ⇒ String^?

The address of the wire originator, set by the sending bank.

Returns:

• (String, nil)

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

required :originator_address_line3, String, nil?: true

#originator_name ⇒ String^?

The originator of the wire, set by the sending bank.

Returns:

• (String, nil)

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

required :originator_name, String, nil?: true

#originator_routing_number ⇒ String^?

The American Banking Association (ABA) routing number of the bank originating the transfer.

Returns:

• (String, nil)

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

required :originator_routing_number, String, nil?: true

#originator_to_beneficiary_information ⇒ String^?

An Increase-created concatenation of the Originator-to-Beneficiary lines.

Returns:

• (String, nil)

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

required :originator_to_beneficiary_information, String, nil?: true

#originator_to_beneficiary_information_line1 ⇒ String^?

A free-form message set by the wire originator.

Returns:

• (String, nil)

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

required :originator_to_beneficiary_information_line1, String, nil?: true

#originator_to_beneficiary_information_line2 ⇒ String^?

A free-form message set by the wire originator.

Returns:

• (String, nil)

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

required :originator_to_beneficiary_information_line2, String, nil?: true

#originator_to_beneficiary_information_line3 ⇒ String^?

A free-form message set by the wire originator.

Returns:

• (String, nil)

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

required :originator_to_beneficiary_information_line3, String, nil?: true

#originator_to_beneficiary_information_line4 ⇒ String^?

A free-form message set by the wire originator.

Returns:

• (String, nil)

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

required :originator_to_beneficiary_information_line4, String, nil?: true

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

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

Returns:

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

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

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

#sender_reference ⇒ String^?

The sending bank’s reference number for the wire transfer.

Returns:

• (String, nil)

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

required :sender_reference, String, nil?: true

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

The status of the transfer.

Returns:

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

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

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:

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

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

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)

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

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)

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

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)

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

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 381