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: Creditor, Debtor, Remittance

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(message: ) ⇒ Object

Unstructured remittance information. Required if ‘category` is equal to `unstructured`.

Parameters:

  • message (String) (defaults to: ) —

    The information.




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

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) 


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


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

required :amount, Integer

#creditor ⇒ Increase::Models::WireTransferCreateParams::Creditor

The person or business that is receiving the funds from the transfer.

Returns:



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

required :creditor, -> { Increase::WireTransferCreateParams::Creditor }

#debtor ⇒ Increase::Models::WireTransferCreateParams::Debtor?

The person or business whose funds are being transferred. This is only necessary if you’re transferring from a commingled account. Otherwise, we’ll use the associated entity’s details.

Returns:



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

optional :debtor, -> { Increase::WireTransferCreateParams::Debtor }

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


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

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) 


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

optional :inbound_wire_drawdown_request_id, String

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

Additional remittance information related to the wire transfer.

Returns:



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

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

#require_approval ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


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

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) 


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

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) 


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

optional :source_account_number_id, String