Class: Increase::Models::WireDrawdownRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/wire_drawdown_request.rb

Overview

See Also:

Defined Under Namespace

Modules: Status, Type Classes: Submission

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(input_message_accountability_data: ) ⇒ Object

Some parameter documentations has been truncated, see Submission for more details.

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

Parameters:

  • input_message_accountability_data (String) (defaults to: ) —

    The input message accountability data (IMAD) uniquely identifying the submission




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

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) 


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

required :account_number_id, String

#amount ⇒ Integer

The amount being requested in cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which the wire drawdown request was created.

Returns:

  • (Time) 


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

required :created_at, Time

#currency ⇒ String

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be “USD”.

Returns:

  • (String) 


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

required :currency, String

#fulfillment_inbound_wire_transfer_id ⇒ String?

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

Returns:

  • (String, nil) 


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

required :fulfillment_inbound_wire_transfer_id, String, nil?: true

#id ⇒ String

The Wire drawdown request identifier.

Returns:

  • (String) 


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

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](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


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

required :idempotency_key, String, nil?: true

#message_to_recipient ⇒ String

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

Returns:

  • (String) 


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

required :message_to_recipient, String

#originator_address_line1 ⇒ String?

The originator’s address line 1.

Returns:

  • (String, nil) 


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

required :originator_address_line1, String, nil?: true

#originator_address_line2 ⇒ String?

The originator’s address line 2.

Returns:

  • (String, nil) 


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

required :originator_address_line2, String, nil?: true

#originator_address_line3 ⇒ String?

The originator’s address line 3.

Returns:

  • (String, nil) 


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

required :originator_address_line3, String, nil?: true

#originator_name ⇒ String?

The originator’s name.

Returns:

  • (String, nil) 


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

required :originator_name, String, nil?: true

#recipient_account_number ⇒ String

The drawdown request’s recipient’s account number.

Returns:

  • (String) 


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

required :recipient_account_number, String

#recipient_address_line1 ⇒ String?

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

Returns:

  • (String, nil) 


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

required :recipient_address_line1, String, nil?: true

#recipient_address_line2 ⇒ String?

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

Returns:

  • (String, nil) 


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

required :recipient_address_line2, String, nil?: true

#recipient_address_line3 ⇒ String?

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

Returns:

  • (String, nil) 


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

required :recipient_address_line3, String, nil?: true

#recipient_name ⇒ String?

The drawdown request’s recipient’s name.

Returns:

  • (String, nil) 


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

required :recipient_name, String, nil?: true

#recipient_routing_number ⇒ String

The drawdown request’s recipient’s routing number.

Returns:

  • (String) 


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

required :recipient_routing_number, String

#status ⇒ Symbol, Increase::Models::WireDrawdownRequest::Status

The lifecycle status of the drawdown request.

Returns:



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

required :status, enum: -> { Increase::WireDrawdownRequest::Status }

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

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

Returns:



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

required :submission, -> { Increase::WireDrawdownRequest::Submission }, nil?: true

#type ⇒ Symbol, Increase::Models::WireDrawdownRequest::Type

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

Returns:



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

required :type, enum: -> { Increase::WireDrawdownRequest::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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