Class: Increase::Models::WireTransferCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::WireTransferCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/increase/models/wire_transfer_create_params.rb

Overview

See Also:

• Resources::WireTransfers#create

Instance Attribute Summary

• #account_id ⇒ String

  The identifier for the account that will send the transfer.

• #account_number ⇒ String^?

  The account number for the destination account.

• #amount ⇒ Integer

  The transfer amount in USD cents.

• #beneficiary_address_line1 ⇒ String^?

  The beneficiary’s address line 1.

• #beneficiary_address_line2 ⇒ String^?

  The beneficiary’s address line 2.

• #beneficiary_address_line3 ⇒ String^?

  The beneficiary’s address line 3.

• #beneficiary_name ⇒ String

  The beneficiary’s name.

• #external_account_id ⇒ String^?

  The ID of an External Account to initiate a transfer to.

• #inbound_wire_drawdown_request_id ⇒ String^?

  The ID of an Inbound Wire Drawdown Request in response to which this transfer is being sent.

• #message_to_recipient ⇒ String

  The message that will show on the recipient’s bank statement.

• #originator_address_line1 ⇒ String^?

  The originator’s address line 1.

• #originator_address_line2 ⇒ String^?

  The originator’s address line 2.

• #originator_address_line3 ⇒ String^?

  The originator’s address line 3.

• #originator_name ⇒ String^?

  The originator’s name.

• #require_approval ⇒ Boolean^?

  Whether the transfer requires explicit approval via the dashboard or API.

• #routing_number ⇒ String^?

  The American Bankers’ Association (ABA) Routing Transit Number (RTN) for the destination account.

