straddle 0.5.0 → 1.0.0

data/lib/straddle/models/funding_event_list_payments_params.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::FundingEvents#list_payments
+    class FundingEventListPaymentsParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute default_page_size
+      #   Default number of results returned per page.
+      #
+      #   @return [Integer, nil]
+      optional :default_page_size, Integer
+
+      # @!attribute default_sort
+      #   Default field used to sort the results.
+      #
+      #   @return [Symbol, Straddle::Models::FundingEventListPaymentsParams::DefaultSort, nil]
+      optional :default_sort, enum: -> { Straddle::FundingEventListPaymentsParams::DefaultSort }
+
+      # @!attribute default_sort_order
+      #   Default order in which to sort the results.
+      #
+      #   @return [Symbol, Straddle::Models::SortOrder, nil]
+      optional :default_sort_order, enum: -> { Straddle::SortOrder }
+
+      # @!attribute include_metadata
+      #   When `true`, includes each payment's metadata. Defaults to `false`.
+      #
+      #   @return [Boolean, nil]
+      optional :include_metadata, Straddle::Internal::Type::Boolean
+
+      # @!attribute page_number
+      #   Results page number. Starts at 1. Defaults to 1.
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Number of results per page. Maximum 1,000. Defaults to 100.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute sort_by
+      #   Field used to sort the results.
+      #
+      #   @return [Symbol, Straddle::Models::FundingEventListPaymentsParams::SortBy, nil]
+      optional :sort_by, enum: -> { Straddle::FundingEventListPaymentsParams::SortBy }
+
+      # @!attribute sort_order
+      #   Order in which to sort the results.
+      #
+      #   @return [Symbol, Straddle::Models::SortOrder, nil]
+      optional :sort_order, enum: -> { Straddle::SortOrder }
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!attribute straddle_account_id
+      #   For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @return [String, nil]
+      optional :straddle_account_id, String
+
+      # @!method initialize(id:, default_page_size: nil, default_sort: nil, default_sort_order: nil, include_metadata: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param default_page_size [Integer] Default number of results returned per page.
+      #
+      #   @param default_sort [Symbol, Straddle::Models::FundingEventListPaymentsParams::DefaultSort] Default field used to sort the results.
+      #
+      #   @param default_sort_order [Symbol, Straddle::Models::SortOrder] Default order in which to sort the results.
+      #
+      #   @param include_metadata [Boolean] When `true`, includes each payment's metadata. Defaults to `false`.
+      #
+      #   @param page_number [Integer] Results page number. Starts at 1. Defaults to 1.
+      #
+      #   @param page_size [Integer] Number of results per page. Maximum 1,000. Defaults to 100.
+      #
+      #   @param sort_by [Symbol, Straddle::Models::FundingEventListPaymentsParams::SortBy] Field used to sort the results.
+      #
+      #   @param sort_order [Symbol, Straddle::Models::SortOrder] Order in which to sort the results.
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+      module DefaultSort
+        extend Straddle::Internal::Type::Enum
+
+        CREATED_AT = :created_at
+        PAYMENT_DATE = :payment_date
+        EFFECTIVE_AT = :effective_at
+        ID = :id
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module SortBy
+        extend Straddle::Internal::Type::Enum
+
+        CREATED_AT = :created_at
+        PAYMENT_DATE = :payment_date
+        EFFECTIVE_AT = :effective_at
+        ID = :id
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/funding_event_payment.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class FundingEventPayment < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for this payment.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute currency
+      #   Three-letter ISO 4217 currency code.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute external_id
+      #   Your unique identifier for this payment, used to correlate with your internal
+      #   records.
+      #
+      #   @return [String]
+      required :external_id, String
+
+      # @!attribute funding_amount
+      #   Portion of the payment amount included in this funding event, in the smallest
+      #   currency unit.
+      #
+      #   @return [Integer]
+      required :funding_amount, Integer
+
+      # @!attribute payment_amount
+      #   Total payment amount in the smallest currency unit (e.g. 1000 = $10.00 USD).
+      #
+      #   @return [Integer]
+      required :payment_amount, Integer
+
+      # @!attribute payment_date
+      #   The date on which this payment was submitted for processing.
+      #
+      #   @return [Date]
+      required :payment_date, Date
+
+      # @!attribute payment_type
+      #   Whether this payment is a charge or payout.
+      #
+      #   @return [Symbol, Straddle::Models::PaymentType]
+      required :payment_type, enum: -> { Straddle::PaymentType }
+
+      # @!attribute reason
+      #   Reason this payment was included in the funding event.
+      #
+      #   @return [Symbol, Straddle::Models::FundingEventPaymentReason]
+      required :reason, enum: -> { Straddle::FundingEventPaymentReason }
+
+      # @!attribute status
+      #   Current status of this payment.
+      #
+      #   @return [Symbol, Straddle::Models::PaymentStatus]
+      required :status, enum: -> { Straddle::PaymentStatus }
+
+      # @!attribute trace_ids
+      #   Network-level trace identifiers assigned during processing. Keys vary by payment
+      #   rail.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :trace_ids, Straddle::Internal::Type::HashOf[String]
+
+      # @!attribute customer_details
+      #   Details of the customer associated with this payment.
+      #
+      #   @return [Straddle::Models::CustomerDetails, nil]
+      optional :customer_details, -> { Straddle::CustomerDetails }
+
+      # @!attribute metadata
+      #   Key-value metadata for this payment. Included only when `include_metadata` is
+      #   `true`.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute paykey_details
+      #   Details of the paykey used for this payment.
+      #
+      #   @return [Straddle::Models::PaykeyDetails, nil]
+      optional :paykey_details, -> { Straddle::PaykeyDetails }
+
+      # @!method initialize(id:, currency:, external_id:, funding_amount:, payment_amount:, payment_date:, payment_type:, reason:, status:, trace_ids:, customer_details: nil, metadata: nil, paykey_details: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::FundingEventPayment} for more details.
+      #
+      #   @param id [String] Unique identifier for this payment.
+      #
+      #   @param currency [String] Three-letter ISO 4217 currency code.
+      #
+      #   @param external_id [String] Your unique identifier for this payment, used to correlate with your internal re
+      #
+      #   @param funding_amount [Integer] Portion of the payment amount included in this funding event, in the smallest cu
+      #
+      #   @param payment_amount [Integer] Total payment amount in the smallest currency unit (e.g. 1000 = $10.00 USD).
+      #
+      #   @param payment_date [Date] The date on which this payment was submitted for processing.
+      #
+      #   @param payment_type [Symbol, Straddle::Models::PaymentType] Whether this payment is a charge or payout.
+      #
+      #   @param reason [Symbol, Straddle::Models::FundingEventPaymentReason] Reason this payment was included in the funding event.
+      #
+      #   @param status [Symbol, Straddle::Models::PaymentStatus] Current status of this payment.
+      #
+      #   @param trace_ids [Hash{Symbol=>String}] Network-level trace identifiers assigned during processing. Keys vary by payment
+      #
+      #   @param customer_details [Straddle::Models::CustomerDetails] Details of the customer associated with this payment.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Key-value metadata for this payment. Included only when `include_metadata` is `t
+      #
+      #   @param paykey_details [Straddle::Models::PaykeyDetails] Details of the paykey used for this payment.
+    end
+  end
+end

