Class: Lithic::Models::HoldCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Lithic::Models::HoldCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/lithic/models/hold_create_params.rb

Overview

See Also:

• Resources::Holds#create

Instance Attribute Summary

• #amount ⇒ Integer

  Amount to hold in cents.

• #expiration_datetime ⇒ Time^?

  When the hold should auto-expire.

• #financial_account_token ⇒ String
• #memo ⇒ String^?

  Reason for the hold.

• #token ⇒ String^?

  Customer-provided token for idempotency.

• #user_defined_id ⇒ String^?

  User-provided identifier for the hold.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(financial_account_token:, amount:, token: nil, expiration_datetime: nil, memo: nil, user_defined_id: nil, request_options: {}) ⇒ Object constructor

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(financial_account_token:, amount:, token: nil, expiration_datetime: nil, memo: nil, user_defined_id: nil, request_options: {}) ⇒ Object

Parameters:

• financial_account_token (String)
• amount (Integer) —

  Amount to hold in cents

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

  Customer-provided token for idempotency. Becomes the hold token.

• expiration_datetime (Time) (defaults to: nil) —

  When the hold should auto-expire

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

  Reason for the hold

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

  User-provided identifier for the hold

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

# File 'lib/lithic/models/hold_create_params.rb', line 45

Instance Attribute Details

#amount ⇒ Integer

Amount to hold in cents

Returns:

• (Integer)

# File 'lib/lithic/models/hold_create_params.rb', line 19

required :amount, Integer

#expiration_datetime ⇒ Time^?

When the hold should auto-expire

Returns:

• (Time, nil)

# File 'lib/lithic/models/hold_create_params.rb', line 31

optional :expiration_datetime, Time

#financial_account_token ⇒ String

Returns:

• (String)

# File 'lib/lithic/models/hold_create_params.rb', line 13

required :financial_account_token, String

#memo ⇒ String^?

Reason for the hold

Returns:

• (String, nil)

# File 'lib/lithic/models/hold_create_params.rb', line 37

optional :memo, String, nil?: true

#token ⇒ String^?

Customer-provided token for idempotency. Becomes the hold token.

Returns:

• (String, nil)

# File 'lib/lithic/models/hold_create_params.rb', line 25

optional :token, String

#user_defined_id ⇒ String^?

User-provided identifier for the hold

Returns:

• (String, nil)

# File 'lib/lithic/models/hold_create_params.rb', line 43

optional :user_defined_id, String