Class FinancingSummary

All Implemented Interfaces:
StripeObjectInterface

public class FinancingSummary extends ApiResource
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.
  • Constructor Details

    • FinancingSummary

      public FinancingSummary()
  • Method Details

    • retrieve

      public static FinancingSummary retrieve() throws StripeException
      Retrieve the financing state for the account that was authenticated in the request.
      Throws:
      StripeException
    • retrieve

      public static FinancingSummary retrieve(RequestOptions options) throws StripeException
      Retrieve the financing state for the account that was authenticated in the request.
      Throws:
      StripeException
    • retrieve

      public static FinancingSummary retrieve(Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieve the financing state for the account that was authenticated in the request.
      Throws:
      StripeException
    • retrieve

      public static FinancingSummary retrieve(FinancingSummaryRetrieveParams params, RequestOptions options) throws StripeException
      Retrieve the financing state for the account that was authenticated in the request.
      Throws:
      StripeException
    • getDetails

      public FinancingSummary.Details getDetails()
      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.
    • getFinancingOffer

      public String getFinancingOffer()
      The Financing Offer ID this Financing Summary corresponds to.
    • getObject

      public String getObject()
      The object type: financing_summary

      Equal to capital.financing_summary.

    • getStatus

      public String getStatus()
      Status of the Connected Account's financing. /v1/capital/financing_summary will only return details for paid_out financing.

      One of accepted, delivered, or none.

    • setDetails

      public void setDetails(FinancingSummary.Details details)
      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.
    • setFinancingOffer

      public void setFinancingOffer(String financingOffer)
      The Financing Offer ID this Financing Summary corresponds to.
    • setObject

      public void setObject(String object)
      The object type: financing_summary

      Equal to capital.financing_summary.

    • setStatus

      public void setStatus(String status)
      Status of the Connected Account's financing. /v1/capital/financing_summary will only return details for paid_out financing.

      One of accepted, delivered, or none.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • canEqual

      protected boolean canEqual(Object other)
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object