Stripe Payment for Composable Commerce

This repository provides a commercetools connect integration for Stripe payment, enabling a drop-in experience through the Stripe Payment Element and supporting webhook handling, payment intents, and checkout configuration.

Features

• Uses commercetools SDK for the commercetools-specific communication.
• It uses connect payment SDK to manage request context, sessions, and JWT authentication.
• Use commercetools payment api to manage payment transactions.
• Includes local development utilities in npm commands to build, start, test, lint & prettify code.
• Support for the Stripe Payment Element, including:
  • Customizable layout options
  • Appearance API for theming and branding
  • Manual or automatic payment capture modes
  • Enables saving and reusing customer payment methods directly within the Payment Element component for a seamless checkout experience. See details
  • Flexible billing address collection
• Supports collecting payment details before creating a payment intent, enabling flexible checkout flows. The backend processor utilizes the Stripe API to efficiently create and manage payment intents and subscriptions, handle webhooks, and process payments. See Details
• Comprehensive Stripe customer session management: automatically creates or retrieves Stripe customers, synchronizes the logged-in commercetools customer with their corresponding Stripe account, and stores the Stripe customer ID in commercetools for seamless future transactions. See Considerations
• Sync shipping information from commercetools to Stripe payment intent.
• Support for Buy Now Pay Later (BNPL) payment method.Considerations
• Support for a wide range of payment methods, including Apple Pay, Google Pay, Amazon Pay, and others. See Considerations
• Merchants can leverage the custom product type provided by the connector to create and manage subscriptions directly within commercetools. These subscriptions are automatically synchronized with Stripe for creation and updates. Learn more.
• Subscription Management API: The connector provides comprehensive subscription management capabilities through dedicated API endpoints. You can create, manage, and monitor Stripe subscriptions directly through the commercetools connector. View Subscription API Documentation.
• Subscription Price Synchronization: The connector automatically synchronizes subscription prices with commercetools product prices, ensuring customers always pay the current price. This feature can be enabled via the STRIPE_SUBSCRIPTION_PRICE_SYNC_ENABLED environment variable. Learn more.
• Subscription Shipping Fee Support: The connector now supports recurring shipping fees as part of subscription billing, automatically creating and managing Stripe shipping prices that align with subscription billing intervals. Learn more.
• Mixed Cart Support: Enhanced subscription handling for carts containing both subscription items and one-time items. The system automatically adds one-time items to the first invoice of the subscription. Learn more.
• Attribute Name Standardization: All subscription-related product type attributes now use the stripeConnector_ prefix for better organization and consistency. The system automatically handles the transformation between prefixed attribute names and internal field names. Learn more.
• Enhanced Subscription Management: Comprehensive subscription update capabilities including product variant switching, price updates, and configuration changes. The new updateSubscription method provides seamless subscription management while maintaining data consistency. Learn more.
• Enhanced Payment Intent Error Handling: Improved error management for payment intent statuses including requires_action and payment_failed with structured error objects for better debugging.
• Multiple Refunds and Multicapture Support (Opt-in): Advanced payment processing capabilities including multiple partial captures and accurate refund tracking using Stripe API integration. This feature is disabled by default and must be explicitly enabled via STRIPE_ENABLE_MULTI_OPERATIONS=true. Requires multicapture enabled in your Stripe account and manual capture mode. Learn more.
• Provides a subscription management API via the commercetools connector, enabling Stripe subscription operations directly through commercetools API endpoints.
• Customers can update their shipping and billing addresses directly within the Stripe Express Checkout. When an address is changed, the connector automatically fetches the latest shipping rates from commercetools and updates the cart to reflect the new information. See Details

Price Synchronization Architecture

The connector implements a sophisticated price synchronization system that maintains consistency between Stripe subscriptions and commercetools product prices. This system operates on the principle of Stripe as the source of truth for products and commercetools as the source of truth for prices.

How Price Synchronization Works

Source of Truth Principles

• Stripe: Manages subscription lifecycle, billing cycles, and customer relationships
• Commercetools: Controls product pricing, variants, and business logic
• Synchronization: Automatically aligns Stripe subscription prices with commercetools product prices

Price Synchronization Modes

Automatic Mode (STRIPE_SUBSCRIPTION_PRICE_SYNC_ENABLED=true):

