Class: Lithic::Models::TransferCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/lithic/models/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(amount:, from:, to:, token: nil, memo: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::TransferCreateParams for more details.

Parameters:

  • amount (Integer) —

    Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).

  • from (String) —

    Globally unique identifier for the financial account or card that will send the

  • to (String) —

    Globally unique identifier for the financial account or card that will receive t

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

    Customer-provided token that will serve as an idempotency token. This token will

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

    Optional descriptor for the transfer.

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



# File 'lib/lithic/models/transfer_create_params.rb', line 44

Instance Attribute Details

#amount ⇒ Integer

Amount to be transferred in the currency’s smallest unit (e.g., cents for USD). This should always be a positive value.

Returns:

  • (Integer) 


15
 
# File 'lib/lithic/models/transfer_create_params.rb', line 15

required :amount, Integer

#from ⇒ String

Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program’s use case.

Returns:

  • (String) 


22
 
# File 'lib/lithic/models/transfer_create_params.rb', line 22

required :from, String

#memo ⇒ String?

Optional descriptor for the transfer.

Returns:

  • (String, nil) 


42
 
# File 'lib/lithic/models/transfer_create_params.rb', line 42

optional :memo, String

#to ⇒ String

Globally unique identifier for the financial account or card that will receive the funds. Accepted type dependent on the program’s use case.

Returns:

  • (String) 


29
 
# File 'lib/lithic/models/transfer_create_params.rb', line 29

required :to, String

#token ⇒ String?

Customer-provided token that will serve as an idempotency token. This token will become the transaction token.

Returns:

  • (String, nil) 


36
 
# File 'lib/lithic/models/transfer_create_params.rb', line 36

optional :token, String