> ## Documentation Index
> Fetch the complete documentation index at: https://docs.recurso.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Stripe Connection Webhook
> Receive Stripe webhook events for a workspace's own connected Stripe account.
Per-connection variant of the [Stripe webhook receiver](/api-reference/webhooks/stripe)
for workspaces that connected their own Stripe account with
[Connect a Gateway](/api-reference/gateways/connect). The event is verified
with that connection's own signing secret (resolved from `connID`) before the
payload is trusted. Invoice and credit-note events are bound to the
connection's workspace; subscription, payment-attempt and ACH-return handling
are not (see below). Event handling is otherwise identical to the platform
receiver.
Each connection has its own URL. Read `webhook_path` from
[List Gateway Connections](/api-reference/gateways/list) (for example
`/webhooks/stripe/{connID}`), append it to `https://api.recurso.dev`, and
register that URL in the Stripe Dashboard under **Developers > Webhooks** using
the `webhook_secret` (`whsec_...`) you supplied when connecting, or set later
with [Set Gateway Webhook Secret](/api-reference/gateways/webhook-secret). A
connection without a webhook secret cannot verify deliveries and rejects them.
## Parameters
| Parameter | Type | Required | Description |
| ------------------ | ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `connID` | string (UUID, path) | Yes | The workspace's Stripe gateway-connection id. |
| `Stripe-Signature` | string (header) | Yes | Stripe webhook signature header (`t=...,v1=...`), verified with the connection's signing secret. Events stamped with a different Stripe API version than the one Recurso pins are still accepted. |
## Request Body
The raw Stripe event payload. The `type` field selects the handler:
| Event | Effect |
| ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payment_intent.succeeded` | Settles the invoice named in `metadata.invoice_id` (`open` → `paid`), stores the `pi_*` id for later refunds, records the dunning success, and marks any tracked ACH [payment attempt](/api-reference/payment-attempts/get) `succeeded`. |
| `payment_intent.processing` | Records an ACH debit entering its multi-day processing window as a `processing` payment attempt; the invoice stays `open`. |
| `payment_intent.payment_failed` | Marks the tracked ACH payment attempt `failed` with the return code; the invoice stays `open` for dunning. |
| `invoice.payment_failed` | Marks the invoice in `metadata.invoice_id` `past_due`, records the failure reason, records the dunning failure, triggers the dunning campaign, and emails the customer. |
| `customer.subscription.deleted` | Cancels the matching Recurso subscription immediately (status `canceled`, reason `stripe_webhook`). |
| `charge.refunded`, `charge.refund.updated`, `refund.updated`, `refund.failed` | Advances the [credit note](/api-reference/credit-notes/get) that owns each refund (`pending` → `processed` or `refund_failed`). A succeeded full refund on a bank-debit attempt with no credit note is treated as an ACH return: the attempt is marked `returned`, the invoice reopens (`paid` → `past_due`), and the settlement cash leg is reversed in the ledger. |
Any other event type is acknowledged without side effects. An invoice named
in `metadata.invoice_id` that belongs to a different workspace than the
connection is ignored, never applied, and a refund whose credit note belongs
to another workspace is likewise ignored. Three paths are not bound to the
connection's workspace: `customer.subscription.deleted` resolves the
subscription by its Stripe subscription id, `payment_intent.payment_failed`
resolves the payment attempt by its PaymentIntent id, and the ACH-return
fallback on the refund events (a succeeded refund with no credit note)
resolves the bank-debit payment attempt by its PaymentIntent id and reverses
that attempt's invoice under the attempt's own workspace. None of those three
is checked against the connection's workspace.
## Example Request
Stripe sends a POST request with event data:
```bash theme={null}
curl -X POST https://api.recurso.dev/webhooks/stripe/7c9e6679-7425-40de-944b-e07fc1f90ae7 \
-H "Content-Type: application/json" \
-H "Stripe-Signature: t=1756944000,v1=3f1a9c0e7b2d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8091a2b3c4d5e6f708192a3b" \
-d '{
"id": "evt_StripeABC123",
"object": "event",
"type": "payment_intent.succeeded",
"data": {
"object": {
"id": "pi_StripeDEF456",
"object": "payment_intent",
"amount": 5899,
"currency": "usd",
"status": "succeeded",
"metadata": {
"invoice_id": "1c1b3a5e-4d7f-4c1a-9f2e-6b8d0a3c5e71"
}
}
}
}'
```
## Response
Returns `200 OK` on successful processing. Unhandled event types, and events
whose `metadata.invoice_id` is missing or malformed, are also acknowledged
with `ok` so Stripe stops redelivering them. A `payment_intent.succeeded`
whose `invoice_id` matches no invoice is acknowledged the same way; an
`invoice.payment_failed` whose `invoice_id` matches no invoice is treated as
an error and returns `500`, so Stripe keeps redelivering it.
```json theme={null}
{
"status": "ok"
}
```
## Fields
| Field | Type | Description |
| -------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `status` | string | `ok` when the event was processed or deliberately ignored. A redelivery of an event that was already applied returns `duplicate ignored`. |
Deduplication keys on the Stripe event `id`. An event is only recorded as
processed after a successful response; a delivery that fails with 5xx is
retried by Stripe and reprocessed.
## Errors
| Status | Code | When | Fix |
| ------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `400` | `validation_failed` | `connID` in the path is not a UUID | Use the connection's `webhook_path` from [List Gateway Connections](/api-reference/gateways/list) |
| `400` | `validation_failed` | Request body could not be read | Check the delivery in the Stripe Dashboard |
| `401` | `unauthorized` | `Stripe-Signature` is missing, expired, or does not verify against this connection's signing secret (an unparseable body also fails verification) | Make sure the signing secret registered in Stripe matches the connection's `webhook_secret` |
| `404` | `not_found` | No active Stripe connection has this id (a missing, disconnected, or non-Stripe connection all return 404) | Reconnect the gateway and register the new `webhook_path` |
| `500` | `internal_error` | The event payload could not be decoded; loading, settling, reopening, or canceling the affected record failed; or an `invoice.payment_failed` names an `invoice_id` that matches no invoice | Stripe retries the delivery; the event is not recorded as processed until it succeeds |
| `503` | `internal_error` | The connection has no webhook secret (the receiver fails closed), per-connection webhooks are not configured on the API, or the inbound-webhook dedup store is unavailable | Store the secret with [Set Gateway Webhook Secret](/api-reference/gateways/webhook-secret) (the connection id and `webhook_path` stay the same); otherwise let Stripe retry |
Errors use the standard envelope — see [Errors](/api-reference/errors).
## OpenAPI
````yaml POST /webhooks/stripe/{connID}
openapi: 3.1.0
info:
title: Recurso API
version: 1.0.0
description: |
The Recurso billing engine REST API.
Authenticate by passing your API key as a bearer token:
Authorization: Bearer
Obtain an API key by registering a tenant via `POST /auth/register`.
All authenticated endpoints live under the `/v1` prefix. Mutating
endpoints support idempotency via the `Idempotency-Key` header.
license:
name: MIT
identifier: MIT
servers:
- url: https://billing.example.com
description: >-
Example deployment — substitute the base URL of your own Recurso
deployment.
security:
- bearerAuth: []
tags:
- name: System
description: Health, version, and API metadata
- name: Auth
description: Tenant registration
- name: Plans
description: Product catalog plans
- name: Customers
description: Customer management
- name: Subscriptions
description: Subscription lifecycle
- name: Invoices
description: Invoices, PDFs, and Indian GST e-invoicing
- name: Coupons
description: Discounts
- name: Usage
description: Metered usage events
- name: Credit Notes
description: Customer credits
- name: Quotes
description: Quote-to-invoice lifecycle
- name: Webhooks
description: Webhook endpoint management and event feed
- name: Analytics
description: Revenue analytics
- name: Checkout
description: Public hosted checkout for invoices
- name: Payments
description: Payment order creation
- name: Inbound Webhooks
description: Receivers for payment-gateway callbacks (Razorpay, Stripe)
- name: Customer Portal
description: Customer-facing portal — magic-link auth and session-scoped data
- name: Developer
description: API key management
- name: Account
description: Tenant account settings
- name: Finance
description: Ledger accounts, entries, reconciliation, and revenue recognition
- name: Settings
description: Tax (GST) and e-invoicing (IRP) configuration
- name: Consents
description: Consent records for RBI-compliant recurring billing
- name: Referrals
description: Customer referral program
- name: Gifts
description: Gift subscriptions
- name: Mandates
description: UPI Autopay mandates
- name: Offline Payments
description: Virtual accounts and manually recorded payments
- name: Organizations
description: Multi-entity organizations grouping several tenants
- name: Accounting
description: QuickBooks / Xero accounting integrations
- name: Churn
description: Churn risk scoring and alerts
- name: Cancel Flows
description: Configurable retention flows shown at cancellation time
- name: Dunning
description: Dunning analytics and multi-channel dunning campaigns
paths:
/webhooks/stripe/{connID}:
post:
tags:
- Inbound Webhooks
summary: Stripe webhook receiver (per-connection, BYO)
description: |
Per-connection variant of the Stripe webhook receiver for tenants who
connected their own Stripe account. The event is verified with THAT
connection's own signing secret (resolved from `connID`) before the
payload is trusted. Called by Stripe, not by API consumers.
operationId: handleStripeWebhookForConnection
parameters:
- name: connID
in: path
required: true
description: The tenant's Stripe gateway-connection id.
schema:
type: string
format: uuid
- name: Stripe-Signature
in: header
required: true
description: Stripe webhook signature header.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
description: Raw Stripe event payload.
responses:
'200':
description: Event processed (or deliberately ignored).
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum:
- ok
- ignored
reason:
type: string
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security: []
components:
responses:
BadRequest:
description: The request body or parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Missing or invalid credentials (API key or session cookie).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: The requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
required:
- error
properties:
error:
type: object
description: Structured error detail.
required:
- code
- message
properties:
code:
type: string
description: Stable machine-readable error code.
examples:
- validation_failed
- unauthorized
- forbidden
- not_found
- conflict
- rate_limited
- internal_error
- invalid_api_key
- key_mode_mismatch
- over_refund
- invoice_not_paid
- invoice_already_paid
message:
type: string
description: Human-readable explanation.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: API key
description: >-
Tenant API key obtained from `POST /auth/register` or `POST
/v1/developer/keys`.
````