inttegro 8.0.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2305c5215117569a70513f2a50edb305bac527c0818ee25cf2a1b27cd8ee15f1
-  data.tar.gz: c5696096aaec5c002b4639b5abeb2af8d0a53b9fc831389a47359afcf382bbcd
+  metadata.gz: 608a68da5f01abba8df499233779b428564f247ede7b80311b3af48168898519
+  data.tar.gz: 6eed899188c50ed6611cb0f6180dde027c53065ae5f9ea1ebe9613b36e04a725
 SHA512:
-  metadata.gz: de19b8f9eec5d03f7aa1a9e3a4a10151470e5af3978daea2fa77ba31adb5981b4c9a51b0b4d8e74d18f6e04afcfe7f2ffca61e0794335400bb8ea33c9f443acf
-  data.tar.gz: 7bfcbd510c93d0dcbb207b047a135ccc7af3177e351648340a28691eda9359436626654e37c7536a1e783f32e2b60c24e4eac868d6dfa8da85a67b8dc4af27d0
+  metadata.gz: b5624cef6cd5474eacb13dba6b2d8ec90b9600383b429c316d2d249a3d4fb97bb80c907890c2670af46f317f386bdd630c1b671f8698cd7ee68cefa8325aacde
+  data.tar.gz: a862487a146d0db29481f0593d77e872f45115d86920314e64f8250284985297fc8ba41a0e523a9548f5e04a62faf3b3a7ad40e3446558cb37d27e129cbe60bb

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [9.0.0] - 2026-09-23
+
+- Breaking: replaced payout `balance_transactions` ID strings with typed
+  contribution values containing the source transaction's original amount and
+  the exact amount allocated to the payout.
+- Added complete payment balance-transaction allocation history together with
+  available, pending, and spent amount partitions.
+
+## [8.1.0] - 2026-09-21
+
+- Added typed search across customers, financial accounts, orders, payouts, and
+  products, including filters, facets, sorting, cursor pagination, totals, and
+  freshness metadata.
+- Added typed verification purposes for OTP initiation requests.
+
 ## [8.0.0] - 2026-09-16
 
 - Breaking: replaced generic custom-data hashes with immutable Sorbet-typed

data/lib/inttegro/balance_transaction/allocation.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "payout_allocation"
+require_relative "refund_allocation"
+
+module Inttegro
+  class BalanceTransaction
+    # A caller-safe allocation of part of a payment balance transaction to a refund or payout.
+    #
+    # @api public
+    # @return [Inttegro::BalanceTransaction::RefundAllocation, Inttegro::BalanceTransaction::PayoutAllocation]
+    Allocation = T.type_alias { T.any(Inttegro::BalanceTransaction::RefundAllocation, Inttegro::BalanceTransaction::PayoutAllocation) }
+  end
+end

data/lib/inttegro/balance_transaction/allocation_base.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "allocation_base_type"
+require_relative "allocation_status"
+
+module Inttegro
+  class BalanceTransaction
+    # Typed representation of the allocation base 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.
+    #
+    # @api public
+    #
+    # @!attribute [r] completed_at
+    #   When the allocated amount became permanently consumed. Present only when `status` is
+    #   `completed`.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `completed_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] created_at
+    #   When the amount first became unavailable for another refund or payout.
+    #
+    #   Required in the API payload. Wire name: `created_at`.
+    #   @return [Time]
+    #
+    # @!attribute [r] id
+    #   Stable public allocation identifier for reconciliation and support.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] status
+    #   Public effect of an allocation on the source payment balance transaction. Internal
+    #   reservation and reconciliation states are not exposed.
+    #
+    #   Required in the API payload. Wire name: `status`.
+    #   @return [Inttegro::BalanceTransaction::AllocationStatus]
+    #
+    # @!attribute [r] type
+    #   Value of the `type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::BalanceTransaction::AllocationBaseType]
+    #
+    # @!attribute [r] updated_at
+    #   When the public allocation status last changed.
+    #
+    #   Required in the API payload. Wire name: `updated_at`.
+    #   @return [Time]
+    class AllocationBase < T::Struct
+      const :completed_at, T.nilable(Time), default: nil
+      const :created_at, Time
+      const :id, String
+      const :status, Inttegro::BalanceTransaction::AllocationStatus
+      const :type, Inttegro::BalanceTransaction::AllocationBaseType
+      const :updated_at, Time
+    end
+  end
+end

