Class: Yoomoney::Models::PayoutCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/yoomoney/models/payout_create_params.rb,
sig/yoomoney/models/payout_create_params.rbs

Overview

See Also:

  • Yoomoney::Resources::Payouts#create

Defined Under Namespace

Modules: PayoutDestinationData Classes: PersonalData

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(bank_id:, phone:) ⇒ Object

Parameters:

  • bank_id (String) —

    Идентификатор банка.

  • phone (String) —

    Номер телефона.




# File 'lib/yoomoney/models/payout_create_params.rb', line 67

Instance Attribute Details

#amount ⇒ Yoomoney::Models::MonetaryAmount

Сумма выплаты.

Parameters:

Returns:



14
 
# File 'lib/yoomoney/models/payout_create_params.rb', line 14

required :amount, -> { Yoomoney::MonetaryAmount }

#deal ⇒ Yoomoney::Models::PayoutDealInfo?

Данные о сделке.

Parameters:

Returns:



25
 
# File 'lib/yoomoney/models/payout_create_params.rb', line 25

optional :deal, -> { Yoomoney::PayoutDealInfo }

#description ⇒ String?

Описание выплаты.

Parameters:

  • (String)

Returns:

  • (String, nil) 


31
 
# File 'lib/yoomoney/models/payout_create_params.rb', line 31

optional :description, String

#idempotence_key ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


19
 
# File 'lib/yoomoney/models/payout_create_params.rb', line 19

required :idempotence_key, String

#metadata ⇒ Hash{Symbol=>String}?

Любые дополнительные данные, которые нужны вам для работы (например, номер заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil) 


40
 
# File 'lib/yoomoney/models/payout_create_params.rb', line 40

optional :metadata, Yoomoney::Internal::Type::HashOf[String]

#payment_method_id ⇒ String?

Идентификатор сохраненного способа оплаты.

Parameters:

  • (String)

Returns:

  • (String, nil) 


46
 
# File 'lib/yoomoney/models/payout_create_params.rb', line 46

optional :payment_method_id, String

#payout_destination_data ⇒ Yoomoney::Models::PayoutCreateParams::PayoutDestinationData::PayoutToYooMoneyDestinationData, ...

Данные для проведения выплаты.

Returns:



52
 
# File 'lib/yoomoney/models/payout_create_params.rb', line 52

optional :payout_destination_data, union: -> { Yoomoney::PayoutCreateParams::PayoutDestinationData }

#payout_token ⇒ String?

Токен для проведения выплаты.

Parameters:

  • (String)

Returns:

  • (String, nil) 


58
 
# File 'lib/yoomoney/models/payout_create_params.rb', line 58

optional :payout_token, String

#personal_data ⇒ Array<Yoomoney::Models::PayoutCreateParams::PersonalData>?

Персональные данные получателя выплаты.

Returns:



64
65
 
# File 'lib/yoomoney/models/payout_create_params.rb', line 64

optional :personal_data,
-> { Yoomoney::Internal::Type::ArrayOf[Yoomoney::PayoutCreateParams::PersonalData] }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


70
 
# File 'sig/yoomoney/models/payout_create_params.rbs', line 70

def to_hash: -> {