Class: Inttegro::Payout::Failure

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

Overview

Stable, caller-safe information about a terminal payout failure.

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)

Human-readable explanation safe to show to an operator.

Required in the API payload. Wire name: detail.

Returns:

  • (String) 


37
38
39
40
41
 
# File 'lib/inttegro/payout/failure.rb', line 37

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

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

Stable category describing why the payout failed.

Required in the API payload. Wire name: reason.

Returns:



37
38
39
40
41
 
# File 'lib/inttegro/payout/failure.rb', line 37

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

#retryable ⇒ Boolean (readonly)

Whether creating a new payout attempt may succeed without changing the destination or request.

Required in the API payload. Wire name: retryable.

Returns:

  • (Boolean) 


37
38
39
40
41
 
# File 'lib/inttegro/payout/failure.rb', line 37

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