Class: Inttegro::Payout::BalanceTransaction

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

Overview

A historical view of one balance transaction's contribution to a payout. Released contributions remain present so clients can inspect the payout's original composition.

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

#allocated_amount ⇒ Inttegro::Money::Amount (readonly)

Value of the allocated_amount field in the Inttegro API payload.

Required in the API payload. Wire name: allocated_amount.

Returns:



45
46
47
48
49
50
 
# File 'lib/inttegro/payout/balance_transaction.rb', line 45

class BalanceTransaction < T::Struct
  const :allocated_amount, Inttegro::Money::Amount
  const :amount, Inttegro::Money::Amount
  const :id, String
  const :status, Inttegro::Payout::BalanceTransactionStatus
end

#amount ⇒ Inttegro::Money::Amount (readonly)

Value of the amount field in the Inttegro API payload.

Required in the API payload. Wire name: amount.

Returns:



45
46
47
48
49
50
 
# File 'lib/inttegro/payout/balance_transaction.rb', line 45

class BalanceTransaction < T::Struct
  const :allocated_amount, Inttegro::Money::Amount
  const :amount, Inttegro::Money::Amount
  const :id, String
  const :status, Inttegro::Payout::BalanceTransactionStatus
end

#id ⇒ String (readonly)

Unique balance transaction identifier.

Required in the API payload. Wire name: id.

Returns:

  • (String) 


45
46
47
48
49
50
 
# File 'lib/inttegro/payout/balance_transaction.rb', line 45

class BalanceTransaction < T::Struct
  const :allocated_amount, Inttegro::Money::Amount
  const :amount, Inttegro::Money::Amount
  const :id, String
  const :status, Inttegro::Payout::BalanceTransactionStatus
end

#status ⇒ Inttegro::Payout::BalanceTransactionStatus (readonly)

Whether this contribution is still reserved for the payout, was consumed by a successful payout, or was released after the payout did not complete.

Required in the API payload. Wire name: status.

Returns:



45
46
47
48
49
50
 
# File 'lib/inttegro/payout/balance_transaction.rb', line 45

class BalanceTransaction < T::Struct
  const :allocated_amount, Inttegro::Money::Amount
  const :amount, Inttegro::Money::Amount
  const :id, String
  const :status, Inttegro::Payout::BalanceTransactionStatus
end