Class: Yoomoney::Models::Refund

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/yoomoney/models/refund.rb

Overview

See Also:

• Resources::Refunds#create

Defined Under Namespace

Modules: RefundMethod Classes: CancellationDetails, Deal, RefundAuthorizationDetails

Instance Attribute Summary

• #amount ⇒ Yoomoney::Models::MonetaryAmount

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

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

  Комментарий к статусу canceled.

• #created_at ⇒ Time

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

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

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

• #description ⇒ String^?

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

• #id ⇒ String

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

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

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

• #payment_id ⇒ String

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

• #receipt_registration ⇒ Symbol, ...

  Статус регистрации чека.

• #refund_authorization_details ⇒ Yoomoney::Models::Refund::RefundAuthorizationDetails^?

  Данные об авторизации возврата.

• #refund_method ⇒ Yoomoney::Models::Refund::RefundMethod::SbpRefundMethod, ...

  Способ возврата.

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

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

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

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

Instance Method Summary

• #initialize(rrn: 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(rrn: nil) ⇒ Object

Данные об авторизации возврата.

Parameters:

• rrn (String) (defaults to: nil)

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

Instance Attribute Details

#amount ⇒ Yoomoney::Models::MonetaryAmount

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

Returns:

• (Yoomoney::Models::MonetaryAmount)

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

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

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

Комментарий к статусу canceled.

Returns:

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

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

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

#created_at ⇒ Time

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

Returns:

• (Time)

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

required :created_at, Time

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

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

Returns:

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

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

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

#description ⇒ String^?

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

Returns:

• (String, nil)

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

optional :description, String

#id ⇒ String

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

Returns:

• (String)

# File 'lib/yoomoney/models/refund.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/refund.rb', line 62

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

#payment_id ⇒ String

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

Returns:

• (String)

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

required :payment_id, String

#receipt_registration ⇒ Symbol, ...

Статус регистрации чека.

Returns:

• (Symbol, Yoomoney::Models::ReceiptRegistrationStatus, nil)

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

optional :receipt_registration, enum: -> { Yoomoney::ReceiptRegistrationStatus }

#refund_authorization_details ⇒ Yoomoney::Models::Refund::RefundAuthorizationDetails^?

Данные об авторизации возврата.

Returns:

• (Yoomoney::Models::Refund::RefundAuthorizationDetails, nil)

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

optional :refund_authorization_details, -> { Yoomoney::Refund::RefundAuthorizationDetails }

#refund_method ⇒ Yoomoney::Models::Refund::RefundMethod::SbpRefundMethod, ...

Способ возврата.

Returns:

• (Yoomoney::Models::Refund::RefundMethod::SbpRefundMethod, Yoomoney::Models::Refund::RefundMethod::ElectronicCertificateRefundMethod, nil)

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

optional :refund_method, union: -> { Yoomoney::Refund::RefundMethod }

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

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

Returns:

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

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

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

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

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

Returns:

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

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

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