data/lib/straddle/models/funding_event_payment_list.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::FundingEvents#list_payments
+    class FundingEventPaymentList < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #   Funding-event payments returned for this page.
+      #
+      #   @return [Array<Straddle::Models::FundingEventPayment>]
+      required :data, -> { Straddle::Internal::Type::ArrayOf[Straddle::FundingEventPayment] }
+
+      # @!attribute meta
+      #   Metadata for an API request and a page of results.
+      #
+      #   @return [Straddle::Models::PageMetadata]
+      required :meta, -> { Straddle::PageMetadata }
+
+      # @!attribute response_type
+      #   Shape of the response envelope.
+      #
+      #   - `object` means `data` contains one JSON object.
+      #   - `array` means `data` contains an array of JSON objects.
+      #   - `error` means `error` contains the error details.
+      #   - `none` means the response contains no data.
+      #
+      #   @return [Symbol, Straddle::Models::ResponseType]
+      required :response_type, enum: -> { Straddle::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::FundingEventPaymentList} for more details.
+      #
+      #   @param data [Array<Straddle::Models::FundingEventPayment>] Funding-event payments returned for this page.
+      #
+      #   @param meta [Straddle::Models::PageMetadata] Metadata for an API request and a page of results.
+      #
+      #   @param response_type [Symbol, Straddle::Models::ResponseType] Shape of the response envelope.
+    end
+  end
+end

