@antelopejs/stripe

An extensive Stripe payment processing module that implements the Stripe interface for AntelopeJS.

For detailed documentation on the Stripe interface, please refer to the docs.

Installation

ajs project modules add @antelopejs/stripe

Overview

The AntelopeJS Stripe module provides functionality for handling Stripe payment processing:

• Payment intent creation and management
• Webhook handling for Stripe events
• Payment method retrieval
• Payment monitoring and event watching
• Cluster-aware payment processing with Redis

Dependencies

This module depends on the following Antelope interfaces:

• API Interface: Required to handle Stripe webhook events and route them to the appropriate handlers
• Redis Interface: Used to enable clustering capabilities, allowing payment intent monitoring and watching to work seamlessly across multiple instances

Configuration

The Stripe module can be configured with the following options:

{
  "apiKey": "your_stripe_api_key",
  "webhookSecret": "your_stripe_webhook_secret",
  "endpoint": "stripe"
}

Configuration Details

The module requires the following configuration properties:

• apiKey: Your Stripe API key for authentication with the Stripe API
• webhookSecret: Your Stripe webhook signing secret for verifying webhook events
• endpoint: The base endpoint path for Stripe webhook controller (defaults to 'stripe' if not specified)

Additional configuration properties from the Stripe.js library configuration can also be provided.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.