Class: Increase::Models::AccountTransferCreateParams

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

Overview

See Also:

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(account_id: , amount: , description: , destination_account_id: , require_approval: nil, request_options: {}) ⇒ Object

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

Parameters:

  • account_id (String) (defaults to: ) —

    The identifier for the originating Account that will send the transfer.

  • amount (Integer) (defaults to: ) —

    The transfer amount in the minor unit of the account currency. For dollars, for

  • description (String) (defaults to: ) —

    An internal-facing description for the transfer for display in the API and dashb

  • destination_account_id (String) (defaults to: ) —

    The identifier for the destination Account that will receive the transfer.

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

    Whether the transfer should require explicit approval via the dashboard or API.

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



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

Instance Attribute Details

#account_id ⇒ String

The identifier for the originating Account that will send the transfer.

Returns:

  • (String) 


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

required :account_id, String

#amount ⇒ Integer

The transfer amount in the minor unit of the account currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


21
 
# File 'lib/increase/models/account_transfer_create_params.rb', line 21

required :amount, Integer

#description ⇒ String

An internal-facing description for the transfer for display in the API and dashboard. This will also show in the description of the created Transactions.

Returns:

  • (String) 


28
 
# File 'lib/increase/models/account_transfer_create_params.rb', line 28

required :description, String

#destination_account_id ⇒ String

The identifier for the destination Account that will receive the transfer.

Returns:

  • (String) 


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

required :destination_account_id, String

#require_approval ⇒ Boolean?

Whether the transfer should require explicit approval via the dashboard or API. For more information, see [Transfer Approvals](/documentation/transfer-approvals).

Returns:

  • (Boolean, nil) 


42
 
# File 'lib/increase/models/account_transfer_create_params.rb', line 42

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