Stripe Integration with Orkes Conductor
Available since
- v5.3.0 and later
Connected Apps must be enabled on your cluster
Connected Apps are enabled per cluster. If Integrations > Connected Apps is not in the left navigation, contact Orkes support to enable it before following these steps.
Integrating Stripe with Orkes Conductor lets you build workflows that interact with your Stripe using the following operations:
- Get Balance
- List Customers
- Create Customer
- Get Customer
- Update Customer
- Delete Customer
- Create Coupon
- List Coupons
- Create Payment Intent
- Get Payment Intent
- Cancel Payment Intent
- List Charges
- Create Charge
- Update Charge
- Get Charge
- Create Refund
- Get Refund
- Attach Payment Method
- Get Payment Method
- Detach Payment Method
- Create Meter Event
This guide explains how to set up and use the integration. Here's an overview:
- Get the required credentials from Stripe.
- Configure a new Stripe integration in Orkes Conductor.
- Use Stripe integration in workflows.
Step 1: Get the Stripe credentials
To integrate Stripe with Orkes Conductor, get the API key from Stripe.
To get the API key:
- Log in to Stripe.
- Select the settings icon on the top-right.
- Go to Developers > API keys.
- Copy the Secret key (starts with
sk_test_for test mode orsk_live_for live mode).
For testing, use the test mode API keys and for production use the live mode keys.
Step 2: Add an integration for Stripe
After obtaining the credentials, add a Stripe integration to your Conductor cluster.
To create an integration:
- Go to Integrations > Connected Apps from the left navigation menu on your Conductor cluster.
- Select + New integration.
- In the Payment section, choose Stripe.
- Select + Add and enter the following parameters:
| Parameter | Description | Required/Optional |
|---|---|---|
| Integration name | A name for the integration. | Required. |
| API Key | The API key retrieved from Stripe in Step 1. | Required. |
| API Endpoint | The stripe API endpoint. Defaults to https://api.stripe.com. | Required. |
| Description | A description of the integration. | Required. |
- (Optional) Toggle the Active button off if you don't want to activate the integration instantly.
- Select Save.
Step 3: Use Stripe integration in workflows
Once the integration is ready, this can be used directly within the workflows.
To use Stripe integration in a workflow:
- Go to Definitions > Workflow from the left navigation menu on your Conductor cluster.
- Select + Define workflow.
- In your workflow, select the (+) icon and select Connected Apps.
- In Add Task panel on the right, search for Stripe, and select the integration created in Step 2.
The following operations are available for use with this integration.
| Operation | Description |
|---|---|
| Get Balance | Retrieves the current balance for your Stripe account, including available and pending amounts across all currencies. |
| List Customers | Retrieves a list of customers from your Stripe account. |
| Create Customer | Creates a new customer record in Stripe. |
| Get Customer | Retrieves the details of an existing Stripe customer. |
| Update Customer | Updates an existing customer record in Stripe. |
| Delete Customer | Deletes an existing customer record from Stripe. |
| Create Coupon | Creates a new coupon in Stripe. |
| List Coupons | Retrieves a list of coupons from your Stripe account. |
| Create Payment Intent | Creates a new payment intent in Stripe. |
| Get Payment Intent | Retrieves the details of an existing Stripe payment intent. |
| Cancel Payment Intent | Cancels an existing Stripe payment intent. |
| List Charges | Retrieves a list of charges from your Stripe account. |
| Create Charge | Creates a new charge in Stripe. |
| Update Charge | Updates an existing charge in Stripe. |
| Get Charge | Retrieves the details of an existing Stripe charge. |
| Create Refund | Creates a refund for an existing Stripe charge. |
| Get Refund | Retrieves the details of an existing Stripe refund. |
| Attach Payment Method | Attaches a payment method to an existing Stripe customer. |
| Get Payment Method | Retrieves the details of an existing Stripe payment method. |
| Detach Payment Method | Detaches a payment method from a Stripe customer. |
| Create Meter Event | Creates a meter event to record usage in Stripe. |
- Select the required operation, configure the parameters, and select Save > Confirm.
- Select Execute to run the workflow.
For the complete operations parameters and output reference, see Stripe Operations Reference.