Package com.stripe.model.capital

Class FinancingOffer

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.capital.FinancingOffer
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class FinancingOffer extends ApiResource implements HasId
This is an object representing an offer of financing from Stripe Capital to a Connect subaccount.

  • Constructor Details

    • FinancingOffer

      public FinancingOffer()

  • Method Details

    • list

      public static FinancingOfferCollection list(Map<String,Object> params) throws StripeException
      Retrieves the financing offers available for Connected accounts that belong to your platform.
      Throws:
      StripeException

    • list

      public static FinancingOfferCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the financing offers available for Connected accounts that belong to your platform.
      Throws:
      StripeException

    • list

      public static FinancingOfferCollection list(FinancingOfferListParams params) throws StripeException
      Retrieves the financing offers available for Connected accounts that belong to your platform.
      Throws:
      StripeException

    • list

      public static FinancingOfferCollection list(FinancingOfferListParams params, RequestOptions options) throws StripeException
      Retrieves the financing offers available for Connected accounts that belong to your platform.
      Throws:
      StripeException

    • markDelivered

      public FinancingOffer markDelivered() throws StripeException
      Acknowledges that platform has received and delivered the financing_offer to the intended merchant recipient.
      Throws:
      StripeException

    • markDelivered

      public FinancingOffer markDelivered(RequestOptions options) throws StripeException
      Acknowledges that platform has received and delivered the financing_offer to the intended merchant recipient.
      Throws:
      StripeException

    • markDelivered

      public FinancingOffer markDelivered(Map<String,Object> params) throws StripeException
      Acknowledges that platform has received and delivered the financing_offer to the intended merchant recipient.
      Throws:
      StripeException

    • markDelivered

      public FinancingOffer markDelivered(Map<String,Object> params, RequestOptions options) throws StripeException
      Acknowledges that platform has received and delivered the financing_offer to the intended merchant recipient.
      Throws:
      StripeException

    • markDelivered

      public FinancingOffer markDelivered(FinancingOfferMarkDeliveredParams params) throws StripeException
      Acknowledges that platform has received and delivered the financing_offer to the intended merchant recipient.
      Throws:
      StripeException

    • markDelivered

      public FinancingOffer markDelivered(FinancingOfferMarkDeliveredParams params, RequestOptions options) throws StripeException
      Acknowledges that platform has received and delivered the financing_offer to the intended merchant recipient.
      Throws:
      StripeException

    • retrieve

      public static FinancingOffer retrieve(String financingOffer) throws StripeException
      Get the details of the financing offer.
      Throws:
      StripeException

    • retrieve

      public static FinancingOffer retrieve(String financingOffer, RequestOptions options) throws StripeException
      Get the details of the financing offer.
      Throws:
      StripeException

    • retrieve

      public static FinancingOffer retrieve(String financingOffer, Map<String,Object> params, RequestOptions options) throws StripeException
      Get the details of the financing offer.
      Throws:
      StripeException

    • retrieve

      public static FinancingOffer retrieve(String financingOffer, FinancingOfferRetrieveParams params, RequestOptions options) throws StripeException
      Get the details of the financing offer.
      Throws:
      StripeException

    • getTestHelpers

      public FinancingOffer.TestHelpers getTestHelpers()

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAcceptedTerms

      public FinancingOffer.AcceptedTerms getAcceptedTerms()
      This is an object representing the terms of an offer of financing from Stripe Capital to a Connected account. This resource represents the terms accepted by the Connected account, which may differ from those offered.

    • getAccount

      public String getAccount()
      The ID of the merchant associated with this financing object.

    • getChargedOffAt

      public Long getChargedOffAt()
      The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.

    • getCreated

      public Long getCreated()
      Time at which the offer was created. Given in seconds since unix epoch.

    • getExpiresAfter

      public BigDecimal getExpiresAfter()
      Time at which the offer expires. Given in seconds since unix epoch.

    • getFinancingType

      public String getFinancingType()
      The type of financing being offered.

      One of cash_advance, or flex_loan.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • getObject

      public String getObject()
      The object type: financing_offer.

      Equal to capital.financing_offer.

    • getOfferedTerms

      public FinancingOffer.OfferedTerms getOfferedTerms()
      This is an object representing the terms of an offer of financing from Stripe Capital to a Connected account. This resource represents both the terms offered to the Connected account.

    • getProductType

      public String getProductType()
      Financing product identifier.

      One of refill, or standard.

    • getReplacement

      public String getReplacement()
      The ID of the financing offer that replaced this offer.

    • getReplacementFor

      public String getReplacementFor()
      The ID of the financing offer that this offer is a replacement for.

    • getStatus

      public String getStatus()
      The current status of the offer.

      One of accepted, canceled, completed, delivered, expired, fully_repaid, paid_out, rejected, replaced, or undelivered.

    • getType

      public String getType()
      See financing_type.

      One of cash_advance, fixed_term_loan, or flex_loan.

    • setAcceptedTerms

      public void setAcceptedTerms(FinancingOffer.AcceptedTerms acceptedTerms)
      This is an object representing the terms of an offer of financing from Stripe Capital to a Connected account. This resource represents the terms accepted by the Connected account, which may differ from those offered.

    • setAccount

      public void setAccount(String account)
      The ID of the merchant associated with this financing object.

    • setChargedOffAt

      public void setChargedOffAt(Long chargedOffAt)
      The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.

    • setCreated

      public void setCreated(Long created)
      Time at which the offer was created. Given in seconds since unix epoch.

    • setExpiresAfter

      public void setExpiresAfter(BigDecimal expiresAfter)
      Time at which the offer expires. Given in seconds since unix epoch.

    • setFinancingType

      public void setFinancingType(String financingType)
      The type of financing being offered.

      One of cash_advance, or flex_loan.

    • setId

      public void setId(String id)
      A unique identifier for the financing object.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setMetadata

      public void setMetadata(Map<String,String> metadata)
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • setObject

      public void setObject(String object)
      The object type: financing_offer.

      Equal to capital.financing_offer.

    • setOfferedTerms

      public void setOfferedTerms(FinancingOffer.OfferedTerms offeredTerms)
      This is an object representing the terms of an offer of financing from Stripe Capital to a Connected account. This resource represents both the terms offered to the Connected account.

    • setProductType

      public void setProductType(String productType)
      Financing product identifier.

      One of refill, or standard.

    • setReplacement

      public void setReplacement(String replacement)
      The ID of the financing offer that replaced this offer.

    • setReplacementFor

      public void setReplacementFor(String replacementFor)
      The ID of the financing offer that this offer is a replacement for.

    • setStatus

      public void setStatus(String status)
      The current status of the offer.

      One of accepted, canceled, completed, delivered, expired, fully_repaid, paid_out, rejected, replaced, or undelivered.

    • setType

      public void setType(String type)
      See financing_type.

      One of cash_advance, fixed_term_loan, or flex_loan.

    • 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

    • getId

      public String getId()
      A unique identifier for the financing object.
      Specified by:
      getId in interface HasId