Class: Yoomoney::Models::RefundCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/yoomoney/models/refund_create_params.rb

Overview

See Also:

• Resources::Refunds#create

Defined Under Namespace

Classes: Deal, RefundMethodData

Instance Attribute Summary

• #amount ⇒ Yoomoney::Models::MonetaryAmount

  Сумма возврата.

• #deal ⇒ Yoomoney::Models::RefundCreateParams::Deal^?

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

• #description ⇒ String^?

  Описание возврата.

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

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

• #payment_id ⇒ String

  Идентификатор платежа для возврата.

• #receipt ⇒ Yoomoney::Models::ReceiptData^?

  Данные для формирования чека.

• #refund_method_data ⇒ Yoomoney::Models::RefundCreateParams::RefundMethodData^?

  Данные о способе возврата.

• #sources ⇒ Array<Yoomoney::Models::RefundSourcesData>^?

  Источники для возврата.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(amount:, type:) ⇒ 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(amount:, type:) ⇒ Object

Parameters:

• amount (Yoomoney::Models::MonetaryAmount)
• type (Symbol, Yoomoney::Models::SettlementItemType)

# File 'lib/yoomoney/models/refund_create_params.rb', line 114

Instance Attribute Details

#amount ⇒ Yoomoney::Models::MonetaryAmount

Сумма возврата.

Returns:

• (Yoomoney::Models::MonetaryAmount)

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

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

#deal ⇒ Yoomoney::Models::RefundCreateParams::Deal^?

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

Returns:

• (Yoomoney::Models::RefundCreateParams::Deal, nil)

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

optional :deal, -> { Yoomoney::RefundCreateParams::Deal }

#description ⇒ String^?

Описание возврата.

Returns:

• (String, nil)

# File 'lib/yoomoney/models/refund_create_params.rb', line 37

optional :description, String

#idempotence_key ⇒ String

Returns:

• (String)

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

required :idempotence_key, String

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

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

Returns:

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

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

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

#payment_id ⇒ String

Идентификатор платежа для возврата.

Returns:

• (String)

# File 'lib/yoomoney/models/refund_create_params.rb', line 20

required :payment_id, String

#receipt ⇒ Yoomoney::Models::ReceiptData^?

Данные для формирования чека.

Returns:

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

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

optional :receipt, -> { Yoomoney::ReceiptData }

#refund_method_data ⇒ Yoomoney::Models::RefundCreateParams::RefundMethodData^?

Данные о способе возврата.

Returns:

• (Yoomoney::Models::RefundCreateParams::RefundMethodData, nil)

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

optional :refund_method_data, -> { Yoomoney::RefundCreateParams::RefundMethodData }

#sources ⇒ Array<Yoomoney::Models::RefundSourcesData>^?

Источники для возврата.

Returns:

• (Array<Yoomoney::Models::RefundSourcesData>, nil)

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

optional :sources, -> { Yoomoney::Internal::Type::ArrayOf[Yoomoney::RefundSourcesData] }