Class: Yoomoney::Models::Payout

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Yoomoney::Models::Payout

Defined in:

lib/yoomoney/models/payout.rb

Overview

See Also:

• Resources::Payouts#create

Defined Under Namespace

Modules: PayoutDestination Classes: CancellationDetails, Receipt, SelfEmployed

Instance Attribute Summary

• #amount ⇒ Yoomoney::Models::MonetaryAmount

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

• #cancellation_details ⇒ Yoomoney::Models::Payout::CancellationDetails^?

  Детали отмены выплаты.

• #created_at ⇒ Time

  Время создания выплаты.

• #deal ⇒ Yoomoney::Models::PayoutDealInfo^?

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

• #description ⇒ String^?

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

• #id ⇒ String

  Идентификатор выплаты.

• #metadata ⇒ Hash{Symbol=>String}^?

  Любые дополнительные данные, которые нужны вам для работы (например, номер заказа).

• #payout_destination ⇒ Yoomoney::Models::Payout::PayoutDestination::PayoutToCardDestination, ...

  Данные о назначении выплаты.

• #receipt ⇒ Yoomoney::Models::Payout::Receipt^?

  Данные о чеке.

• #self_employed ⇒ Yoomoney::Models::Payout::SelfEmployed^?

  Данные о самозанятом.

• #status ⇒ Symbol, Yoomoney::Models::PayoutStatus

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

• #succeeded_at ⇒ Time^?

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

• #test_ ⇒ Boolean

  Признак тестовой операции.

Class Method Summary

• .variants ⇒ Array(Yoomoney::Models::Payout::PayoutDestination::PayoutToCardDestination, Yoomoney::Models::Payout::PayoutDestination::PayoutToYooMoneyDestination, Yoomoney::Models::Payout::PayoutDestination::PayoutToSbpDestination)

Instance Method Summary

• #initialize(service_name:, amount: nil, npd_receipt_id: nil, url: nil) ⇒ Object constructor

  Данные о чеке.

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(service_name:, amount: nil, npd_receipt_id: nil, url: nil) ⇒ Object

Данные о чеке.

Parameters:

• service_name (String)
• amount (Yoomoney::Models::MonetaryAmount) (defaults to: nil)
• npd_receipt_id (String) (defaults to: nil)
• url (String) (defaults to: nil)

# File 'lib/yoomoney/models/payout.rb', line 88

Instance Attribute Details

#amount ⇒ Yoomoney::Models::MonetaryAmount

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

Returns:

• (Yoomoney::Models::MonetaryAmount)

# File 'lib/yoomoney/models/payout.rb', line 17

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

#cancellation_details ⇒ Yoomoney::Models::Payout::CancellationDetails^?

Детали отмены выплаты.

Returns:

• (Yoomoney::Models::Payout::CancellationDetails, nil)

# File 'lib/yoomoney/models/payout.rb', line 47

optional :cancellation_details, -> { Yoomoney::Payout::CancellationDetails }

#created_at ⇒ Time

Время создания выплаты.

Returns:

• (Time)

# File 'lib/yoomoney/models/payout.rb', line 23

required :created_at, Time

#deal ⇒ Yoomoney::Models::PayoutDealInfo^?

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

Returns:

• (Yoomoney::Models::PayoutDealInfo, nil)

# File 'lib/yoomoney/models/payout.rb', line 53

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

#description ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/yoomoney/models/payout.rb', line 59

optional :description, String

#id ⇒ String

Идентификатор выплаты.

Returns:

• (String)

# File 'lib/yoomoney/models/payout.rb', line 11

required :id, String

#metadata ⇒ Hash{Symbol=>String}^?

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

Returns:

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

# File 'lib/yoomoney/models/payout.rb', line 68

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

#payout_destination ⇒ Yoomoney::Models::Payout::PayoutDestination::PayoutToCardDestination, ...

Данные о назначении выплаты.

Returns:

• (Yoomoney::Models::Payout::PayoutDestination::PayoutToCardDestination, Yoomoney::Models::Payout::PayoutDestination::PayoutToYooMoneyDestination, Yoomoney::Models::Payout::PayoutDestination::PayoutToSbpDestination)

# File 'lib/yoomoney/models/payout.rb', line 29

required :payout_destination, union: -> { Yoomoney::Payout::PayoutDestination }

#receipt ⇒ Yoomoney::Models::Payout::Receipt^?

Данные о чеке.

Returns:

• (Yoomoney::Models::Payout::Receipt, nil)

# File 'lib/yoomoney/models/payout.rb', line 74

optional :receipt, -> { Yoomoney::Payout::Receipt }

#self_employed ⇒ Yoomoney::Models::Payout::SelfEmployed^?

Данные о самозанятом.

Returns:

• (Yoomoney::Models::Payout::SelfEmployed, nil)

# File 'lib/yoomoney/models/payout.rb', line 80

optional :self_employed, -> { Yoomoney::Payout::SelfEmployed }

#status ⇒ Symbol, Yoomoney::Models::PayoutStatus

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

Returns:

• (Symbol, Yoomoney::Models::PayoutStatus)

# File 'lib/yoomoney/models/payout.rb', line 35

required :status, enum: -> { Yoomoney::PayoutStatus }

#succeeded_at ⇒ Time^?

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

Returns:

• (Time, nil)

# File 'lib/yoomoney/models/payout.rb', line 86

optional :succeeded_at, Time

#test_ ⇒ Boolean

Признак тестовой операции.

Returns:

• (Boolean)

# File 'lib/yoomoney/models/payout.rb', line 41

required :test_, Yoomoney::Internal::Type::Boolean, api_name: :test

Class Method Details

.variants ⇒ Array(Yoomoney::Models::Payout::PayoutDestination::PayoutToCardDestination, Yoomoney::Models::Payout::PayoutDestination::PayoutToYooMoneyDestination, Yoomoney::Models::Payout::PayoutDestination::PayoutToSbpDestination)

Returns:

• (Array(Yoomoney::Models::Payout::PayoutDestination::PayoutToCardDestination, Yoomoney::Models::Payout::PayoutDestination::PayoutToYooMoneyDestination, Yoomoney::Models::Payout::PayoutDestination::PayoutToSbpDestination))

# File 'lib/yoomoney/models/payout.rb', line 200