• #source_account_number_id ⇒ String^?

  The ID of an Account Number that will be passed to the wire’s recipient.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(account_id: , amount: , beneficiary_name: , message_to_recipient: , account_number: nil, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, external_account_id: nil, inbound_wire_drawdown_request_id: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, require_approval: nil, routing_number: nil, source_account_number_id: nil, request_options: {}) ⇒ Object constructor

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

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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, meta_info, new_coerce_state, 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(account_id: , amount: , beneficiary_name: , message_to_recipient: , account_number: nil, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, external_account_id: nil, inbound_wire_drawdown_request_id: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, require_approval: nil, routing_number: nil, source_account_number_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::WireTransferCreateParams for more details.

Parameters:

• account_id (String) (defaults to: ) —

  The identifier for the account that will send the transfer.

• amount (Integer) (defaults to: ) —

  The transfer amount in USD cents.

• beneficiary_name (String) (defaults to: ) —

  The beneficiary’s name.

• message_to_recipient (String) (defaults to: ) —

  The message that will show on the recipient’s bank statement.

• account_number (String) (defaults to: nil) —

  The account number for the destination account.

• beneficiary_address_line1 (String) (defaults to: nil) —

  The beneficiary’s address line 1.

• beneficiary_address_line2 (String) (defaults to: nil) —

  The beneficiary’s address line 2.

• beneficiary_address_line3 (String) (defaults to: nil) —

  The beneficiary’s address line 3.

• external_account_id (String) (defaults to: nil) —

  The ID of an External Account to initiate a transfer to. If this parameter is pr

• inbound_wire_drawdown_request_id (String) (defaults to: nil) —

  The ID of an Inbound Wire Drawdown Request in response to which this transfer is

• originator_address_line1 (String) (defaults to: nil) —

  The originator’s address line 1. This is only necessary if you’re transferring f

• originator_address_line2 (String) (defaults to: nil) —

  The originator’s address line 2. This is only necessary if you’re transferring f

• originator_address_line3 (String) (defaults to: nil) —

  The originator’s address line 3. This is only necessary if you’re transferring f

• originator_name (String) (defaults to: nil) —

  The originator’s name. This is only necessary if you’re transferring from a comm

• require_approval (Boolean) (defaults to: nil) —

  Whether the transfer requires explicit approval via the dashboard or API.

• routing_number (String) (defaults to: nil) —

  The American Bankers’ Association (ABA) Routing Transit Number (RTN) for the des

• source_account_number_id (String) (defaults to: nil) —

  The ID of an Account Number that will be passed to the wire’s recipient

• request_options (Increase::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

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

Instance Attribute Details

#account_id ⇒ String

The identifier for the account that will send the transfer.

Returns:

• (String)

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

required :account_id, String

#account_number ⇒ String^?

The account number for the destination account.

Returns:

• (String, nil)

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

optional :account_number, String

#amount ⇒ Integer

The transfer amount in USD cents.

Returns:

• (Integer)

# File 'lib/increase/models/wire_transfer_create_params.rb', line 20

required :amount, Integer

#beneficiary_address_line1 ⇒ String^?

The beneficiary’s address line 1.

Returns:

• (String, nil)

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

optional :beneficiary_address_line1, String

#beneficiary_address_line2 ⇒ String^?

The beneficiary’s address line 2.

Returns:

• (String, nil)

# File 'lib/increase/models/wire_transfer_create_params.rb', line 50

optional :beneficiary_address_line2, String

#beneficiary_address_line3 ⇒ String^?

The beneficiary’s address line 3.

Returns:

• (String, nil)

# File 'lib/increase/models/wire_transfer_create_params.rb', line 56

optional :beneficiary_address_line3, String

#beneficiary_name ⇒ String

The beneficiary’s name.

Returns:

• (String)

# File 'lib/increase/models/wire_transfer_create_params.rb', line 26

required :beneficiary_name, String

#external_account_id ⇒ String^?

The ID of an External Account to initiate a transfer to. If this parameter is provided, ‘account_number` and `routing_number` must be absent.

Returns:

• (String, nil)

# File 'lib/increase/models/wire_transfer_create_params.rb', line 63

optional :external_account_id, String

#inbound_wire_drawdown_request_id ⇒ String^?

The ID of an Inbound Wire Drawdown Request in response to which this transfer is being sent.

Returns:

• (String, nil)

# File 'lib/increase/models/wire_transfer_create_params.rb', line 70

optional :inbound_wire_drawdown_request_id, String

#message_to_recipient ⇒ String

The message that will show on the recipient’s bank statement.

Returns:

• (String)

# File 'lib/increase/models/wire_transfer_create_params.rb', line 32

required :message_to_recipient, String

#originator_address_line1 ⇒ String^?

The originator’s address line 1. This is only necessary if you’re transferring from a commingled account. Otherwise, we’ll use the associated entity’s details.

Returns:

• (String, nil)

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

optional :originator_address_line1, String

#originator_address_line2 ⇒ String^?

The originator’s address line 2. This is only necessary if you’re transferring from a commingled account. Otherwise, we’ll use the associated entity’s details.

Returns:

• (String, nil)

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

optional :originator_address_line2, String

#originator_address_line3 ⇒ String^?

The originator’s address line 3. This is only necessary if you’re transferring from a commingled account. Otherwise, we’ll use the associated entity’s details.

Returns:

• (String, nil)

# File 'lib/increase/models/wire_transfer_create_params.rb', line 91

optional :originator_address_line3, String

#originator_name ⇒ String^?

The originator’s name. This is only necessary if you’re transferring from a commingled account. Otherwise, we’ll use the associated entity’s details.

Returns:

• (String, nil)

# File 'lib/increase/models/wire_transfer_create_params.rb', line 98

optional :originator_name, String

#require_approval ⇒ Boolean^?

Whether the transfer requires explicit approval via the dashboard or API.

Returns:

• (Boolean, nil)

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

optional :require_approval, Increase::Internal::Type::Boolean

#routing_number ⇒ String^?

The American Bankers’ Association (ABA) Routing Transit Number (RTN) for the destination account.

Returns:

• (String, nil)

# File 'lib/increase/models/wire_transfer_create_params.rb', line 111

optional :routing_number, String

#source_account_number_id ⇒ String^?

The ID of an Account Number that will be passed to the wire’s recipient

Returns:

• (String, nil)

# File 'lib/increase/models/wire_transfer_create_params.rb', line 117

optional :source_account_number_id, String