> For the complete documentation index, see [llms.txt](https://docs.welkinhealth.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.welkinhealth.com/integrations/payments-stripe/stripe-setup-and-configuration.md).

# Stripe Setup and Configuration

Welkin Health provides your organization the ability to collect payments directly through the Care user interface using Stripe. Setup involves steps completed by both the customer and the Welkin team.

## Setup overview

| Deliverable / Step                                    | Responsible party |
| ----------------------------------------------------- | ----------------- |
| Contracting                                           | Both              |
| Enable integration                                    | Welkin            |
| Create CDT/Data View for pre-visit cost               | Welkin            |
| Create CDTs/Assessment for Claims                     | Welkin            |
| Create/modify Encounter templates for billable events | Customer          |
| Assign pre-visit cost Data View to layout             | Customer          |
| Enable and permission API/Webhook                     | Customer          |
| Testing                                               | Both              |

## Step 1: Contracting

Complete the contracting process with the Welkin Sales or CSM team.

## Step 2: Enable integration

Welkin's CSM and integration team will enable the integration internally for your environment.

## Step 3: Create CDT for pre-visit cost *(optional)*

Welkin will create a CDT called `cdt-personal-fee` with CDTF `cdtf-fee`, and a Data View `uicte-pre-visit-cost` for use in Encounter templates. This is only needed if you want to save a personal fee in a CDT and pre-populate it for encounters.

## Step 4: Create CDTs/Assessment for Claims *(optional)*

If using the Candid Health integration, Welkin will create a set of CDTs and CDTFs used in an Assessment called **Billing Form**. This form will be added to Encounter templates for billable events.

## Step 5: Create Encounter templates for billable events

In Designer, configure each Encounter template for billing:

1. Open **Encounter Templates** and select the encounter type to enable for billing
2. Scroll to the **Billing** section
3. Assign a **Service Cost** for this encounter type
4. Assign a **Pre-visit cost** using the `cdt-personal-fee` and `cdtf-fee` values

## Step 6: Assign pre-visit Data View to layout *(optional)*

Map the data view `uicte-pre-visit-cost` to the appropriate navigation layout using the standard Layout process.

## Step 7: Enable and permission API/Webhook

This step is completed by the customer in Stripe and Welkin Admin.

**In Stripe:**

1. Log in to Stripe and navigate to **Developers** (upper right)
2. Click the **API Keys** tab → **Create secret key** → name and copy the key
3. Click the **Webhooks** tab → **Add endpoint**
4. Enter the webhook endpoint URL in this format:

   ```
   https://api.live.welkincloud.io/[organization-name]/[environment-name]/payment/webhooks
   ```
5. Set the **Version** dropdown to **Latest API version**
6. Permission the webhook for all event types: click **Select events** → **Select all events** → **Add events** → **Add endpoint**
7. Click into the new webhook and copy the **Signing Secret** (click **Reveal**)

**In Welkin Admin:**

1. Navigate to **Integrations → Stripe**
2. Save the API key and Webhook Signing Secret under the environment you are connecting

## Step 8: Testing

Coordinate testing with your Integration or CSM Manager to verify your workflows are working as expected.

***

*Note: Your configuration may differ based on how you assign costs to encounter types, how you store patient pre-visit costs, and whether you are also using Candid Health. Your Implementation or CSM Manager will provide additional guidance for your specific setup.*

More Questions? Contact <csm@welkinhealth.com> or your Implementation/CSM directly.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.welkinhealth.com/integrations/payments-stripe/stripe-setup-and-configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.