• Prices are synchronized before each invoice creation via invoice.upcoming webhook
• Price changes take effect for the current billing period
• Real-time price updates without waiting for the next billing cycle

Standard Mode (STRIPE_SUBSCRIPTION_PRICE_SYNC_ENABLED=false):

• Prices are updated after payment via the createOrder method
• Price changes take effect for the next billing cycle
• Traditional subscription billing behavior

Benefits of Price Synchronization

• Customer Satisfaction: Customers always pay current, accurate prices
• Business Agility: Price changes take effect immediately when needed
• Data Consistency: Eliminates price discrepancies between systems
• Automated Management: No manual intervention required for price updates

For detailed configuration and implementation details, see Subscription Price Synchronization.

Prerequisite

1. commercetools composable commerce API client

Create an API client responsible for payment management in a composable commerce project. The API client details are input as environment variables/ configuration for connect, such as CTP_PROJECT_KEY, CTP_CLIENT_ID, and CTP_CLIENT_SECRET. Please read Deployment Configuration for details. In addition, please make sure the API client has enough scope to manage Payment. For details, please refer to Running Application

2. Various URLs from commercetools composable commerce

Configure various URLs from the commercetools platform, so that the connect application can handle the session and authentication process for endpoints. Their values are input for environment variables/configurations for connecting, with variable names CTP_API_URL, CTP_AUTH_URL, and CTP_SESSION_URL.

3. Stripe account and keys

Configure Stripe secret and public keys so the Connect application can handle endpoint session and authentication processes. Their values are taken as input as environment variables/ configuration for Connect, with variable names STRIPE_SECRET_KEY, STRIPE_PUBLISHABLE_KEY, and STRIPE_WEBHOOK_SIGNING_SECRET. If you want to create a Restricted key to add in the STRIPE_SECRET_KEY and STRIPE_PUBLISHABLE_KEY, the minimum permissions needed are:

• Refunds: Write
• PaymentIntents: Write
• Customer: Write
• CustomerSession: Write
• Webhook Endpoints: Write
• Subscriptions: Write

Getting started with the Payment Connector

The connect-payment-integration-stripe contains two modules:

• Enabler: This is a wrapper implementation where Stripe frontend Payment Element components are embedded. It gives the merchant the control over when and how to load the connector frontend based on business configuration.
• Processor: This functions as a backend service and middleware for integration with the Stripe platform. It interacts with Stripe for transactions and updates the payment entity within Composable Commerce. Finding the Stripe customer that owns the commercetools cart, or creating the customer and adding the information to the custom field of the cart. Additionally, it supports a listener for triggers related to Stripe webhook events to update the payment entity with connect-payment-sdk based on webhook events.

Regarding the development of a processor or enabler module, please refer to the following documentation:

• Development of Processor
• Development of Enabler

Components

1. Composable Commerce Represents the website platform infrastructure provided by client.
2. Stripe Composable Connector
   • A Payment connector integration within the infrastructure of commercetools that facilitates communication between commercetools and Stripe.
3. Processor
   • Manages payment transactions and interacts with Stripe to:
     • Create payment intents.
     • Handle manual API payment transactions.
     • Listening to webhooks events triggered by Stripe and processing all related payment operations.
     • Create Stripe customer session
4. Enabler
   • Assists in the creation of the Stripe Payment Element and Express Checkout components used as a payment method by client.
   • Connects to any sample site that wants to integrate the connector, providing the available payment components for seamless integration.
5. Stripe
   • The external payment service provider that handles various payment operations, sends webhooks for events such as authorization, capture, refund, and cancel.

Sequence Diagrams for the Payment Connector

The Enabler component is tasked with rendering the Stripe Payment Element or Express Checkout, providing a seamless payment experience for users. The diagram below illustrates the workflow for initializing these payment components:

Once the payment component is set up, the connector orchestrates various payment flows based on the user's context—such as logged-in customers, guest checkouts, and subscriptions (with or without a SetupIntent). The following sequence diagrams break down these scenarios:

• Standard Payment Flow:

• Subscription with Invoice:

• Subscription without Invoice:

Each diagram details the interactions and steps involved in processing the respective payment type.

Recent Updates and Improvements

Multiple Refunds and Multicapture Implementation (Latest) - OPT-IN FEATURE

