@prood/payment-stripe

@prood/payment-stripe implements the PaymentProvider interface for Stripe, using the Checkout Sessions API with the embedded Payment Element.

InstallationCopy Anchor Link

Workspace package. Available from the source repo for now.

UsageCopy Anchor Link

import { StripePaymentProvider } from '@prood/payment-stripe'

const provider = new StripePaymentProvider({
  secretKey: config.secretKey,
  webhookSecret: config.webhookSecret,
  publishableKey: config.publishableKey,
})

Via commerce factory (preferred in apps):

import { getTenantPaymentProvider } from '@prood/commerce'
const { provider } = await getTenantPaymentProvider(orgId, 'stripe')

ConfigurationCopy Anchor Link

Each store enters these under Integrations in the dashboard. There is no environment fallback.

Payment flowCopy Anchor Link

1. createSession() → creates a Checkout Session
2. Client renders the Payment Element with its clientSecret
3. Customer submits → Stripe handles 3DS if required
4. confirmSession() → reads the Checkout Session's status
5. Webhook checkout.session.completed → the source of truth

Webhook eventsCopy Anchor Link

Webhook URL: https://checkout.example.com/api/webhooks/stripe/{orgId}

RefundsCopy Anchor Link

await provider.refund({
  sessionId: 'cs_xxx', // the Checkout Session on the order
  amount: 50, // partial refund in major units
  reason: 'requested_by_customer',
})

refund() resolves when Stripe accepts the refund and reads nothing back. Stripe honours idempotencyKey, so a retry can't send the money twice.

Test modeCopy Anchor Link

Use Stripe test keys (sk_test_..., pk_test_...):

Related pagesCopy Anchor Link