Class: Increase::Models::CheckTransfer

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

Defined Under Namespace

Classes: Approval, Cancellation, CreatedBy, Mailing, PhysicalCheck, StopPaymentRequest, Submission, ThirdParty

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

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

Instance Attribute Details

#account_id ⇒ String

The identifier of the Account from which funds will be transferred.

Returns:

  • (String) 


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

required :account_id, String

#account_number ⇒ String

The account number printed on the check.

Returns:

  • (String) 


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

required :account_number, String

#amount ⇒ Integer

The transfer amount in USD cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#approval ⇒ Increase::Models::CheckTransfer::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/check_transfer.rb', line 29

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

#approved_inbound_check_deposit_id ⇒ String

If the Check Transfer was successfully deposited, this will contain the identifier of the Inbound Check Deposit object with details of the deposit.

Returns:

  • (String) 


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

required :approved_inbound_check_deposit_id, String

#cancellation ⇒ Increase::Models::CheckTransfer::Cancellation

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

Returns:



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

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

#check_number ⇒ String

The check number printed on the check.

Returns:

  • (String) 


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

required :check_number, String

#created_at ⇒ String

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

Returns:

  • (String) 


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

required :created_at, String

#created_by ⇒ Increase::Models::CheckTransfer::CreatedBy

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

Returns:



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

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

#currency ⇒ Symbol

The ISO 4217 code for the check's currency.

Returns:

  • (Symbol) 


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

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

#fulfillment_method ⇒ Symbol

Whether Increase will print and mail the check or if you will do it yourself.

Returns:

  • (Symbol) 


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

required :fulfillment_method, Increase::Enum.new(:physical_check, :third_party)

#id ⇒ String

The Check transfer's identifier.

Returns:

  • (String) 


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


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

required :idempotency_key, String

#mailing ⇒ Increase::Models::CheckTransfer::Mailing

If the check has been mailed by Increase, this will contain details of the shipment.

Returns:



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

required :mailing, -> { Increase::Models::CheckTransfer::Mailing }

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


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

required :pending_transaction_id, String

#physical_check ⇒ Increase::Models::CheckTransfer::PhysicalCheck

Details relating to the physical check that Increase will print and mail. Will be present if and only if fulfillment_method is equal to physical_check.

Returns:



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

required :physical_check, -> { Increase::Models::CheckTransfer::PhysicalCheck }

#routing_number ⇒ String

The routing number printed on the check.

Returns:

  • (String) 


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

required :routing_number, String

#source_account_number_id ⇒ String

The identifier of the Account Number from which to send the transfer and print on the check.

Returns:

  • (String) 


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

required :source_account_number_id, String

#status ⇒ Symbol

The lifecycle status of the transfer.

Returns:

  • (Symbol) 


99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/increase/models/check_transfer.rb', line 99

required :status,
Increase::Enum.new(
  :pending_approval,
  :pending_submission,
  :pending_mailing,
  :mailed,
  :canceled,
  :deposited,
  :stopped,
  :rejected,
  :requires_attention,
  :returned
)

#stop_payment_request ⇒ Increase::Models::CheckTransfer::StopPaymentRequest

After a stop-payment is requested on the check, this will contain supplemental details.

Returns:



116
 
# File 'lib/increase/models/check_transfer.rb', line 116

required :stop_payment_request, -> { Increase::Models::CheckTransfer::StopPaymentRequest }

#submission ⇒ Increase::Models::CheckTransfer::Submission

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

Returns:



121
 
# File 'lib/increase/models/check_transfer.rb', line 121

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

#third_party ⇒ Increase::Models::CheckTransfer::ThirdParty

Details relating to the custom fulfillment you will perform. Will be present if and only if fulfillment_method is equal to third_party.

Returns:



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

required :third_party, -> { Increase::Models::CheckTransfer::ThirdParty }

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


131
 
# File 'lib/increase/models/check_transfer.rb', line 131

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