The payment processing system has been significantly enhanced with advanced multicapture and refund capabilities. These features are opt-in and disabled by default to ensure backward compatibility.

⚙️ Configuration Required

• Environment Variable: STRIPE_ENABLE_MULTI_OPERATIONS=true (default: false)
• Prerequisites:
  • Multicapture must be enabled in your Stripe account
  • Set STRIPE_CAPTURE_METHOD=manual
  • Webhook endpoint must include charge.updated and charge.refunded events
• Default Behavior: When disabled, webhook events are gracefully skipped with logging
• Backward Compatible: Existing merchants experience no disruption

🚀 New Features (When Enabled)

• Multicapture Support: Enhanced payment capture functionality to support multiple partial captures on the same payment intent
• Advanced Refund Processing: New refund handling that fetches accurate refund details directly from Stripe API
• Incremental Capture Tracking: Sophisticated tracking of incremental captured amounts using Stripe's previous attributes
• Conditional Webhook Routing: Dedicated event handlers for charge.updated and charge.refunded events that only process when feature is enabled
• Balance Transaction Tracking: Improved PSP reference tracking using Stripe balance transaction IDs

🔧 Technical Improvements

• API-Based Refund Details: Refund processing now fetches actual refund amounts and IDs from Stripe API for precise transaction records
• Partial Capture Detection: Automatic detection of partial captures with proper final_capture handling
• Simplified Payment Updates: Removed manual commercetools payment updates in favor of webhook-based processing
• Enhanced Error Handling: Comprehensive validation and error management for multicapture scenarios
• Improved Event Converter: Added support for CHARGE__UPDATED events and enhanced refund processing

🧪 Testing Infrastructure Enhancements

• Comprehensive Test Coverage: Updated test suites to cover all new multicapture and refund functionality
• Enhanced Webhook Testing: Improved webhook routing tests for new event types
• Converter Testing: Added tests for new event converter functionality
• Edge Case Coverage: Enhanced testing for various multicapture and refund scenarios

📚 Documentation and Architecture Updates

• Enhanced Webhook Documentation: Updated webhook event descriptions to reflect new capabilities
• Improved Transaction Tracking: Better PSP reference tracking for audit and debugging purposes
• Comprehensive Logging: Enhanced logging throughout the payment processing pipeline
• Better Error Management: Structured error handling with detailed transaction information

Enhanced Subscription Service Architecture and Testing Infrastructure

The subscription service has undergone major architectural improvements with comprehensive testing enhancements:

🚀 New Features

• New Price Client Service: Added dedicated price-client.ts service for enhanced product price management and retrieval
• Modular Test Architecture: Restructured subscription service tests into focused, maintainable modules:
  • Business logic and payment handling tests
  • Core subscription functionality tests
  • Subscription lifecycle management tests
  • Payment processing and confirmation tests
  • Price management and calculation tests
  • Utility functions and helper method tests
• Enhanced Configuration Management: Added comprehensive configuration testing and validation
• Advanced Payment Intent Handling: Enhanced error handling for payment intents with additional status checks
• Improved Subscription Metadata Management: Enhanced metadata tracking with comprehensive field mapping

🔧 Technical Improvements

• Subscription Service Refactoring: Major architectural improvements with better separation of concerns
• Enhanced Test Coverage: Achieved comprehensive test coverage across all subscription service methods and edge cases
• Improved Mock Data Management: Enhanced mock data structures for better test reliability and coverage
• Better Error Handling: Comprehensive error management throughout the subscription service with detailed logging
• Payment Processing Enhancements: Improved payment intent configuration with conditional shipping and advanced payment method options
• New Price Management Methods:
  • getProductById(): Retrieves products with expanded price information
  • getProductMasterPrice(): Gets current price from product master variant

🧪 Testing Infrastructure Enhancements

• Modular Test Structure: Tests organized by functionality for better maintainability and faster execution
• Comprehensive Coverage: All subscription service methods now have dedicated test coverage
• Enhanced Mock Data: Improved mock data for realistic testing scenarios
• Better Test Organization: Clear separation between unit tests and integration tests
• Configuration Testing: Added dedicated tests for configuration validation

📚 Documentation and Architecture Updates

