Class: Increase::Models::RealTimePaymentsTransfer

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

Defined Under Namespace

Classes: Approval, Cancellation, CreatedBy, Rejection, Submission

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

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

Instance Attribute Details

#account_id ⇒ String

The Account from which the transfer was sent.

Returns:

  • (String) 


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

required :account_id, String

#amount ⇒ Integer

The transfer amount in USD cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#approval ⇒ Increase::Models::RealTimePaymentsTransfer::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/real_time_payments_transfer.rb', line 24

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

#cancellation ⇒ Increase::Models::RealTimePaymentsTransfer::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/real_time_payments_transfer.rb', line 29

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

#created_at ⇒ String

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

Returns:

  • (String) 


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

required :created_at, String

#created_by ⇒ Increase::Models::RealTimePaymentsTransfer::CreatedBy

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

Returns:



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

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

#creditor_name ⇒ String

The name of the transfer's recipient. This is set by the sender when creating the transfer.

Returns:

  • (String) 


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

required :creditor_name, String

#currency ⇒ Symbol

The ISO 4217 code for the transfer's currency. For real-time payments transfers this is always equal to USD.

Returns:

  • (Symbol) 


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

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

#debtor_name ⇒ String

The name of the transfer's sender. If not provided, defaults to the name of the account's entity.

Returns:

  • (String) 


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

required :debtor_name, String

#destination_account_number ⇒ String

The destination account number.

Returns:

  • (String) 


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

required :destination_account_number, String

#destination_routing_number ⇒ String

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

Returns:

  • (String) 


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

required :destination_routing_number, String

#external_account_id ⇒ String

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

Returns:

  • (String) 


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

required :external_account_id, String

#id ⇒ String

The Real-Time Payments Transfer's identifier.

Returns:

  • (String) 


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


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

required :idempotency_key, 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) 


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

required :pending_transaction_id, String

#rejection ⇒ Increase::Models::RealTimePaymentsTransfer::Rejection

If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.

Returns:



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

required :rejection, -> { Increase::Models::RealTimePaymentsTransfer::Rejection }

#remittance_information ⇒ String

Unstructured information that will show on the recipient's bank statement.

Returns:

  • (String) 


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

required :remittance_information, String

#source_account_number_id ⇒ String

The Account Number the recipient will see as having sent the transfer.

Returns:

  • (String) 


94
 
# File 'lib/increase/models/real_time_payments_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
 
# File 'lib/increase/models/real_time_payments_transfer.rb', line 99

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

#submission ⇒ Increase::Models::RealTimePaymentsTransfer::Submission

After the transfer is submitted to Real-Time Payments, this will contain supplemental details.

Returns:



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

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

#transaction_id ⇒ String

The Transaction funding the transfer once it is complete.

Returns:

  • (String) 


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

required :transaction_id, String

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


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

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

#ultimate_creditor_name ⇒ String

The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else.

Returns:

  • (String) 


129
 
# File 'lib/increase/models/real_time_payments_transfer.rb', line 129

required :ultimate_creditor_name, String

#ultimate_debtor_name ⇒ String

The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase.

Returns:

  • (String) 


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

required :ultimate_debtor_name, String