data/lib/inttegro/balance_transaction/allocation_base_type.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class BalanceTransaction
+    # String-backed values accepted by the Inttegro API for
+    # Inttegro::BalanceTransaction::AllocationBaseType.
+    #
+    # Use the constants below when constructing a request. `#serialize` returns the documented
+    # string wire value received from or sent to the API.
+    #
+    # @api public
+    class AllocationBaseType < T::Enum
+      enums do
+        # Serialized wire value: `payout`.
+        # @return [Inttegro::BalanceTransaction::AllocationBaseType]
+        PAYOUT = new("payout")
+        # Serialized wire value: `refund`.
+        # @return [Inttegro::BalanceTransaction::AllocationBaseType]
+        REFUND = new("refund")
+      end
+    end
+  end
+end

data/lib/inttegro/balance_transaction/allocation_status.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class BalanceTransaction
+    # Public effect of an allocation on the source payment balance transaction. Internal
+    # reservation and reconciliation states are not exposed.
+    #
+    # Use the constants below when constructing a request. `#serialize` returns the documented
+    # string wire value received from or sent to the API.
+    #
+    # @api public
+    class AllocationStatus < T::Enum
+      enums do
+        # Serialized wire value: `pending`.
+        # @return [Inttegro::BalanceTransaction::AllocationStatus]
+        PENDING = new("pending")
+        # Serialized wire value: `completed`.
+        # @return [Inttegro::BalanceTransaction::AllocationStatus]
+        COMPLETED = new("completed")
+      end
+    end
+  end
+end

data/lib/inttegro/balance_transaction/available_amount.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class BalanceTransaction
+    # Amount still available for a refund or payout. Present only when `type` is `payment`.
+    #
+    # 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.
+    #
+    # @api public
+    #
+    # @!attribute [r] currency
+    #   Currency code as stored on the transaction
+    #
+    #   Required in the API payload. Wire name: `currency`.
+    #   @return [String]
+    #
+    # @!attribute [r] value
+    #   Unsigned amount in the currency's smallest unit
+    #
+    #   Required in the API payload. Wire name: `value`.
+    #   @return [Integer]
+    class AvailableAmount < T::Struct
+      const :currency, String
+      const :value, Integer
+    end
+  end
+end

data/lib/inttegro/balance_transaction/balance_transaction.rb

@@ -4,14 +4,21 @@
 # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
 
 require_relative "base"
+require_relative "allocation"
 require_relative "amount"
+require_relative "available_amount"
 require_relative "payout_configuration"
+require_relative "pending_amount"
+require_relative "spent_amount"
 require_relative "type"
 
 module Inttegro
   # Merchant balance entry caused by a payment or refund. `type` describes the semantic source,
   # not direction. A payment transaction contains `payment_id`; a refund transaction contains
-  # `refund_id`. Exactly one matching reference is present.
+  # `refund_id`. Exactly one matching reference is present. Payment transactions also expose
+  # their complete current allocation state and disjoint available, pending, and spent amounts.
+  # Allocation fields are omitted from refund transactions because refund transactions are
+  # consumers rather than sources.
   #
   # 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
@@ -25,6 +32,19 @@ module Inttegro
   #   Required in the API payload. Wire name: `amount`.
   #   @return [Inttegro::BalanceTransaction::Amount]
   #
+  # @!attribute [r] allocations
+  #   All current pending and completed allocations of this payment transaction. Released
+  #   allocations are omitted. Present only when `type` is `payment`.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `allocations`.
+  #   @return [Array<Inttegro::BalanceTransaction::Allocation>, nil]
+  #
+  # @!attribute [r] available_amount
+  #   Amount still available for a refund or payout. Present only when `type` is `payment`.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `available_amount`.
+  #   @return [Inttegro::BalanceTransaction::AvailableAmount, nil]
+  #
   # @!attribute [r] available_at
   #   Value of the `available_at` field in the Inttegro API payload.
   #
