Class: Increase::Models::WireTransferCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/wire_transfer_create_params.rb

Overview

See Also:

Defined Under Namespace

Classes: Remittance

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from Increase::Internal::Type::BaseModel

Instance Attribute Details

#account_id ⇒ String

The identifier for the account that will send the transfer.

Returns:

  • (String) 


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


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

optional :account_number, String

#amount ⇒ Integer

The transfer amount in USD cents.

Returns:

  • (Integer) 


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


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

optional :beneficiary_address_line1, String

#beneficiary_address_line2 ⇒ String?

The beneficiary’s address line 2.

Returns:

  • (String, nil) 


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

optional :beneficiary_address_line2, String

#beneficiary_address_line3 ⇒ String?

The beneficiary’s address line 3.

Returns:

  • (String, nil) 


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

optional :beneficiary_address_line3, String

#beneficiary_name ⇒ String

The beneficiary’s name.

Returns:

  • (String) 


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


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

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) 


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

optional :inbound_wire_drawdown_request_id, 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) 


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

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) 


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

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) 


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

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) 


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

optional :originator_name, String

#remittance ⇒ Increase::Models::WireTransferCreateParams::Remittance?

Additional remittance information related to the wire transfer.

Returns:



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

optional :remittance, -> { Increase::WireTransferCreateParams::Remittance }

#require_approval ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


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


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


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

optional :source_account_number_id, String