data/lib/straddle/models/funding_event_payment_reason.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # Reason the payment was included in the funding event.
+    module FundingEventPaymentReason
+      extend Straddle::Internal::Type::Enum
+
+      CREDIT = :credit
+      DEBIT = :debit
+      REVERSAL = :reversal
+      FAILED = :failed
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/funding_event_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::FundingEvents#retrieve
+    class FundingEventResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::FundingEvent]
+      required :data, -> { Straddle::FundingEvent }
+
+      # @!attribute meta
+      #   Metadata for an API request.
+      #
+      #   @return [Straddle::Models::ResponseMetadata]
+      required :meta, -> { Straddle::ResponseMetadata }
+
+      # @!attribute response_type
+      #   Shape of the response envelope.
+      #
+      #   - `object` means `data` contains one JSON object.
+      #   - `array` means `data` contains an array of JSON objects.
+      #   - `error` means `error` contains the error details.
+      #   - `none` means the response contains no data.
+      #
+      #   @return [Symbol, Straddle::Models::ResponseType]
+      required :response_type, enum: -> { Straddle::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::FundingEventResponse} for more details.
+      #
+      #   @param data [Straddle::Models::FundingEvent]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata for an API request.
+      #
+      #   @param response_type [Symbol, Straddle::Models::ResponseType] Shape of the response envelope.
+    end
+  end
+end

data/lib/straddle/models/funding_event_retrieve_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::FundingEvents#retrieve
+    class FundingEventRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!attribute straddle_account_id
+      #   For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @return [String, nil]
+      optional :straddle_account_id, String
+
+      # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/straddle/models/funding_event_simulate_params.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::FundingEvents#simulate
+    class FundingEventSimulateParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute funding_event_job_type
+      #   Required. Selects charge or payout activity for the simulated funding event.
+      #
+      #   @return [Symbol, Straddle::Models::FundingEventSimulateParams::FundingEventJobType]
+      required :funding_event_job_type, enum: -> { Straddle::FundingEventSimulateParams::FundingEventJobType }
+
+      # @!attribute sandbox_outcome
+      #   Optional. Sets the processing outcome for the simulated funding event. Defaults
+      #   to `standard`.
+      #
+      #   @return [Symbol, Straddle::Models::SimulatedPaymentOutcome, nil]
+      optional :sandbox_outcome, enum: -> { Straddle::SimulatedPaymentOutcome }
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute idempotency_key
+      #   Optional client-generated key for an idempotent request.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!attribute straddle_account_id
+      #   For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @return [String, nil]
+      optional :straddle_account_id, String
+
+      # @!method initialize(funding_event_job_type:, sandbox_outcome: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::FundingEventSimulateParams} for more details.
+      #
+      #   @param funding_event_job_type [Symbol, Straddle::Models::FundingEventSimulateParams::FundingEventJobType] Required. Selects charge or payout activity for the simulated funding event.
+      #
+      #   @param sandbox_outcome [Symbol, Straddle::Models::SimulatedPaymentOutcome] Optional. Sets the processing outcome for the simulated funding event. Defaults
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+      # Required. Selects charge or payout activity for the simulated funding event.
+      module FundingEventJobType
+        extend Straddle::Internal::Type::Enum
+
+        CHARGES = :charges
+        PAYOUTS = :payouts
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/funding_event_simulation.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::FundingEvents#simulate
+    class FundingEventSimulation < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::FundingEventSimulationResult]
+      required :data, -> { Straddle::FundingEventSimulationResult }
+
+      # @!attribute meta
+      #   Metadata for an API request.
+      #
+      #   @return [Straddle::Models::ResponseMetadata]
+      required :meta, -> { Straddle::ResponseMetadata }
+
+      # @!attribute response_type
+      #   Shape of the response envelope.
+      #
+      #   - `object` means `data` contains one JSON object.
+      #   - `array` means `data` contains an array of JSON objects.
+      #   - `error` means `error` contains the error details.
+      #   - `none` means the response contains no data.
+      #
+      #   @return [Symbol, Straddle::Models::ResponseType]
+      required :response_type, enum: -> { Straddle::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::FundingEventSimulation} for more details.
+      #
+      #   @param data [Straddle::Models::FundingEventSimulationResult]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata for an API request.
+      #
+      #   @param response_type [Symbol, Straddle::Models::ResponseType] Shape of the response envelope.
+    end
+  end
+end