• Enhanced Code Organization: Better separation of concerns in subscription service architecture
• Improved Type Safety: Updated method signatures and type definitions for better development experience
• Better Logging: Enhanced logging throughout the service for improved debugging capabilities
• Optimized Performance: More efficient product price management and test execution

Previous Enhancements

Subscription Service Core Features

• Recurring Shipping Fee Support: Added comprehensive support for recurring shipping fees in subscriptions
• Automatic Shipping Price Management: Automatic creation and management of Stripe shipping prices
• Enhanced Metadata Tracking: Improved metadata handling for shipping methods and prices
• Shipping Price Integration: New methods for managing shipping prices within subscriptions:
  • getSubscriptionShippingPriceId(): Retrieves or creates shipping price IDs
  • getStripeShippingPriceByMetadata(): Searches for existing shipping prices
  • createStripeShippingPrice(): Creates new Stripe shipping prices
• Enhanced Type Definitions: Added new TypeScript interfaces for shipping price management
• Enabler Enhancements: Improved payment mode handling and comprehensive debugging

For detailed information about these improvements, see the Processor Documentation.

For technical implementation details, see the Subscription Shipping Fee Integration Guide.

For enabler and payment service improvements, see the Enabler Improvements Guide.

Webhooks

The following webhooks are currently supported, and the payment transactions in commercetools are:

• payment_intent.canceled: Modified the payment transaction Authorization to Failure and create a payment transaction CancelAuthorization: Success
• payment_intent.succeeded: Creates a payment transaction Charge: Success.
• payment_intent.requires_action: Logs the information in the connector app inside the Processor logs.
• payment_intent.payment_failed: Modify the payment transaction Authorization to Failure.
• charge.refunded: Creates payment transactions Refund: Success and Chargeback: Success with accurate refund amounts fetched from Stripe API. Note: Only processed when STRIPE_ENABLE_MULTI_OPERATIONS=true; gracefully skipped when disabled.
• charge.succeeded: Create the payment transaction to 'Authorization:Success' if charge is not captured, and update the payment method type that was used to pay.
• charge.captured: Logs the information in the connector app inside the Processor logs.
• charge.updated: Handles multicapture scenarios by creating Charge: Success transactions with incremental captured amounts. Note: Only processed when STRIPE_ENABLE_MULTI_OPERATIONS=true; gracefully skipped when disabled.
• invoice.paid: If payment charge is pending, we update the payment transaction to Charge:Success. If charge is not pending, we update the payment transaction to Authorization:Success and create a payment transaction Charge:Success.
• invoice.payment_failed: If payment charge is pending, we update the payment transaction to Charge:Failure. If charge is not pending, we update the payment transaction to Authorization:Failure and create a payment transaction Charge:Failure.
• invoice.upcoming: Handles upcoming invoice events for subscription payments, supporting the new subscription payment handling strategy.

Prerequisite

1. Stripe account credentials and configurations

Before installing the connector, you must create a Stripe account and obtain the necessary credentials. The Stripe account is required to process payments and manage transactions. Sign up for a Stripe account at Stripe. Once you have an account, you must set up the following configurations in your environment variables or configuration files. Before installing the connector, a webhook endpoint in Stripe must be created (using a dummy URL). Retrieve the ID and Signing Secret from the Stripe Console. The Webhook Endpoint is update during the post-deploy script after the deployed connector. It's important to set the correct values in the variables so the events are sent to the connector and can be accepted. The following Stripe account credentials and configurations are required:

1. STRIPE_SECRET_KEY: Provided by Stripe. Secret and stored securely in your web or mobile app's server-side code (such as in an environment variable or credential management system) to call Stripe APIs.
2. STRIPE_CAPTURE_METHOD: Configuration that enables the capture method selected by the user. The capture method controls when Stripe will capture the funds from the customer's account. Possible enum values:
   • automatic: Stripe automatically captures funds when the customer authorizes the Payment.
   • automatic_async: (Default) Stripe asynchronously captures funds when the customer authorizes the Payment. Recommended over capture_method=automatic due to improved latency. Read the integration guide for more information.
   • manual: Places a hold on the funds when the customer authorizes the Payment but doesn't capture the funds until later. (Not all payment methods support this.) Required for multicapture support - must be set to manual when STRIPE_ENABLE_MULTI_OPERATIONS=true.
