Class: Increase::Models::ACHTransferCreateParams

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

Overview

See Also:

Defined Under Namespace

Modules: DestinationAccountHolder, Funding, StandardEntryClassCode, TransactionTiming Classes: Addenda, PreferredEffectiveDate

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(invoice_number: , paid_amount: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice::Invoice for more details.

Parameters:

  • invoice_number (String) (defaults to: ) —

    The invoice number for this reference, determined in advance with the receiver.

  • paid_amount (Integer) (defaults to: ) —

    The amount that was paid for this invoice in the minor unit of its currency. For




# File 'lib/increase/models/ach_transfer_create_params.rb', line 305

Instance Attribute Details

#account_id ⇒ String

The Increase identifier for the account that will send the transfer.

Returns:

  • (String) 


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

required :account_id, String

#account_number ⇒ String?

The account number for the destination account.

Returns:

  • (String, nil) 


39
 
# File 'lib/increase/models/ach_transfer_create_params.rb', line 39

optional :account_number, String

#addenda ⇒ Increase::Models::ACHTransferCreateParams::Addenda?

Additional information that will be sent to the recipient. This is included in the transfer data sent to the receiving bank.

Returns:



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

optional :addenda, -> { Increase::ACHTransferCreateParams::Addenda }

#amount ⇒ Integer

The transfer amount in USD cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.

Returns:

  • (Integer) 


22
 
# File 'lib/increase/models/ach_transfer_create_params.rb', line 22

required :amount, Integer

#company_descriptive_date ⇒ String?

The description of the date of the transfer, usually in the format ‘YYMMDD`. This is included in the transfer data sent to the receiving bank.

Returns:

  • (String, nil) 


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

optional :company_descriptive_date, String

#company_discretionary_data ⇒ String?

The data you choose to associate with the transfer. This is included in the transfer data sent to the receiving bank.

Returns:

  • (String, nil) 


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

optional :company_discretionary_data, String

#company_entry_description ⇒ String?

A description of the transfer. This is included in the transfer data sent to the receiving bank.

Returns:

  • (String, nil) 


67
 
# File 'lib/increase/models/ach_transfer_create_params.rb', line 67

optional :company_entry_description, String

#company_name ⇒ String?

The name by which the recipient knows you. This is included in the transfer data sent to the receiving bank.

Returns:

  • (String, nil) 


74
 
# File 'lib/increase/models/ach_transfer_create_params.rb', line 74

optional :company_name, String

#destination_account_holder ⇒ Symbol, ...

The type of entity that owns the account to which the ACH Transfer is being sent.

Returns:



81
82
 
# File 'lib/increase/models/ach_transfer_create_params.rb', line 81

optional :destination_account_holder,
enum: -> { Increase::ACHTransferCreateParams::DestinationAccountHolder }

#external_account_id ⇒ String?

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

Returns:

  • (String, nil) 


89
 
# File 'lib/increase/models/ach_transfer_create_params.rb', line 89

optional :external_account_id, String

#funding ⇒ Symbol, ...

The type of the account to which the transfer will be sent.

Returns:



95
 
# File 'lib/increase/models/ach_transfer_create_params.rb', line 95

optional :funding, enum: -> { Increase::ACHTransferCreateParams::Funding }

#individual_id ⇒ String?

Your identifier for the transfer recipient.

Returns:

  • (String, nil) 


101
 
# File 'lib/increase/models/ach_transfer_create_params.rb', line 101

optional :individual_id, String

#individual_name ⇒ String?

The name of the transfer recipient. This value is informational and not verified by the recipient’s bank.

Returns:

  • (String, nil) 


108
 
# File 'lib/increase/models/ach_transfer_create_params.rb', line 108

optional :individual_name, String

#preferred_effective_date ⇒ Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate?

Configuration for how the effective date of the transfer will be set. This determines same-day vs future-dated settlement timing. If not set, defaults to a ‘settlement_schedule` of `same_day`. If set, exactly one of the child attributes must be set.

Returns:



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

optional :preferred_effective_date, -> { Increase::ACHTransferCreateParams::PreferredEffectiveDate }

#require_approval ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


123
 
# File 'lib/increase/models/ach_transfer_create_params.rb', line 123

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) 


130
 
# File 'lib/increase/models/ach_transfer_create_params.rb', line 130

optional :routing_number, String

#standard_entry_class_code ⇒ Symbol, ...

The Standard Entry Class (SEC) code to use for the transfer.

Returns:



136
137
 
# File 'lib/increase/models/ach_transfer_create_params.rb', line 136

optional :standard_entry_class_code,
enum: -> { Increase::ACHTransferCreateParams::StandardEntryClassCode }

#statement_descriptor ⇒ String

A description you choose to give the transfer. This will be saved with the transfer details, displayed in the dashboard, and returned by the API. If ‘individual_name` and `company_name` are not explicitly set by this API, the `statement_descriptor` will be sent in those fields to the receiving bank to help the customer recognize the transfer. You are highly encouraged to pass `individual_name` and `company_name` instead of relying on this fallback.

Returns:

  • (String) 


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

required :statement_descriptor, String

#transaction_timing ⇒ Symbol, ...

The timing of the transaction.

Returns:



143
 
# File 'lib/increase/models/ach_transfer_create_params.rb', line 143

optional :transaction_timing, enum: -> { Increase::ACHTransferCreateParams::TransactionTiming }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/ach_transfer_create_params.rb', line 331