Class: Increase::Models::WireTransfer

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/increase/models/wire_transfer.rb

Defined Under Namespace

Classes: Approval, Cancellation, CreatedBy, Reversal, Submission

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #inspect, #to_h, #to_s

Instance Attribute Details

#account_id ⇒ String

The Account to which the transfer belongs.

Returns:

  • (String) 


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

required :account_id, String

#account_number ⇒ String

The destination account number.

Returns:

  • (String) 


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

required :account_number, String

#amount ⇒ Integer

The transfer amount in USD cents.

Returns:

  • (Integer) 


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

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:



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

required :approval, -> { Increase::Models::WireTransfer::Approval }

#beneficiary_address_line1 ⇒ String

The beneficiary's address line 1.

Returns:

  • (String) 


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

required :beneficiary_address_line1, String

#beneficiary_address_line2 ⇒ String

The beneficiary's address line 2.

Returns:

  • (String) 


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

required :beneficiary_address_line2, String

#beneficiary_address_line3 ⇒ String

The beneficiary's address line 3.

Returns:

  • (String) 


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

required :beneficiary_address_line3, String

#beneficiary_name ⇒ String

The beneficiary's name.

Returns:

  • (String) 


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

required :beneficiary_name, String

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



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

required :cancellation, -> { Increase::Models::WireTransfer::Cancellation }

#created_at ⇒ String

The ISO 8601 date and time at which the transfer was created.

Returns:

  • (String) 


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

required :created_at, String

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

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

Returns:



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

required :created_by, -> { Increase::Models::WireTransfer::CreatedBy }

#currency ⇒ Symbol

The ISO 4217 code for the transfer's currency. For wire transfers this is always equal to usd.

Returns:

  • (Symbol) 


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

required :currency, Increase::Enum.new(:CAD, :CHF, :EUR, :GBP, :JPY, :USD)

#external_account_id ⇒ String

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

Returns:

  • (String) 


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

required :external_account_id, String

#id ⇒ String

The wire transfer's identifier.

Returns:

  • (String) 


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

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.

Returns:

  • (String) 


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

required :idempotency_key, String

#message_to_recipient ⇒ String

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

Returns:

  • (String) 


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

required :message_to_recipient, String

#network ⇒ Symbol

The transfer's network.

Returns:

  • (Symbol) 


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

required :network, Increase::Enum.new(:wire)

#originator_address_line1 ⇒ String

The originator's address line 1.

Returns:

  • (String) 


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

required :originator_address_line1, String

#originator_address_line2 ⇒ String

The originator's address line 2.

Returns:

  • (String) 


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

required :originator_address_line2, String

#originator_address_line3 ⇒ String

The originator's address line 3.

Returns:

  • (String) 


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

required :originator_address_line3, String

#originator_name ⇒ String

The originator's name.

Returns:

  • (String) 


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

required :originator_name, String

#pending_transaction_id ⇒ String

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.

Returns:

  • (String) 


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

required :pending_transaction_id, String

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

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

Returns:



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

required :reversal, -> { Increase::Models::WireTransfer::Reversal }

#routing_number ⇒ String

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

Returns:

  • (String) 


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

required :routing_number, String

#status ⇒ Symbol

The lifecycle status of the transfer.

Returns:

  • (Symbol) 


129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/increase/models/wire_transfer.rb', line 129

required :status,
Increase::Enum.new(
  :canceled,
  :requires_attention,
  :pending_reviewing,
  :pending_approval,
  :rejected,
  :reversed,
  :complete,
  :pending_creating
)

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

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

Returns:



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

required :submission, -> { Increase::Models::WireTransfer::Submission }

#transaction_id ⇒ String

The ID for the transaction funding the transfer.

Returns:

  • (String) 


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

required :transaction_id, String

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


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

required :type, Increase::Enum.new(:wire_transfer)