3. STRIPE_APPEARANCE_PAYMENT_ELEMENT: This configuration enables the theming for the payment element component. The value needs to be a valid stringified JSON. More information about the properties can be found here.

//stringified, eg.
{"theme":"night","labels":"floating"}

4. STRIPE_APPEARANCE_EXPRESS_CHECKOUT: This configuration enables the theming for the express checkout component. The value needs to be a valid stringified JSON. More information about the properties can be found here.

//stringified, eg.
{"theme":"night","labels":"floating"}

5. STRIPE_WEBHOOK_ID: Unique identifier of a Webhook Endpoint in Stripe.
6. STRIPE_WEBHOOK_SIGNING_SECRET: Signing secret of a Webhook Endpoint in Stripe.
7. STRIPE_LAYOUT: This configuration enables the Layout for the payment component. The value needs to be a valid stringified JSON. More information about the properties can be found here.

//stringified eg.
{"type":"accordion","defaultCollapsed":false,"radios":true, "spacedAccordionItems":false}

8. STRIPE_SAVED_PAYMENT_METHODS_CONFIG: The configuration for the saved payment methods. The value needs to be a valid stringified JSON. More information about the properties can be found here. This feature is disabled by default. To enable it, you need to add the expected customer session object.

//stringified, eg.
{"payment_method_save_usage":"off_session","payment_method_redisplay_limit":10}

9. STRIPE_PUBLISHABLE_KEY: Provided by Stripe. The key is to create the Payment Element component on the front end.
10. STRIPE_APPLE_PAY_WELL_KNOWN: This is the domain association file from Stripe. Use to verify the domain for Apple Pay. More information can be found here.
11. MERCHANT_RETURN_URL: This is the return URL used on the confirmPayment return_url parameter. The Buy Now Pay Later payment methods will send the Stripe payment_intent in the URL; the Merchant will need to retrieve the payment intent and look for the metadata ct_payment_id is added in the commercetools Checkout SDK paymentReference.
12. STRIPE_COLLECT_BILLING_ADDRESS: This is the configuration for the Stripe collect shipping address in the payment element. The default value is auto. More information can be found here.
13. CTP_PROJECT_KEY: The key to the commercetools project
14. CTP_AUTH_URL: Authentication URL for commercetools
15. CTP_API_URL: API URL for commercetools
16. CTP_SESSION_URL: Session API URL for commercetools
17. CTP_JWKS_URL: JWKs URL for JWT validation
18. CTP_JWT_ISSUER: JWT issuer for validation
19. CTP_CLIENT_SECRET: Client secret for commercetools (in secured configuration)
20. CTP_CLIENT_ID: Client ID for commercetools with specific required scopes (in secured configuration)

These commercetools-specific variables are essential for the connector to properly authenticate and communicate with the commercetools platform.

2. commercetools

We must create the connector on the commercetools connect marketplace, enable the checkout feature in the merchant center, and select the payment connector as the drop-in payment method on the checkout configuration page. Users create an API client responsible for payment management in a composable commerce project. The API client's details are input as environment variables/ configuration for connecting, such as CTP_PROJECT_KEY, CTP_CLIENT_ID, and CTP_CLIENT_SECRET.

1. API client: Various URLs from the commercetools platform must be configured so that the connect application can handle the session and authentication process for endpoints. Their values are taken as input as environment variables/ configuration for connect, with variable names CTP_API_URL, CTP_AUTH_URL, and CTP_SESSION_URL.
2. payment connector: Install the payment connector from the commercetools connector marketplace.

Note: To use the Stripe Composable Connector installed, you must call the enabler module from the installed connector URL. To find more information about how to use the enabler module, please refer to the Enabler documentation.

Creating Components for Payment Elements or Express Checkout

This section explains how to integrate the Stripe Composable connector with commercetools. First, load the Stripe Enabler using the URL provided by the connector information page. Then initialize a payment component by creating a new Enabler instance with parameters for processor URL, session ID, currency, callbacks, and payment component type (either 'paymentElement' or 'expressCheckout').

The integration requires a few steps: create the enabler instance with required configuration (including processor URL and callbacks), build a component using createDropinBuilder, and mount it to a DOM element. The component handles payment processing while maintaining security standards. You'll need to replace placeholder variables with your actual application configuration values to complete the integration.