@@ -32,7 +52,8 @@ module Inttegro
   #   @return [Time, nil]
   #
   # @!attribute [r] claimed_at
-  #   Value of the `claimed_at` field in the Inttegro API payload.
+  #   Legacy whole-transaction payout claim timestamp. New integrations should inspect
+  #   `allocations`.
   #
   #   Optional in the API payload; omitted values default to `nil`. Wire name: `claimed_at`.
   #   @return [Time, nil]
@@ -56,11 +77,19 @@ module Inttegro
   #   @return [String]
   #
   # @!attribute [r] paid_at
-  #   Value of the `paid_at` field in the Inttegro API payload.
+  #   Legacy whole-transaction payout completion timestamp. New integrations should inspect
+  #   `allocations`.
   #
   #   Optional in the API payload; omitted values default to `nil`. Wire name: `paid_at`.
   #   @return [Time, nil]
   #
+  # @!attribute [r] pending_amount
+  #   Amount temporarily unavailable because a refund or payout is unresolved. Present only when
+  #   `type` is `payment`.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `pending_amount`.
+  #   @return [Inttegro::BalanceTransaction::PendingAmount, nil]
+  #
   # @!attribute [r] payment_id
   #   Present when `type` is `payment`; omitted when `type` is `refund`.
   #
@@ -68,7 +97,8 @@ module Inttegro
   #   @return [String, nil]
   #
   # @!attribute [r] payout_id
-  #   Value of the `payout_id` field in the Inttegro API payload.
+  #   Legacy payout owning the whole transaction remainder. New integrations should inspect
+  #   `allocations` because one transaction can participate in many payouts.
   #
   #   Optional in the API payload; omitted values default to `nil`. Wire name: `payout_id`.
   #   @return [String, nil]
@@ -85,6 +115,13 @@ module Inttegro
   #   Optional in the API payload; omitted values default to `nil`. Wire name: `refund_id`.
   #   @return [String, nil]
   #
+  # @!attribute [r] spent_amount
+  #   Amount permanently consumed by completed refunds and payouts. Present only when `type` is
+  #   `payment`.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `spent_amount`.
+  #   @return [Inttegro::BalanceTransaction::SpentAmount, nil]
+  #
   # @!attribute [r] type
   #   Semantic source or cause of the transaction, not its direction.
   #
@@ -92,16 +129,41 @@ module Inttegro
   #   @return [Inttegro::BalanceTransaction::Type]
   class BalanceTransaction
     const :amount, Inttegro::BalanceTransaction::Amount
+    const :allocations, T.nilable(T::Array[Inttegro::BalanceTransaction::Allocation]), default: nil
+    const :available_amount, T.nilable(Inttegro::BalanceTransaction::AvailableAmount), default: nil
     const :available_at, T.nilable(Time), default: nil
     const :claimed_at, T.nilable(Time), default: nil
     const :created_at, Time
     const :id, String
     const :order_id, String
     const :paid_at, T.nilable(Time), default: nil
+    const :pending_amount, T.nilable(Inttegro::BalanceTransaction::PendingAmount), default: nil
     const :payment_id, T.nilable(String), default: nil
     const :payout_id, T.nilable(String), default: nil
     const :payout_configuration, T.nilable(Inttegro::BalanceTransaction::PayoutConfiguration), default: nil
     const :refund_id, T.nilable(String), default: nil
+    const :spent_amount, T.nilable(Inttegro::BalanceTransaction::SpentAmount), default: nil
     const :type, Inttegro::BalanceTransaction::Type
+
+    extend T::Sig
+
+    sig { params(hash: T::Hash[String, Object], strict: T::Boolean).returns(T.attached_class) }
+    def self.from_hash(hash, strict = false)
+      data = hash.dup
+      if (allocations_value = data["allocations"]).is_a?(Array)
+        data["allocations"] = allocations_value.map do |item|
+          next item unless item.is_a?(Hash)
+          case item["type"]
+          when "payout"
+            Inttegro::BalanceTransaction::PayoutAllocation.from_hash(item)
+          when "refund"
+            Inttegro::BalanceTransaction::RefundAllocation.from_hash(item)
+          else
+            item
+          end
+        end
+      end
+      super(data, strict)
+    end
   end
 end

