Class: Increase::Models::WireTransfer

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

Overview

See Also:

Defined Under Namespace

Modules: Currency, Network, Status, Type Classes: Approval, Cancellation, CreatedBy, Remittance, Reversal, Submission

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(input_message_accountability_data: , submitted_at: ) ⇒ Object

After the transfer is submitted to Fedwire, this will contain supplemental details.

Parameters:

  • input_message_accountability_data (String) (defaults to: ) —

    The accountability data for the submission.

  • submitted_at (Time) (defaults to: ) —

    When this wire transfer was submitted to Fedwire.




# File 'lib/increase/models/wire_transfer.rb', line 205

Instance Attribute Details

#account_id ⇒ String

The Account to which the transfer belongs.

Returns:

  • (String) 


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

required :account_id, String

#account_number ⇒ String

The destination account number.

Returns:

  • (String) 


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

required :account_number, String

#amount ⇒ Integer

The transfer amount in USD cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#approval ⇒ Increase::Models::WireTransfer::Approval?

If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.

Returns:



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

required :approval, -> { Increase::WireTransfer::Approval }, nil?: true

#beneficiary_address_line1 ⇒ String?

The beneficiary’s address line 1.

Returns:

  • (String, nil) 


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

required :beneficiary_address_line1, String, nil?: true

#beneficiary_address_line2 ⇒ String?

The beneficiary’s address line 2.

Returns:

  • (String, nil) 


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

required :beneficiary_address_line2, String, nil?: true

#beneficiary_address_line3 ⇒ String?

The beneficiary’s address line 3.

Returns:

  • (String, nil) 


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

required :beneficiary_address_line3, String, nil?: true

#beneficiary_name ⇒ String?

The beneficiary’s name.

Returns:

  • (String, nil) 


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

required :beneficiary_name, String, nil?: true

#cancellation ⇒ Increase::Models::WireTransfer::Cancellation?

If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.

Returns:



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

required :cancellation, -> { Increase::WireTransfer::Cancellation }, 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) 


74
 
# File 'lib/increase/models/wire_transfer.rb', line 74

required :created_at, Time

#created_by ⇒ Increase::Models::WireTransfer::CreatedBy?

What object created the transfer, either via the API or the dashboard.

Returns:



80
 
# File 'lib/increase/models/wire_transfer.rb', line 80

required :created_by, -> { Increase::WireTransfer::CreatedBy }, nil?: true

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

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the transfer’s currency. For wire transfers this is always equal to ‘usd`.

Returns:



87
 
# File 'lib/increase/models/wire_transfer.rb', line 87

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

#external_account_id ⇒ String?

The identifier of the External Account the transfer was made to, if any.

Returns:

  • (String, nil) 


93
 
# File 'lib/increase/models/wire_transfer.rb', line 93

required :external_account_id, String, nil?: true

#id ⇒ String

The wire transfer’s identifier.

Returns:

  • (String) 


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

required :id, String

#idempotency_key ⇒ String?

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


101
 
# File 'lib/increase/models/wire_transfer.rb', line 101

required :idempotency_key, String, nil?: true

#inbound_wire_drawdown_request_id ⇒ String?

The ID of an Inbound Wire Drawdown Request in response to which this transfer was sent.

Returns:

  • (String, nil) 


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

required :inbound_wire_drawdown_request_id, String, nil?: true

#message_to_recipient ⇒ String

The message that will show on the recipient’s bank statement.

Returns:

  • (String) 


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

required :message_to_recipient, String

#network ⇒ Symbol, Increase::Models::WireTransfer::Network

The transfer’s network.

Returns:



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

required :network, enum: -> { Increase::WireTransfer::Network }

#originator_address_line1 ⇒ String?

The originator’s address line 1.

Returns:

  • (String, nil) 


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

required :originator_address_line1, String, nil?: true

#originator_address_line2 ⇒ String?

The originator’s address line 2.

Returns:

  • (String, nil) 


132
 
# File 'lib/increase/models/wire_transfer.rb', line 132

required :originator_address_line2, String, nil?: true

#originator_address_line3 ⇒ String?

The originator’s address line 3.

Returns:

  • (String, nil) 


138
 
# File 'lib/increase/models/wire_transfer.rb', line 138

required :originator_address_line3, String, nil?: true

#originator_name ⇒ String?

The originator’s name.

Returns:

  • (String, nil) 


144
 
# File 'lib/increase/models/wire_transfer.rb', line 144

required :originator_name, String, nil?: true

#pending_transaction_id ⇒ String?

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.

Returns:

  • (String, nil) 


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

required :pending_transaction_id, String, nil?: true

#remittance ⇒ Increase::Models::WireTransfer::Remittance?

Remittance information sent with the wire transfer.

Returns:



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

required :remittance, -> { Increase::WireTransfer::Remittance }, nil?: true

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

If your transfer is reversed, this will contain details of the reversal.

Returns:



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

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

#routing_number ⇒ String

The American Bankers’ Association (ABA) Routing Transit Number (RTN).

Returns:

  • (String) 


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

required :routing_number, String

#source_account_number_id ⇒ String?

The Account Number that was passed to the wire’s recipient.

Returns:

  • (String, nil) 


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

required :source_account_number_id, String, nil?: true

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

The lifecycle status of the transfer.

Returns:



183
 
# File 'lib/increase/models/wire_transfer.rb', line 183

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

#submission ⇒ Increase::Models::WireTransfer::Submission?

After the transfer is submitted to Fedwire, this will contain supplemental details.

Returns:



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

required :submission, -> { Increase::WireTransfer::Submission }, nil?: true

#transaction_id ⇒ String?

The ID for the transaction funding the transfer.

Returns:

  • (String, nil) 


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

required :transaction_id, String, nil?: true

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

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

Returns:



203
 
# File 'lib/increase/models/wire_transfer.rb', line 203

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/wire_transfer.rb', line 454