Class: Inttegro::Refund::Failure

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/refund/failure.rb

Overview

Typed representation of the failure object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#detail ⇒ String (readonly)

Safe explanation intended for the merchant. Raw provider and internal diagnostic messages are never returned.

Required in the API payload. Wire name: detail.

Returns:

  • (String) 


39
40
41
42
43
 
# File 'lib/inttegro/refund/failure.rb', line 39

class Failure < T::Struct
  const :detail, String
  const :reason, Inttegro::Refund::FailureReason
  const :retryable, T::Boolean
end

#reason ⇒ Inttegro::Refund::FailureReason (readonly)

Stable, caller-safe reason that terminal refund processing failed. unknown is the fail-closed fallback for an unclassified internal failure.

Required in the API payload. Wire name: reason.

Returns:



39
40
41
42
43
 
# File 'lib/inttegro/refund/failure.rb', line 39

class Failure < T::Struct
  const :detail, String
  const :reason, Inttegro::Refund::FailureReason
  const :retryable, T::Boolean
end

#retryable ⇒ Boolean (readonly)

Whether the underlying condition may be resolved before creating a new, intentional refund request. It never instructs clients to repeat an uncertain money movement.

Required in the API payload. Wire name: retryable.

Returns:

  • (Boolean) 


39
40
41
42
43
 
# File 'lib/inttegro/refund/failure.rb', line 39

class Failure < T::Struct
  const :detail, String
  const :reason, Inttegro::Refund::FailureReason
  const :retryable, T::Boolean
end