Class: Increase::Models::WireDrawdownRequest

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

Defined Under Namespace

Classes: Submission

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

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

Instance Attribute Details

#account_number_id ⇒ String

The Account Number to which the recipient of this request is being requested to send funds.

Returns:

  • (String) 


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

required :account_number_id, String

#amount ⇒ Integer

The amount being requested in cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#currency ⇒ String

The ISO 4217 code for the amount being requested. Will always be "USD".

Returns:

  • (String) 


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

required :currency, String

#fulfillment_transaction_id ⇒ String

If the recipient fulfills the drawdown request by sending funds, then this will be the identifier of the corresponding Transaction.

Returns:

  • (String) 


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

required :fulfillment_transaction_id, String

#id ⇒ String

The Wire drawdown request identifier.

Returns:

  • (String) 


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


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

required :idempotency_key, String

#message_to_recipient ⇒ String

The message the recipient will see as part of the drawdown request.

Returns:

  • (String) 


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

required :message_to_recipient, String

#originator_address_line1 ⇒ String

The originator's address line 1.

Returns:

  • (String) 


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

required :originator_address_line1, String

#originator_address_line2 ⇒ String

The originator's address line 2.

Returns:

  • (String) 


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

required :originator_address_line2, String

#originator_address_line3 ⇒ String

The originator's address line 3.

Returns:

  • (String) 


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

required :originator_address_line3, String

#originator_name ⇒ String

The originator's name.

Returns:

  • (String) 


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

required :originator_name, String

#recipient_account_number ⇒ String

The drawdown request's recipient's account number.

Returns:

  • (String) 


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

required :recipient_account_number, String

#recipient_address_line1 ⇒ String

Line 1 of the drawdown request's recipient's address.

Returns:

  • (String) 


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

required :recipient_address_line1, String

#recipient_address_line2 ⇒ String

Line 2 of the drawdown request's recipient's address.

Returns:

  • (String) 


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

required :recipient_address_line2, String

#recipient_address_line3 ⇒ String

Line 3 of the drawdown request's recipient's address.

Returns:

  • (String) 


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

required :recipient_address_line3, String

#recipient_name ⇒ String

The drawdown request's recipient's name.

Returns:

  • (String) 


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

required :recipient_name, String

#recipient_routing_number ⇒ String

The drawdown request's recipient's routing number.

Returns:

  • (String) 


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

required :recipient_routing_number, String

#status ⇒ Symbol

The lifecycle status of the drawdown request.

Returns:

  • (Symbol) 


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

required :status, Increase::Enum.new(:pending_submission, :pending_response, :fulfilled, :refused)

#submission ⇒ Increase::Models::WireDrawdownRequest::Submission

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

Returns:



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

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

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


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

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