mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-05 00:02:50 -04:00
79 lines
3.9 KiB
Ruby
79 lines
3.9 KiB
Ruby
# File generated from our OpenAPI spec
|
|
# frozen_string_literal: true
|
|
|
|
# typed: true
|
|
module Stripe
|
|
module Capital
|
|
# A financing object describes an account's current financing state. Used by Connect
|
|
# platforms to read the state of Capital offered to their connected accounts.
|
|
class FinancingSummary < SingletonAPIResource
|
|
class Details < Stripe::StripeObject
|
|
class CurrentRepaymentInterval < Stripe::StripeObject
|
|
# The time at which the minimum payment amount will be due. If not met through withholding, the Connected account's linked bank account or account balance will be debited.
|
|
# Given in seconds since unix epoch.
|
|
sig { returns(Float) }
|
|
def due_at; end
|
|
# The amount that has already been paid in the current repayment interval, in minor units. For example, $100 USD will be represented as 10000.
|
|
sig { returns(T.nilable(Integer)) }
|
|
def paid_amount; end
|
|
# The amount that is yet to be paid in the current repayment interval, in minor units. For example, $100 USD will be represented as 10000.
|
|
sig { returns(Integer) }
|
|
def remaining_amount; end
|
|
def self.inner_class_types
|
|
@inner_class_types = {}
|
|
end
|
|
def self.field_remappings
|
|
@field_remappings = {}
|
|
end
|
|
end
|
|
# Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
|
|
sig { returns(Integer) }
|
|
def advance_amount; end
|
|
# The time at which the funds were paid out to the connected account's Stripe balance. Given in milliseconds since unix epoch.
|
|
sig { returns(T.nilable(Float)) }
|
|
def advance_paid_out_at; end
|
|
# Currency that the financing offer is transacted in. For example, `usd`.
|
|
sig { returns(String) }
|
|
def currency; end
|
|
# The chronologically current repayment interval for the financing offer.
|
|
sig { returns(T.nilable(CurrentRepaymentInterval)) }
|
|
def current_repayment_interval; end
|
|
# Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
|
|
sig { returns(Integer) }
|
|
def fee_amount; end
|
|
# The amount the Connected account has paid toward the financing debt so far, in minor units. For example, $1,000 USD will be represented as 100000.
|
|
sig { returns(Integer) }
|
|
def paid_amount; end
|
|
# The balance remaining to be paid on the financing, in minor units. For example, $1,000 USD will be represented as 100000.
|
|
sig { returns(Integer) }
|
|
def remaining_amount; end
|
|
# The time at which Capital will begin withholding from payments. Given in seconds since unix epoch.
|
|
sig { returns(T.nilable(Float)) }
|
|
def repayments_begin_at; end
|
|
# Per-transaction rate at which Stripe will withhold funds to repay the financing.
|
|
sig { returns(Float) }
|
|
def withhold_rate; end
|
|
def self.inner_class_types
|
|
@inner_class_types = {current_repayment_interval: CurrentRepaymentInterval}
|
|
end
|
|
def self.field_remappings
|
|
@field_remappings = {}
|
|
end
|
|
end
|
|
# Additional information about the financing summary. Describes currency, advance amount,
|
|
# fee amount, withhold rate, remaining amount, paid amount, current repayment interval,
|
|
# repayment start date, and advance payout date.
|
|
sig { returns(T.nilable(Details)) }
|
|
def details; end
|
|
# The Financing Offer ID this Financing Summary corresponds to
|
|
sig { returns(T.nilable(String)) }
|
|
def financing_offer; end
|
|
# The object type: financing_summary
|
|
sig { returns(String) }
|
|
def object; end
|
|
# Status of the Connected Account's financing. [/v1/capital/financing_summary](https://stripe.com/docs/api/capital/financing_summary) will only return `details` for `paid_out` financing.
|
|
sig { returns(T.nilable(String)) }
|
|
def status; end
|
|
end
|
|
end
|
|
end |