Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

The Financing offer object Preview

Attributes

  • idstring

    A unique identifier for the financing object.

  • objectstring

    The object type: financing_offer.

  • accepted_termsnullable object

    Information about the current financing object. Describes currency, advance amount, fee amount, withhold rate, and fee discount of previous financing.

  • accountstring

    The ID of the merchant associated with this financing object.

  • charged_off_atnullable timestamp

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

  • createdinteger

    Time at which the offer was created. Given in seconds since unix epoch.

  • expires_afterfloat

    Time at which the offer expires. Given in seconds since unix epoch.

  • financing_typenullable enum

    The type of financing being offered.

    Possible enum values
    cash_advance

    Capital’s Merchant Cash Advance program.

    fixed_term_loan

    Capital’s fixed-term loan offering. See the integration guide for more information.

    flex_loan

    Capital’s flex loan offering. See the integration guide for more information.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • metadatanullable object

    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.

  • offered_termsnullable object

    Information about the financing offer. Describes currency, offered advance amount, offered fee amount, campaign type, withhold rate, and fee discount rate of previous financing.

  • product_typenullable enum

    Financing product identifier.

    Possible enum values
    refill

    A “refill” financing offer extended through Stripe Capital. Refills are a form of discounted refinancing. See the integration guide for more information.

    standard

    A standard financing offer extended through Stripe Capital.

  • replacementnullable string

    The ID of the financing offer that replaced this offer.

  • replacement_fornullable string

    The ID of the financing offer that this offer is a replacement for.

  • statusenum

    The current status of the offer.

    Possible enum values
    accepted

    Set once an offer has been accepted by the Connected account.

    canceled

    Set when the Connected account has reached out to Capital’s servicing team within 48 hours of acceptance and requested cancellation of their offer.

    completed

    Set when the financing offer has fully repaid. This status is no longer in use. See fully_repaid instead.

    delivered

    Once an offer has been delivered, mark it so using the mark_delivered endpoint.

    expired

    Set when the financing offer has expired, usually 30 days after creation.

    fully_repaid

    Set when the financing offer has been fully repaid.

    paid_out

    Set once an offer has been paid out to the Connected account.

    rejected

    Set when Capital’s servicing team has rejected the application for financing. The Connected account receives an email with the reason for rejection.

    replaced

    Set when the financing offer has been replaced.

    undelivered

    All offers begin in this state. A financing offer must be delivered to its Connected account using approved marketing materials.

  • status_transitionsobjectPreview feature

    Hash containing timestamps of when the offer transitioned to a particular status.

  • typenullable enumDeprecated

    See financing_type.

    Possible enum values
    cash_advance
    fixed_term_loan
    flex_loan
The Financing offer object
{
  "id": "financingoffer_1NPvKg2eZvKYlo2CnEEmlCVh",
  "object": "capital.financing_offer",
  "account": "acct_1NPvKgBY65lDjjDk",
  "created": 1688423699,
  "expires_after": 1690934400,
  "financing_type": "flex_loan",
  "livemode": true,
  "offered_terms": {
    "advance_amount": 10000,
    "campaign_type": "newly_eligible_user",
    "currency": "usd",
    "fee_amount": 1000,
    "previous_financing_fee_discount_rate": null,
    "withhold_rate": 0.05
  },
  "product_type": "standard",
  "status": "undelivered"
}

Retrieve a given financing offer 

Get the details of the financing offer

Parameters

No parameters.

Returns

Returns the financing offer object

GET /v1/capital/financing_offers/:id
curl https://api.stripe.com/v1/capital/financing_offers/financingoffer_1NPvKg2eZvKYlo2CnEEmlCVh \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "financingoffer_1NPvKg2eZvKYlo2CnEEmlCVh",
  "object": "capital.financing_offer",
  "account": "acct_1NPvKgBY65lDjjDk",
  "created": 1688423699,
  "expires_after": 1690934400,
  "financing_type": "flex_loan",
  "livemode": true,
  "offered_terms": {
    "advance_amount": 10000,
    "campaign_type": "newly_eligible_user",
    "currency": "usd",
    "fee_amount": 1000,
    "previous_financing_fee_discount_rate": null,
    "withhold_rate": 0.05
  },
  "product_type": "standard",
  "status": "undelivered"
}

List financing offers 

Retrieves the financing offers available for Connected accounts that belong to your platform.

Parameters

  • connected_accountstring

    limit list to offers belonging to given connected account

  • createdobject

    Only return offers that were created during the given date interval.

  • statusstring

    limit list to offers with given status

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

Returns a list of financing offers for Connected accounts on your platform.

GET /v1/capital/financing_offers
curl -G https://api.stripe.com/v1/capital/financing_offers \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3
Response
{
  "object": "list",
  "url": "/v1/capital/financing_offers",
  "has_more": false,
  "data": [
    {
      "id": "financingoffer_1Nn7FV2eZvKYlo2CcGGcdZ6L",
      "object": "capital.financing_offer",
      "account": "acct_1Nn7FVGy17qyuPVN",
      "created": 1693951049,
      "expires_after": 1696464000,
      "financing_type": "flex_loan",
      "livemode": true,
      "offered_terms": {
        "advance_amount": 10000,
        "campaign_type": "newly_eligible_user",
        "currency": "usd",
        "fee_amount": 1000,
        "previous_financing_fee_discount_rate": null,
        "withhold_rate": 0.05
      },
      "product_type": "standard",
      "status": "undelivered"
    }
  ]
}

Mark that a financing offer has been delivered 

Acknowledges that platform has received and delivered the financing_offer to the intended merchant recipient.

Parameters

No parameters.

Returns

Returns the financing offer object

POST /v1/capital/financing_offers/:id/mark_delivered
curl -X POST https://api.stripe.com/v1/capital/financing_offers/financingoffer_1NPvKg2eZvKYlo2CnEEmlCVh/mark_delivered \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "financingoffer_1NPvKg2eZvKYlo2CnEEmlCVh",
  "object": "capital.financing_offer",
  "account": "acct_1NPvKgBY65lDjjDk",
  "created": 1688423699,
  "expires_after": 1690934400,
  "financing_type": "flex_loan",
  "livemode": true,
  "offered_terms": {
    "advance_amount": 10000,
    "campaign_type": "newly_eligible_user",
    "currency": "usd",
    "fee_amount": 1000,
    "previous_financing_fee_discount_rate": null,
    "withhold_rate": 0.05
  },
  "product_type": "standard",
  "status": "delivered"
}

Financing Summary Preview

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.

Endpoints