Class: Increase::Models::AccountTransfer

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

Defined Under Namespace

Classes: Approval, Cancellation, CreatedBy

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/account_transfer.rb', line 14

required :account_id, String

#amount ⇒ Integer

The transfer amount in the minor unit of the destination account currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#approval ⇒ Increase::Models::AccountTransfer::Approval

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

Returns:



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

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

#cancellation ⇒ Increase::Models::AccountTransfer::Cancellation

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

Returns:



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

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

#created_at ⇒ String

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

Returns:

  • (String) 


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

required :created_at, String

#created_by ⇒ Increase::Models::AccountTransfer::CreatedBy

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

Returns:



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

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

#currency ⇒ Symbol

The ISO 4217 code for the destination account currency.

Returns:

  • (Symbol) 


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

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

#description ⇒ String

The description that will show on the transactions.

Returns:

  • (String) 


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

required :description, String

#destination_account_id ⇒ String

The destination account's identifier.

Returns:

  • (String) 


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

required :destination_account_id, String

#destination_transaction_id ⇒ String

The ID for the transaction receiving the transfer.

Returns:

  • (String) 


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

required :destination_transaction_id, String

#id ⇒ String

The account transfer's identifier.

Returns:

  • (String) 


9
 
# File 'lib/increase/models/account_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) 


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

required :idempotency_key, String

#network ⇒ Symbol

The transfer's network.

Returns:

  • (Symbol) 


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

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

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


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

required :pending_transaction_id, String

#status ⇒ Symbol

The lifecycle status of the transfer.

Returns:

  • (Symbol) 


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

required :status, Increase::Enum.new(:pending_approval, :canceled, :complete)

#transaction_id ⇒ String

The ID for the transaction funding the transfer.

Returns:

  • (String) 


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

required :transaction_id, String

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


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

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