Class: Increase::Models::CheckTransferCreateParams

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

Overview

See Also:

Defined Under Namespace

Modules: BalanceCheck, FulfillmentMethod Classes: PhysicalCheck, ThirdParty

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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: , fulfillment_method: , source_account_number_id: , balance_check: nil, check_number: nil, physical_check: nil, require_approval: nil, third_party: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::CheckTransferCreateParams 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.

  • fulfillment_method (Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod) (defaults to: ) —

    Whether Increase will print and mail the check or if you will do it yourself.

  • source_account_number_id (String) (defaults to: ) —

    The identifier of the Account Number from which to send the transfer and print o

  • balance_check (Symbol, Increase::Models::CheckTransferCreateParams::BalanceCheck) (defaults to: nil) —

    How the account’s available balance should be checked. Please contact [support@i

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

    The check number Increase should use for the check. This should not contain lead

  • physical_check (Increase::Models::CheckTransferCreateParams::PhysicalCheck) (defaults to: nil) —

    Details relating to the physical check that Increase will print and mail. This i

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

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

  • third_party (Increase::Models::CheckTransferCreateParams::ThirdParty) (defaults to: nil) —

    Details relating to the custom fulfillment you will perform. This is required if

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



# File 'lib/increase/models/check_transfer_create_params.rb', line 72

Instance Attribute Details

#account_id ⇒ String

The identifier for the account that will send the transfer.

Returns:

  • (String) 


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

required :account_id, String

#amount ⇒ Integer

The transfer amount in USD cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#balance_check ⇒ Symbol, ...

How the account’s available balance should be checked. Please contact [support@increase.com](support@increase.com) to enable this parameter.

Returns:



40
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 40

optional :balance_check, enum: -> { Increase::CheckTransferCreateParams::BalanceCheck }

#check_number ⇒ String?

The check number Increase should use for the check. This should not contain leading zeroes and must be unique across the ‘source_account_number`. If this is omitted, Increase will generate a check number for you.

Returns:

  • (String, nil) 


48
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 48

optional :check_number, String

#fulfillment_method ⇒ Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod

Whether Increase will print and mail the check or if you will do it yourself.

Returns:



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

required :fulfillment_method, enum: -> { Increase::CheckTransferCreateParams::FulfillmentMethod }

#physical_check ⇒ Increase::Models::CheckTransferCreateParams::PhysicalCheck?

Details relating to the physical check that Increase will print and mail. This is required if ‘fulfillment_method` is equal to `physical_check`. It must not be included if any other `fulfillment_method` is provided.

Returns:



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

optional :physical_check, -> { Increase::CheckTransferCreateParams::PhysicalCheck }

#require_approval ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


62
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 62

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

#source_account_number_id ⇒ String

The identifier of the Account Number from which to send the transfer and print on the check.

Returns:

  • (String) 


33
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 33

required :source_account_number_id, String

#third_party ⇒ Increase::Models::CheckTransferCreateParams::ThirdParty?

Details relating to the custom fulfillment you will perform. This is required if ‘fulfillment_method` is equal to `third_party`. It must not be included if any other `fulfillment_method` is provided.

Returns:



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

optional :third_party, -> { Increase::CheckTransferCreateParams::ThirdParty }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/check_transfer_create_params.rb', line 106