@orchesty/connector-stripe
v2.0.0
Published
[](https://www.npmjs.com/package/@orchesty/connector-stripe) [](https://github.com/Orchesty/orchesty-nodejs-conn
Readme
Stripe Connector
An Orchesty connector for Stripe, a developer-friendly payment platform for accepting and managing online payments.
Application Type
Basic
This connector authenticates using a Stripe API key sent as a Bearer token in the Authorization header. Requests use application/x-www-form-urlencoded content type as required by the Stripe API.
| Field | Description |
|---|---|
| api_key | Your Stripe secret API key |
Components
| Class | Type | Description |
|---|---|---|
| StripeCreatePaymentConnector | Connector | Creates a charge/payment via POST https://api.stripe.com/v1/charges; requires amount, currency, source, and description in the input |
Setup
Credentials
- Log in to the Stripe Dashboard.
- Navigate to Developers → API keys.
- Copy your Secret key (starts with
sk_live_for production orsk_test_for testing). - In Orchesty, open the Stripe application settings and paste the key into the API Key field.
Use
sk_test_keys during development to avoid real charges.
API Documentation
Stripe API: https://stripe.com/docs/api/charges/create
Installation & Usage
Install the package:
npm install @orchesty/connector-stripe @orchesty/nodejs-sdk
# or
pnpm add @orchesty/connector-stripe @orchesty/nodejs-sdkRegister the application and nodes in your Orchesty DI container:
import { container } from '@orchesty/nodejs-sdk';
import StripeApplication from '@orchesty/connector-stripe/dist/StripeApplication';
import StripeCreatePaymentConnector from '@orchesty/connector-stripe/dist/Connector/StripeCreatePaymentConnector';
const app = new StripeApplication();
container.setApplication(app);
container.setNode(new StripeCreatePaymentConnector(), app);License
This connector is released under the Apache License 2.0. See the LICENSE file for the full license text.
Contributing
Contributions are welcome! This connector is part of the open-source Orchesty Node.js Connectors monorepo.
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the Contributing to Connectors guide.
All contributions should include:
- Source code in
src/following the existing connector structure - Tests in
src/**/__tests__/withinput.json,mock.json, andoutput.jsonfixtures - An updated
CHANGELOG.mdentry