For detailed implementation instructions and code examples, please refer to the Enabler documentation.

Considerations for Express Checkout

By default all Express Checkout components are created with 'shippingAddressRequired' and 'billingAddressRequired' set to true. This means that the Express Checkout component can update the shipping methods and the address information in the cart. You can find the information of the methods responsible for updating the shipping methods in the Processor Documentation.

Considerations for Apple Pay and Google Pay

Apple Pay

Apple Pay integration requires three key elements:

1. Domain verification: Set up a .well-known directory that redirects to {COMMERCETOOLS_PROCESSOR_URL}/applePayConfig to satisfy Apple's domain verification requirements
2. Compatible hardware/software: Use iOS 11.3+/macOS 11.3+ devices with Safari and an active Apple Wallet card configured for sandbox testing
3. Stripe configuration: Enable Apple Pay in your Stripe dashboard settings and ensure proper domain registration

For detailed implementation instructions, see the Apple Pay considerations in the Enabler documentation.

Google Pay

Google Pay implementation requires:

1. Compatible browser/device: Use Chrome browser on any compatible device with an active Google Pay account configured for sandbox testing
2. Stripe configuration: Enable Google Pay in your Stripe dashboard settings with domain validation handled automatically by Stripe

For complete implementation details, refer to the Google Pay considerations in the Enabler documentation.

Development Guide

Deployment Configuration

It needs to be published to deploy your customized connector application on commercetools Connect. For details, please refer to documentation about commercetools Connect In addition, the tax integration connector template has a folder structure, as listed below, to support Connect.

├── enabler
│   ├── src
│   ├── test
│   └── package.json
├── processor
│   ├── src
│   ├── test
│   └── package.json
└── connect.yaml

The connect deployment configuration specifie in connect.yaml, the information needed to publish the application. Following is the deployment configuration used by the Enabler and Processor modules