data/lib/straddle/models/funding_event_simulation_result.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class FundingEventSimulationResult < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the created funding event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:)
+      #   @param id [String] Unique identifier for the created funding event.
+    end
+  end
+end

data/lib/straddle/models/funding_event_summary.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class FundingEventSummary < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for this funding event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   Total funding event amount in the smallest currency unit. For example, `1000` is
+      #   $10.00 USD.
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute created_at
+      #   Timestamp when this funding event was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute direction
+      #   Transfer direction relative to the linked bank account. `deposit` moves funds
+      #   into the account, and `withdrawal` moves funds out.
+      #
+      #   @return [Symbol, Straddle::Models::TransferDirection]
+      required :direction, enum: -> { Straddle::TransferDirection }
+
+      # @!attribute event_type
+      #   Reason for the funding event. `charge_deposit` settles collected charges to the
+      #   linked bank account. `charge_reversal` withdraws funds for reversed charges.
+      #   `payout_withdrawal` withdraws funds for payouts. `payout_return` deposits
+      #   returned payout funds.
+      #
+      #   @return [Symbol, Straddle::Models::FundingEventType]
+      required :event_type, enum: -> { Straddle::FundingEventType }
+
+      # @!attribute payment_count
+      #   Number of payments included in this funding event.
+      #
+      #   @return [Integer]
+      required :payment_count, Integer
+
+      # @!attribute trace_ids
+      #   Network-level trace identifiers assigned during processing. Keys vary by payment
+      #   rail.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :trace_ids, Straddle::Internal::Type::HashOf[String]
+
+      # @!attribute trace_numbers
+      #   Network trace numbers associated with payments in this funding event.
+      #
+      #   @return [Array<String>]
+      required :trace_numbers, Straddle::Internal::Type::ArrayOf[String]
+
+      # @!attribute transfer_date
+      #   The date the funds transfer was initiated.
+      #
+      #   @return [Date]
+      required :transfer_date, Date
+
+      # @!attribute updated_at
+      #   Timestamp when this funding event was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute status
+      #   Current status of this funding event.
+      #
+      #   @return [Symbol, Straddle::Models::PaymentStatus, nil]
+      optional :status, enum: -> { Straddle::PaymentStatus }
+
+      # @!attribute status_details
+      #   Reason, source, and message for the most recent status change.
+      #
+      #   @return [Straddle::Models::PaymentStatusDetails, nil]
+      optional :status_details, -> { Straddle::PaymentStatusDetails }
+
+      # @!attribute trace_number
+      #   The trace number of the funding event.
+      #
+      #   @return [String, nil]
+      optional :trace_number, String, nil?: true
+
+      # @!method initialize(id:, amount:, created_at:, direction:, event_type:, payment_count:, trace_ids:, trace_numbers:, transfer_date:, updated_at:, status: nil, status_details: nil, trace_number: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::FundingEventSummary} for more details.
+      #
+      #   @param id [String] Unique identifier for this funding event.
+      #
+      #   @param amount [Integer] Total funding event amount in the smallest currency unit. For example, `1000` is
+      #
+      #   @param created_at [Time] Timestamp when this funding event was created.
+      #
+      #   @param direction [Symbol, Straddle::Models::TransferDirection] Transfer direction relative to the linked bank account. `deposit` moves funds in
+      #
+      #   @param event_type [Symbol, Straddle::Models::FundingEventType] Reason for the funding event. `charge_deposit` settles collected charges to the
+      #
+      #   @param payment_count [Integer] Number of payments included in this funding event.
+      #
+      #   @param trace_ids [Hash{Symbol=>String}] Network-level trace identifiers assigned during processing. Keys vary by payment
+      #
+      #   @param trace_numbers [Array<String>] Network trace numbers associated with payments in this funding event.
+      #
+      #   @param transfer_date [Date] The date the funds transfer was initiated.
+      #
+      #   @param updated_at [Time] Timestamp when this funding event was last updated.
+      #
+      #   @param status [Symbol, Straddle::Models::PaymentStatus] Current status of this funding event.
+      #
+      #   @param status_details [Straddle::Models::PaymentStatusDetails] Reason, source, and message for the most recent status change.
+      #
+      #   @param trace_number [String, nil] The trace number of the funding event.
+    end
+  end
+end