data/lib/inttegro/balance_transaction/payout_allocation.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "allocation_status"
+require_relative "payout_allocation_payout"
+require_relative "payout_allocation_type"
+
+module Inttegro
+  class BalanceTransaction
+    # Typed representation of the payout allocation 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.
+    #
+    # @api public
+    #
+    # @!attribute [r] completed_at
+    #   When the allocated amount became permanently consumed. Present only when `status` is
+    #   `completed`.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `completed_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] created_at
+    #   When the amount first became unavailable for another refund or payout.
+    #
+    #   Required in the API payload. Wire name: `created_at`.
+    #   @return [Time]
+    #
+    # @!attribute [r] id
+    #   Stable public allocation identifier for reconciliation and support.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] status
+    #   Public effect of an allocation on the source payment balance transaction. Internal
+    #   reservation and reconciliation states are not exposed.
+    #
+    #   Required in the API payload. Wire name: `status`.
+    #   @return [Inttegro::BalanceTransaction::AllocationStatus]
+    #
+    # @!attribute [r] type
+    #   Value of the `type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::BalanceTransaction::PayoutAllocationType]
+    #
+    # @!attribute [r] updated_at
+    #   When the public allocation status last changed.
+    #
+    #   Required in the API payload. Wire name: `updated_at`.
+    #   @return [Time]
+    #
+    # @!attribute [r] payout
+    #   Value of the `payout` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `payout`.
+    #   @return [Inttegro::BalanceTransaction::PayoutAllocationPayout]
+    class PayoutAllocation < T::Struct
+      const :completed_at, T.nilable(Time), default: nil
+      const :created_at, Time
+      const :id, String
+      const :status, Inttegro::BalanceTransaction::AllocationStatus
+      const :type, Inttegro::BalanceTransaction::PayoutAllocationType
+      const :updated_at, Time
+      const :payout, Inttegro::BalanceTransaction::PayoutAllocationPayout
+    end
+  end
+end

data/lib/inttegro/balance_transaction/payout_allocation_payout.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "amount"
+
+module Inttegro
+  class BalanceTransaction
+    # Typed representation of the payout allocation payout 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.
+    #
+    # @api public
+    #
+    # @!attribute [r] amount
+    #   Value of the `amount` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `amount`.
+    #   @return [Inttegro::BalanceTransaction::Amount]
+    #
+    # @!attribute [r] id
+    #   Value of the `id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    class PayoutAllocationPayout < T::Struct
+      const :amount, Inttegro::BalanceTransaction::Amount
+      const :id, String
+    end
+  end
+end

data/lib/inttegro/balance_transaction/payout_allocation_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class BalanceTransaction
+    # String-backed values accepted by the Inttegro API for
+    # Inttegro::BalanceTransaction::PayoutAllocationType.
+    #
+    # Use the constants below when constructing a request. `#serialize` returns the documented
+    # string wire value received from or sent to the API.
+    #
+    # @api public
+    class PayoutAllocationType < T::Enum
+      enums do
+        # Serialized wire value: `payout`.
+        # @return [Inttegro::BalanceTransaction::PayoutAllocationType]
+        PAYOUT = new("payout")
+      end
+    end
+  end
+end

data/lib/inttegro/balance_transaction/pending_amount.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class BalanceTransaction
+    # Amount temporarily unavailable because a refund or payout is unresolved. Present only when
+    # `type` is `payment`.
+    #
+    # 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.
+    #
+    # @api public
+    #
+    # @!attribute [r] currency
+    #   Currency code as stored on the transaction
+    #
+    #   Required in the API payload. Wire name: `currency`.
+    #   @return [String]
+    #
+    # @!attribute [r] value
+    #   Unsigned amount in the currency's smallest unit
+    #
+    #   Required in the API payload. Wire name: `value`.
+    #   @return [Integer]
+    class PendingAmount < T::Struct
+      const :currency, String
+      const :value, Integer
+    end
+  end
+end

