Class: Lithic::Models::BookTransferCreateParams

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

Overview

See Also:

Defined Under Namespace

Modules: Category, OnClosedAccount, Type

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class 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, #initialize, 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

This class inherits a constructor from Lithic::Internal::Type::BaseModel

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/book_transfer_create_params.rb', line 15

required :amount, Integer

#category ⇒ Symbol, Lithic::Models::BookTransferCreateParams::Category

Returns:



20
 
# File 'lib/lithic/models/book_transfer_create_params.rb', line 20

required :category, enum: -> { Lithic::BookTransferCreateParams::Category }

#external_id ⇒ String?

External ID defined by the customer

Returns:

  • (String, nil) 


59
 
# File 'lib/lithic/models/book_transfer_create_params.rb', line 59

optional :external_id, String

#from_financial_account_token ⇒ 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) 


27
 
# File 'lib/lithic/models/book_transfer_create_params.rb', line 27

required :from_financial_account_token, String

#memo ⇒ String?

Optional descriptor for the transfer.

Returns:

  • (String, nil) 


65
 
# File 'lib/lithic/models/book_transfer_create_params.rb', line 65

optional :memo, String

#on_closed_account ⇒ Symbol, ...

What to do if the financial account is closed when posting an operation

Returns:



71
 
# File 'lib/lithic/models/book_transfer_create_params.rb', line 71

optional :on_closed_account, enum: -> { Lithic::BookTransferCreateParams::OnClosedAccount }

#subtype ⇒ String

The program specific subtype code for the specified category/type.

Returns:

  • (String) 


33
 
# File 'lib/lithic/models/book_transfer_create_params.rb', line 33

required :subtype, String

#to_financial_account_token ⇒ 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) 


40
 
# File 'lib/lithic/models/book_transfer_create_params.rb', line 40

required :to_financial_account_token, String

#token ⇒ String?

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

Returns:

  • (String, nil) 


53
 
# File 'lib/lithic/models/book_transfer_create_params.rb', line 53

optional :token, String

#type ⇒ Symbol, Lithic::Models::BookTransferCreateParams::Type

Type of the book transfer

Returns:



46
 
# File 'lib/lithic/models/book_transfer_create_params.rb', line 46

required :type, enum: -> { Lithic::BookTransferCreateParams::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/book_transfer_create_params.rb', line 112