Build a custom Capital programPrivate preview

All users who receive Capital offers see your business name, icon, logo, and branding color in the offer emails, application, and financing reporting page.

Navigate to your Connect branding settings, and make sure your platform’s branding settings are correct.

We recommend using a sandbox to build your integration. In a sandbox, visit the Capital Dashboard.

1. Click Create to open the Create financing offer modal, which allows you to create test financing offers. The default options create an undelivered financing offer with a 1,000 USD financing amount.
2. Leave the default options, and click Create financing offer.
3. From the Dashboard, click the row corresponding to the offer you created.

The loans and financing section of the connected account details page displays details about the user’s financing offer.

You can retrieve financing offers for all of your platform’s users with the List financing offers endpoint.

curl https://api.stripe.com/v1/capital/financing_offers \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:

If the offer is successfully created, you receive a response similar to the following:

{
  "object": "list",
  "url": "/v1/capital/financing_offers",
  "has_more": false,
  "data": [
    {
      "id": "financingoffer_abc123",
      "object": "capital.financing_offer",
      ...,
    },
    {...}
  ]
}

You can look up a financing offer using the Retrieve financing offer endpoint. Retrieve the first financing offer from the list above.

curl https://api.stripe.com/v1/capital/financing_offers/financingoffer_abc123 \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:

Stripe sends the capital.financing_offer.created webhook after a financing offer is created. Update your webhook integration to listen for the capital.financing_offer.created webhook. If you send your own offer emails, the webhook is an important notification to notify the user of their offer.

In the email, link users to a dedicated Capital section in your platform dashboard. Users access the Capital financing application with Account Links. Account Links expire shortly after they’re generated, so provide a way for users to regenerate the application link. Include a link to the financing application in your platform dashboard by generating an Account Link of type capital_financing_offer.

curl https://api.stripe.com/v1/account_links \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d account=acct_123 \
  # The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid.
  -d refresh_url="https://example.com/reauth" \
  # The URL the user will be redirected to after completing the linked flow.
  -d return_url="https://example.com/thanks" \
  -d type=capital_financing_offer

If the creation of an account link is successful, you receive a response similar to the following:

{
  "object": "account_link",
  "created": 1611264596,
  "expires_at": 1611264896,
  "url": "https://connect.stripe.com/capital/offer/SrjgLUfa0O7K"
}

After updating your webhook integration, create another offer in the Dashboard, and verify you receive the capital.financing_offer.created webhook.

Mark the offer as delivered

Update your webhook integration to mark the financing offer as delivered after sending the offer email. Marking an offer as delivered is required and is an affirmation that you have marketed the offer to the user.

curl https://api.stripe.com/v1/capital/financing_offers/financingoffer_abc123/mark_delivered \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:

Verify the status of the financing offer is delivered using the Dashboard or the financing offer API.

In addition to the capital.financing_offer.created webhook, Stripe sends additional webhooks as the financing offer transitions through different states. The following is a full list of the webhooks you can receive:

From the Dashboard, find the offer you delivered earlier.

1. Click the overflow menu ().
2. Click the Expire offer option, which lets you simulate expiring the offer.
3. Verify you receive the capital.financing_offer.expired webhook.

With the exception of capital.financing_offer.canceled, you can simulate all webhooks while in a testing environment.

You can simulate the capital.financing_offer.accepted webhook by applying for an offer.

1. From the Dashboard, create a delivered offer with a maximum financing amount of 20,000 USD.
2. Generate an account link of type capital_financing_offer, and navigate to the link. Here, you can preview what the application looks like for your users.
3. Continue to the end of the application, and click Submit.
4. Verify you received the capital.financing_offer.accepted webhook.
5. View the offer in the Dashboard, and check it has status accepted.

View the application tracker

A financing offer with status accepted is pending application review by the Stripe servicing team. While this review takes place, you can direct the user to the financing reporting page. The financing reporting page contains an application tracker with an approximate timeline of the application review.

Generate an Account Link of type capital_financing_reporting.

curl https://api.stripe.com/v1/account_links \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d account=acct_123 \
  # When the user refreshes the page, where should we redirect them
  -d refresh_url="https://example.com/reauth" \
  # When the user completes the application, where should they return
  -d return_url="https://example.com/thanks" \
  -d type=capital_financing_reporting

Navigate to the link, and view the application tracker.

In the Dashboard, find the row corresponding to the accepted offer.

1. Click the overflow menu ().
2. Click the Approve and disburse funds option, which lets you simulate an application approval and funds disbursal.
3. Verify you receive the capital.financing_offer.paid_out webhook, which notifies you that the financing has been paid out.
4. Generate another Account Link of type capital_financing_reporting. This reporting page provides access to outstanding balance and payout and payment transaction details for the user’s in-progress financing.
5. Click Make payment, and create a manual payment.

After the transaction is processed, view the payment in the transactions table. You can programmatically view the user’s paid-down financing amount for in-progress financing using the financing summary API.

curl https://api.stripe.com/v1/capital/financing_summary \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}" \

If the retrieval of the financing summary is successful, you receive a response similar to the following:

{
  "object": "capital.financing_summary",
  "details": {
    "currency": "usd",
    "advance_amount": 1000000,
    "fee_amount": 100000,
    "withhold_rate": 0.2,
    "remaining_amount": 999950,
    "paid_amount": 50,
    "current_repayment_interval": {
      "due_at": 123456789,
      "remaining_amount": 50,
      "paid_amount": 50
    },
    "repayments_begin_at": 123456789,
    "advance_paid_out_at": 123456789
  }
}

In the Dashboard, find the row corresponding to the paid-out financing.

1. Click the overflow menu ().
2. Click the Repay offer option, which lets you simulate fully paying down the financing balance.
3. Verify you receive the capital.financing_offer.fully_repaid webhook, which notifies you that the financing has been fully paid.
4. Generate another Account Link of type capital_financing_reporting.

After a user pays the total amount of their financing, they can access past financing details on the reporting page at any time.

By now, your integration:

• Responds to the capital.financing_offer.created webhook by sending an offer email and marking the offer as delivered
• Exposes the financing application link in your platform dashboard
• Exposes the financing reporting link in your platform dashboard

The Capital section of your platform dashboard might appear differently depending on which phase the user’s financing is in. Review the state diagram below for a list of possible financing offer status values.

When automatic offers are enabled in live mode, Stripe automatically creates financing offers for your users on a daily basis. Before enabling automatic offers, make sure that you:

1. Confirm and update email addresses for your users through the Comms Center if you’re planning to leverage Stripe co-branded no-code offer emails. To be eligible for Capital financing, users must have an email saved with Stripe so that they can receive transactional emails such as payment progress updates.
2. Contact us to enable live mode access to the financing offers API.

Enable additional features

Over time, some of your users might become eligible for refills. Refills are additional financing offers sent to users who have made substantial payment progress towards their in-progress loans. Follow the refills integration guide to update your integration to support refill financing offers.

If you want to include Capital transactions on your platform dashboard and update your users payout reporting, refer to the reporting and reconciliation guide.