data/lib/inttegro/balance_transaction/refund_allocation.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "allocation_status"
+require_relative "refund_allocation_refund"
+require_relative "refund_allocation_type"
+
+module Inttegro
+  class BalanceTransaction
+    # Typed representation of the refund allocation 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.
+    #
+    # @api public
+    #
+    # @!attribute [r] completed_at
+    #   When the allocated amount became permanently consumed. Present only when `status` is
+    #   `completed`.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `completed_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] created_at
+    #   When the amount first became unavailable for another refund or payout.
+    #
+    #   Required in the API payload. Wire name: `created_at`.
+    #   @return [Time]
+    #
+    # @!attribute [r] id
+    #   Stable public allocation identifier for reconciliation and support.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] status
+    #   Public effect of an allocation on the source payment balance transaction. Internal
+    #   reservation and reconciliation states are not exposed.
+    #
+    #   Required in the API payload. Wire name: `status`.
+    #   @return [Inttegro::BalanceTransaction::AllocationStatus]
+    #
+    # @!attribute [r] type
+    #   Value of the `type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::BalanceTransaction::RefundAllocationType]
+    #
+    # @!attribute [r] updated_at
+    #   When the public allocation status last changed.
+    #
+    #   Required in the API payload. Wire name: `updated_at`.
+    #   @return [Time]
+    #
+    # @!attribute [r] refund
+    #   Value of the `refund` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `refund`.
+    #   @return [Inttegro::BalanceTransaction::RefundAllocationRefund]
+    class RefundAllocation < T::Struct
+      const :completed_at, T.nilable(Time), default: nil
+      const :created_at, Time
+      const :id, String
+      const :status, Inttegro::BalanceTransaction::AllocationStatus
+      const :type, Inttegro::BalanceTransaction::RefundAllocationType
+      const :updated_at, Time
+      const :refund, Inttegro::BalanceTransaction::RefundAllocationRefund
+    end
+  end
+end

data/lib/inttegro/balance_transaction/refund_allocation_refund.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "amount"
+
+module Inttegro
+  class BalanceTransaction
+    # Typed representation of the refund allocation refund 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.
+    #
+    # @api public
+    #
+    # @!attribute [r] amount
+    #   Value of the `amount` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `amount`.
+    #   @return [Inttegro::BalanceTransaction::Amount]
+    #
+    # @!attribute [r] id
+    #   Value of the `id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    class RefundAllocationRefund < T::Struct
+      const :amount, Inttegro::BalanceTransaction::Amount
+      const :id, String
+    end
+  end
+end

data/lib/inttegro/balance_transaction/refund_allocation_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class BalanceTransaction
+    # String-backed values accepted by the Inttegro API for
+    # Inttegro::BalanceTransaction::RefundAllocationType.
+    #
+    # Use the constants below when constructing a request. `#serialize` returns the documented
+    # string wire value received from or sent to the API.
+    #
+    # @api public
+    class RefundAllocationType < T::Enum
+      enums do
+        # Serialized wire value: `refund`.
+        # @return [Inttegro::BalanceTransaction::RefundAllocationType]
+        REFUND = new("refund")
+      end
+    end
+  end
+end

data/lib/inttegro/balance_transaction/response.rb

@@ -19,7 +19,10 @@ module Inttegro
     # @!attribute [r] transaction
     #   Merchant balance entry caused by a payment or refund. `type` describes the semantic source,
     #   not direction. A payment transaction contains `payment_id`; a refund transaction contains
-    #   `refund_id`. Exactly one matching reference is present.
+    #   `refund_id`. Exactly one matching reference is present. Payment transactions also expose
+    #   their complete current allocation state and disjoint available, pending, and spent amounts.
+    #   Allocation fields are omitted from refund transactions because refund transactions are
+    #   consumers rather than sources.
     #
     #   Required in the API payload. Wire name: `transaction`.
     #   @return [Inttegro::BalanceTransaction]