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

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

  • paid_amount (Integer) —

    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 318

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 receiver’s account number. For credit transfers (positive ‘amount`) this is the account that funds will be sent to. For debit transfers (negative `amount`) this is the account that funds will be pulled from.

Returns:

  • (String, nil) 


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

optional :account_number, String

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

Additional information passed through to the receiving bank with the transfer. Most ACH transfers do not need this. Only set this if your recipient has asked for addendum data, typically unstructured remittance information. Corporate Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.

Returns:



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

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?

A description of the transfer date (typically ‘YYMMDD`), sent in the company batch header. This value is informational and does not affect funds movement, settlement timing, or returns. Only set this if your recipient has asked for it.

Returns:

  • (String, nil) 


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

optional :company_descriptive_date, String

#company_discretionary_data ⇒ String?

Custom data sent in the company batch header. This value is informational and does not affect funds movement, settlement timing, or returns. Most ACH transfers do not need this. Only set this if your recipient has asked for it.

Returns:

  • (String, nil) 


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

optional :company_discretionary_data, String

#company_entry_description ⇒ String?

A short description sent in the company batch header. Most receivers do not surface this. Only set this if your recipient has asked for a specific value or if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For example, Prearranged Payment and Deposit (PPD) payroll credits must use ‘PAYROLL`, and reversals must use `REVERSAL`.

Returns:

  • (String, nil) 


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

optional :company_entry_description, String

#company_name ⇒ String?

The name by which the recipient knows you, sent in the company batch header. We recommend setting this on every transfer; if you do not, we fall back to the ACH company name configured on your account.

Returns:

  • (String, nil) 


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

optional :company_name, String

#destination_account_holder ⇒ Symbol, ...

The type of entity that owns the receiver’s account.

Returns:



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

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) 


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

optional :external_account_id, String

#funding ⇒ Symbol, ...

The type of the receiver’s bank account.

Returns:



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

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

#individual_id ⇒ String?

Your internal identifier for the transfer recipient. This value is informational and not verified by the recipient’s bank. Most callers can leave this unset.

Returns:

  • (String, nil) 


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

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) 


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

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:



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

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

#require_approval ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


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

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

#routing_number ⇒ String?

The American Bankers’ Association (ABA) Routing Transit Number (RTN) of the receiver’s bank.

Returns:

  • (String, nil) 


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

optional :routing_number, String

#standard_entry_class_code ⇒ Symbol, ...

The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use for the transfer. If not provided, the default is ‘corporate_credit_or_debit`.

Returns:



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

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:



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

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 343