deployAs:
  - name: enabler
    applicationType: assets
  - name: processor
    applicationType: service
    endpoint: /
    scripts:
      postDeploy: npm install && npm run connector:post-deploy
      preUndeploy: npm install && npm run connector:pre-undeploy
    configuration:
      standardConfiguration:
        - key: CTP_PROJECT_KEY
          description: commercetools project key
          required: true
        - key: CTP_AUTH_URL
          description: commercetools Auth URL (example - https://auth.europe-west1.gcp.commercetools.com).
          required: true
          default: https://auth.europe-west1.gcp.commercetools.com
        - key: CTP_API_URL
          description: commercetools API URL (example - https://api.europe-west1.gcp.commercetools.com).
          required: true
          default: https://api.europe-west1.gcp.commercetools.com
        - key: CTP_SESSION_URL
          description: Session API URL (example - https://session.europe-west1.gcp.commercetools.com).
          required: true
          default: https://session.europe-west1.gcp.commercetools.com
        - key: CTP_JWKS_URL
          description: JWKs url (example - https://mc-api.europe-west1.gcp.commercetools.com/.well-known/jwks.json)
          required: true
          default: https://mc-api.europe-west1.gcp.commercetools.com/.well-known/jwks.json
        - key: CTP_JWT_ISSUER
          description: JWT Issuer for jwt validation (example - https://mc-api.europe-west1.gcp.commercetools.com)
          required: true
          default: https://mc-api.europe-west1.gcp.commercetools.com
        - key: STRIPE_CAPTURE_METHOD
          description: Stripe capture method (example - manual|automatic).
          default: automatic
        - key: STRIPE_WEBHOOK_ID
          description: Stripe unique identifier for the Webhook Endpoints (example - we_*****).
          required: true
        - key: STRIPE_APPEARANCE_PAYMENT_ELEMENT
          description: Stripe Appearance for Payment Element (example - {"theme":"stripe","variables":{"colorPrimary":"\#0570DE","colorBackground":"\#FFFFFF","colorText":"\#30313D","colorDanger":"\#DF1B41","fontFamily":"Ideal Sans,system-ui,sansserif","spacingUnit":"2px","borderRadius":"4px"}}).
        - key: STRIPE_APPEARANCE_EXPRESS_CHECKOUT
          description: Stripe Appearance for Express Checkout (example - {"theme":"stripe","variables":{"colorPrimary":"\#0570DE","colorBackground":"\#FFFFFF","colorText":"\#30313D","colorDanger":"\#DF1B41","fontFamily":"Ideal Sans,system-ui,sansserif","spacingUnit":"2px","borderRadius":"4px"}}).
        - key: STRIPE_LAYOUT
          description: Stripe Layout for Payment Element (example - {"type":"accordion","defaultCollapsed":false,"radios":true,"spacedAccordionItems":false} ).
          default: '{"type":"tabs","defaultCollapsed":false}'
        - key: STRIPE_PUBLISHABLE_KEY
          description: Stripe Publishable Key
          required: true
        - key: STRIPE_APPLE_PAY_WELL_KNOWN
          description: Domain association file from Stripe. (example - https://stripe.com/files/apple-pay/apple-developer-merchantid-domain-association)
        - key: STRIPE_SAVED_PAYMENT_METHODS_CONFIG
          description: Stripe configuration for saved payment methods (example - {"payment_method_save":"enabled","payment_method_save_usage":"off_session","payment_method_redisplay":"enabled","payment_method_redisplay_limit":10}).
          default: '{"payment_method_save":"disabled"}'
        - key: MERCHANT_RETURN_URL
          description: Merchant return URL
          required: true
        - key: STRIPE_COLLECT_BILLING_ADDRESS
          description: Stripe collect billing address information in Payment Element (example - 'auto' | 'never' | 'if_required').
          default: 'auto'
          required: true
        - key: STRIPE_SUBSCRIPTION_PAYMENT_HANDLING
          description: Subscription payment handling strategy (createOrder|addPaymentToOrder).
          default: createOrder
        - key: STRIPE_SUBSCRIPTION_PRICE_SYNC_ENABLED
          description: Enable automatic price synchronization for subscriptions (true|false).
          default: false
        - key: STRIPE_ENABLE_MULTI_OPERATIONS
          description: Enable multicapture and multirefund support (true|false). When enabled, allows multiple partial captures and multiple refunds on payments. IMPORTANT - Requires multicapture to be enabled in your Stripe account.
          default: 'false'
      securedConfiguration:
        - key: CTP_CLIENT_SECRET
          description: commercetools client secret.
          required: true
        - key: CTP_CLIENT_ID
          description: commercetools client ID with manage_payments, manage_orders, view_sessions, view_api_clients, manage_checkout_payment_intents, introspect_oauth_tokens, manage_types and view_types scopes
          required: true
        - key: STRIPE_SECRET_KEY
          description: Stripe secret key (example - sk_*****).
          required: true
        - key: STRIPE_WEBHOOK_SIGNING_SECRET
          description: Stripe Webhook signing secret  (example - whsec_*****).
          required: true

Here, you can see the details about various variables in the configuration

• CTP_PROJECT_KEY: The key to the commercetools composable commerce project.
• CTP_SCOPE: The scope constrains the endpoints to which the commercetools client has access and the read/write access right to an endpoint.
• CTP_AUTH_URL: The URL for authentication in the commercetools platform. Generate the OAuth 2.0 token required in every API call to commercetools composable commerce. The default value is https://auth.europe-west1.gcp.commercetools.com. For details, please refer to the documentation here.
• CTP_API_URL: The URL for commercetools composable commerce API. The default value is https://api.europe-west1.gcp.commercetools.com.
• CTP_SESSION_URL: The URL for session creation in the commercetools platform. Connectors rely on the session created to share information between the enabler and processor. The default value is https://session.europe-west1.gcp.commercetools.com.
• CTP_JWKS_URL: The JSON Web Key Set URL. Default value is https://mc-api.europe-west1.gcp.commercetools.com/.well-known/jwks.json
• CTP_JWT_ISSUER: The issuer inside JSON Web Token, required in the JWT validation process. The default value is https://mc-api.europe-west1.gcp.commercetools.com
• STRIPE_CAPTURE_METHOD: Stripe capture method (manual or automatic), default value: automatic.
• STRIPE_APPEARANCE_PAYMENT_ELEMENT: Stripe Elements supports visual customization, which allows you to match the design of your site with the appearance option. This value has the specific appearance of the Payment Element component. The value needs to be a valid stringified JSON. More information about the properties can be found here.
• STRIPE_APPEARANCE_EXPRESS_CHECKOUT: Stripe Elements supports visual customization, which allows you to match the design of your site with the appearance option. This value has the specific appearance of the Express Checkout component.
• STRIPE_LAYOUT: Stripe allows you to customize the Payment Element's Layout to fit your checkout flow (accordions or tabs). Default value is {"type":"tabs","defaultCollapsed":false}
• STRIPE_APPLE_PAY_WELL_KNOWN: Domain association file from Stripe. We can find more information in this link.
• CTP_CLIENT_SECRET: The client secret of commercetools composable commerce user account. It is used in commercetools for clients to communicate with commercetools composable commerce via SDK.
• CTP_CLIENT_ID: The client ID of your commercetools composable commerce user account. It is used in commercetools for clients to communicate with commercetools composable commerce via SDK. Expected scopes are: manage_payments manage_orders view_sessions view_api_clients manage_checkout_payment_intents introspect_oauth_tokens manage_types view_types.
• STRIPE_SECRET_KEY: Stripe authenticates your API requests using your account's API keys
• STRIPE_PUBLISHABLE_KEY: Stripe authenticates your frontend requests using your account's Publishable keys
• STRIPE_WEBHOOK_ID: Stripe unique identifier for the Webhook Endpoints
• STRIPE_WEBHOOK_SIGNING_SECRET: Stripe Secret key to verify webhook signatures using the official libraries. This key is created in the Stripe dashboard Webhook.
• MERCHANT_RETURN_URL: Merchant return URL used on the confirmPayment return_url parameter. The Buy Now Pay Later payment methods will send the Stripe payment_intent in the URL; the Merchant will need to retrieve the payment intent and look for the metadata ct_payment_id to be added in the commercetools Checkout SDK paymentReference.
• STRIPE_SAVED_PAYMENT_METHODS_CONFIG: Stripe allows you to configure the saved payment methods in the Payment Element, refer to docs. This feature is disabled by default. To enable it, you need to add the expected customer session object. Default value is {"payment_method_save":"disabled"}
• STRIPE_COLLECT_BILLING_ADDRESS: Stripe allows you to collect the shipping address in the Payment Element. If you want to collect the shipping address, you need to set this value to never. The default value is auto. More information can be found here.
• STRIPE_SUBSCRIPTION_PAYMENT_HANDLING: Defines the strategy for handling subscription payments. Options are:
  • createOrder (creates a new order for each subscription payment - default)
  • addPaymentToOrder (adds payment to existing order)
• STRIPE_SUBSCRIPTION_PRICE_SYNC_ENABLED: Enables automatic price synchronization for subscriptions.
  • true: Subscription prices are automatically synchronized with current commercetools product prices before each invoice is created via invoice.upcoming webhook events (price changes take effect in current billing cycle)
  • false (default): Price updates happen after invoice payment via createOrder method (price changes take effect in next billing cycle)
• STRIPE_ENABLE_MULTI_OPERATIONS: Opt-in Feature - Enables multicapture and multirefund support.
  • true: Enables multiple partial captures and multiple refunds on payments. Sets request_multicapture: 'if_available' on payment intents. Processes charge.updated and charge.refunded webhook events.
  • false (default): Standard single-capture payment processing. Webhook events are gracefully skipped with informative logging.
  • Prerequisites: Requires multicapture enabled in your Stripe account AND STRIPE_CAPTURE_METHOD=manual
  • See: Multiple Refunds and Multicapture Documentation for detailed configuration

Development

Certain configurations are necessary to get started developing this connector, most of which involve updating environment variables in both services (enabler, processor). Creating a Webhook Endpoint in Stripe (using a dummy URL) is necessary. Once created, retrieve the ID and Signing Secret from the Stripe Console. The Webhook Endpoint configuration is update during the post-deploy script after the connector is deploy. It's important to set the correct values in the variables so the events are sent to the connector and can be accepted.

Configuration steps

1. Environment Variable Setup

Navigate to each service directory and duplicate the .env.template file, renaming the copy to .env. Populate the newly created .env file with the appropriate values.

cp .env.template .env

2. Spin Up Components via Docker Compose

With the help of docker compose, you can spin up all necessary components required for developing the connector by running the following command from the root directory;

docker compose up

This command would start three services that are required for development.

1. JWT Server
2. Enabler
3. Processor