@adonis-agora/payments 0.2.0 → 0.3.0

package/dist/src/drivers/stripe.js

@@ -1,6 +1,90 @@
 import Stripe from 'stripe';
 import { publishPaymentDiagnostics, publishRefundDiagnostics, publishSubscriptionDiagnostics, } from '../diagnostics.js';
 import { emitInvoiceIfRequested } from '../invoice/emit_invoice.js';
+import { requireCurrency } from './shared.js';
+/**
+ * Stripe's dispute evidence fields, verbatim from the Dispute object (API
+ * `2025-08-27.basil`).
+ *
+ * The set is what lets `metadata` reach the twenty-odd fields {@link DisputeEvidence} has
+ * no name for — `product_description`, `cancellation_rebuttal`, `access_activity_log` —
+ * while a misspelled or invented key is refused here instead of failing the whole
+ * submission at the API. A dispute gets ONE submission; it should not be spent on a typo.
+ */
+/**
+ * {@link DisputeDocumentKind} onto Stripe's nine evidence file fields.
+ *
+ * Stripe files evidence by what it proves, one File upload id per field, which is why the
+ * shared type addresses a document by kind rather than handing over a bare list of ids: an
+ * id with no kind cannot be submitted anywhere.
+ *
+ * Three kinds have no field of their own and land on `uncategorized_file`: Stripe has no
+ * invoice or terms-of-service slot, and `other` is what the slot is for. Two of them in one
+ * submission collide there, and the collision is reported rather than silently resolved —
+ * pick which one Stripe should see, or pass the other under its own field via `metadata`.
+ */
+const STRIPE_DOCUMENT_FIELDS = {
+    receipt: 'receipt',
+    customer_communication: 'customer_communication',
+    customer_signature: 'customer_signature',
+    shipping: 'shipping_documentation',
+    service: 'service_documentation',
+    refund_policy: 'refund_policy',
+    cancellation_policy: 'cancellation_policy',
+    duplicate_charge: 'duplicate_charge_documentation',
+    invoice: 'uncategorized_file',
+    terms: 'uncategorized_file',
+    other: 'uncategorized_file',
+};
+const STRIPE_EVIDENCE_FIELDS = new Set([
+    'access_activity_log',
+    'billing_address',
+    'cancellation_policy',
+    'cancellation_policy_disclosure',
+    'cancellation_rebuttal',
+    'customer_communication',
+    'customer_email_address',
+    'customer_name',
+    'customer_purchase_ip',
+    'customer_signature',
+    'duplicate_charge_documentation',
+    'duplicate_charge_explanation',
+    'duplicate_charge_id',
+    'product_description',
+    'receipt',
+    'refund_policy',
+    'refund_policy_disclosure',
+    'refund_refusal_explanation',
+    'service_date',
+    'service_documentation',
+    'shipping_address',
+    'shipping_carrier',
+    'shipping_date',
+    'shipping_documentation',
+    'shipping_tracking_number',
+    'uncategorized_file',
+    'uncategorized_text',
+]);
+/**
+ * The nine evidence fields that take a **File upload id** (`file_…`, created with purpose
+ * `dispute_evidence`) rather than text.
+ *
+ * This is the mismatch behind most of the refusals below: a URL is neither a file id nor
+ * something the reviewing bank will follow — Stripe's own guidance is that banks review no
+ * external content, links included — so a driver that put `receiptUrl` in `receipt` would
+ * submit a defense the issuer never reads and report it as sent.
+ */
+const STRIPE_EVIDENCE_FILE_FIELDS = new Set([
+    'cancellation_policy',
+    'customer_communication',
+    'customer_signature',
+    'duplicate_charge_documentation',
+    'receipt',
+    'refund_policy',
+    'service_documentation',
+    'shipping_documentation',
+    'uncategorized_file',
+]);
 /**
  * Stripe driver. Wraps the Stripe SDK and normalizes its API onto the shared
  * {@link PaymentsDriver} contract. The SDK is imported lazily by the factory in
@@ -9,7 +93,7 @@ import { emitInvoiceIfRequested } from '../invoice/emit_invoice.js';
 export class StripeDriver {
     provider = 'stripe';
     supportedMethods = ['pix', 'credit_card', 'boleto', 'undefined'];
-    capabilities = { refunds: true, invoices: true, subscriptions: true };
+    capabilities = { disputes: true, refunds: true, invoices: true, subscriptions: true };
     #stripe;
     #currency;
     #webhookSecret;
@@ -23,7 +107,9 @@ export class StripeDriver {
             throw new Error('[payments] Stripe driver requires an API key. Set `STRIPE_KEY` env or pass `apiKey` to `payments.stripe()`.');
         }
         this.#stripe = new Stripe(apiKey);
-        this.#currency = config.currency ?? 'brl';
+        // The constructor (not the factory) enforces this, because `./drivers/stripe` is a
+        // public entry point too — this is the one boundary every path crosses.
+        this.#currency = requireCurrency('stripe', config.currency);
         this.#webhookSecret = config.webhookSecret ?? process.env.STRIPE_WEBHOOK_SECRET;
     }
     // ── Customers ────────────────────────────────────────────────────────────────────────
@@ -35,7 +121,7 @@ export class StripeDriver {
             ...(input.metadata !== undefined
                 ? { metadata: input.metadata }
                 : {}),
-        });
+        }, this.#requestOptions(input.idempotencyKey));
         return this.#mapCustomer(customer);
     }
     async findCustomer(customerId) {
@@ -64,6 +150,9 @@ export class StripeDriver {
     }
     // ── Payments ─────────────────────────────────────────────────────────────────────────
     async charge(input) {
+        // Without `payment_method_types` Stripe creates the intent with whatever the account's
+        // dashboard defaults are, so a charge routed as Pix could come back a card.
+        const methodType = this.#mapMethodToStripe(input.method);
         const params = {
             amount: input.amount,
             currency: input.currency ?? this.#currency,
@@ -71,18 +160,20 @@ export class StripeDriver {
             ...(input.description !== undefined ? { description: input.description } : {}),
             ...(input.paymentMethodId !== undefined ? { payment_method: input.paymentMethodId } : {}),
             ...(input.card !== undefined ? { payment_method: input.card.token } : {}),
+            ...(methodType !== undefined ? { payment_method_types: [methodType] } : {}),
             ...(input.metadata !== undefined
                 ? { metadata: input.metadata }
                 : {}),
-            ...(input.idempotencyKey !== undefined ? {} : {}),
         };
         if (input.idempotencyKey !== undefined) {
+            // Stripe never echoes the request header back on the object, so the metadata copy is
+            // what lets `payment.payload` trace a charge to the key that created it.
             params.metadata = { ...(params.metadata ?? {}), idempotency_key: input.idempotencyKey };
         }
         if (input.externalReference !== undefined) {
             params.metadata = { ...(params.metadata ?? {}), external_reference: input.externalReference };
         }
-        const intent = await this.#stripe.paymentIntents.create(params);
+        const intent = await this.#stripe.paymentIntents.create(params, this.#requestOptions(input.idempotencyKey));
         const payment = this.#mapPayment(intent);
         await emitInvoiceIfRequested(this.#invoiceCtx, input, payment, this);
         publishPaymentDiagnostics(payment);
@@ -99,11 +190,11 @@ export class StripeDriver {
             throw error;
         }
     }
-    async refund(paymentGatewayId, amount) {
+    async refund(paymentGatewayId, amount, options) {
         const refund = await this.#stripe.refunds.create({
             payment_intent: paymentGatewayId,
             ...(amount !== undefined ? { amount } : {}),
-        });
+        }, this.#requestOptions(options?.idempotencyKey));
         const result = {
             id: refund.id,
             gatewayId: refund.id,
@@ -149,7 +240,7 @@ export class StripeDriver {
                     ],
                 }),
         };
-        const session = await this.#stripe.checkout.sessions.create(params);
+        const session = await this.#stripe.checkout.sessions.create(params, this.#requestOptions(input.idempotencyKey));
         return {
             id: session.id,
             gatewayId: session.id,
@@ -195,7 +286,7 @@ export class StripeDriver {
                 }
                 : {}),
         };
-        const subscription = await this.#stripe.subscriptions.create(params);
+        const subscription = await this.#stripe.subscriptions.create(params, this.#requestOptions(input.idempotencyKey));
         const result = this.#mapSubscription(subscription);
         publishSubscriptionDiagnostics(result, 'subscription.created');
         return result;
@@ -236,7 +327,7 @@ export class StripeDriver {
                 ? { metadata: input.metadata }
                 : {}),
         };
-        const subscription = await this.#stripe.subscriptions.update(subscriptionGatewayId, params);
+        const subscription = await this.#stripe.subscriptions.update(subscriptionGatewayId, params, this.#requestOptions(input.idempotencyKey));
         return this.#mapSubscription(subscription);
     }
     // ── Invoices ─────────────────────────────────────────────────────────────────────────
@@ -264,7 +355,71 @@ export class StripeDriver {
             };
         });
     }
+    // ── Disputes ─────────────────────────────────────────────────────────────────────────
+    /**
+     * Read a dispute by its Stripe id (`du_…`) — `GET /v1/disputes/{id}`.
+     *
+     * The two fields an operator acts on come off Stripe's own `evidence_details` rather
+     * than off a reading of the status: `evidenceDueBy` from `due_by`, `canSubmitEvidence`
+     * from the status **and** `past_due`. `payload` carries the whole Dispute, including
+     * `is_charge_refundable` — the other half of the decision, because while it is true a
+     * refund can still end the matter, and after a full refund Stripe withdraws nothing
+     * further.
+     */
+    async findDispute(disputeGatewayId) {
+        try {
+            return this.#mapDispute(await this.#stripe.disputes.retrieve(disputeGatewayId));
+        }
+        catch (error) {
+            if (this.#isNotFound(error))
+                return null;
+            throw error;
+        }
+    }
+    /**
+     * Submit evidence for a dispute — `POST /v1/disputes/{id}` with the `evidence` hash.
+     *
+     * **Submitting is final.** Stripe forwards the response to the issuing bank immediately;
+     * you cannot edit it, add to it, or send a second one. So this refuses in three places
+     * rather than guessing: it maps every {@link DisputeEvidence} field or names the one it
+     * cannot (silently dropping a field the caller believed was submitted is the worst bug
+     * this file could have), it re-reads the dispute and refuses when Stripe will not accept
+     * evidence, and it refuses an empty hash rather than spending the one submission on
+     * nothing.
+     *
+     * It never decides *whether* to fight — that is margin, customer value and fraud
+     * history, none of which a library can see. `submit` defaults to `true` because the
+     * method is named submit; `metadata.submit: false` stages a draft instead, which stays
+     * visible in the API and the Dashboard until someone submits it.
+     */
+    async submitDisputeEvidence(disputeGatewayId, evidence) {
+        // Mapped first: a field this driver cannot carry should cost the caller an error, not
+        // a round trip, and certainly not a half-built submission.
+        const { fields, submit } = this.#mapDisputeEvidence(evidence);
+        const current = await this.#stripe.disputes.retrieve(disputeGatewayId);
+        if (!this.#canSubmitEvidence(current)) {
+            const dueBy = current.evidence_details?.due_by;
+            const pastDue = current.evidence_details?.past_due === true
+                ? ' and the evidence deadline has already passed'
+                : '';
+            const due = typeof dueBy === 'number' ? ` (due by ${new Date(dueBy * 1000).toISOString()})` : '';
+            throw new Error(`[payments] Stripe dispute ${disputeGatewayId} will not accept evidence: its status is \`${current.status}\`${pastDue}${due}. Only \`needs_response\` and \`warning_needs_response\` can still be answered — one under review has had its single submission, and a closed one is decided. Read \`canSubmitEvidence\` from \`findDispute()\` before building the case.`);
+        }
+        const updated = await this.#stripe.disputes.update(disputeGatewayId, {
+            evidence: fields,
+            submit,
+        });
+        return this.#mapDispute(updated);
+    }
     // ── Webhooks ─────────────────────────────────────────────────────────────────────────
+    /**
+     * Whether a delivery to `POST /payments/webhook/:provider` can be authenticated.
+     *
+     * `parseWebhook` already refuses without the secret — declaring it moves the refusal to boot.
+     */
+    get webhookVerification() {
+        return this.#webhookSecret !== undefined ? 'configured' : 'unconfigured';
+    }
     parseWebhook(rawBody, headers) {
         if (!this.#webhookSecret) {
             throw new Error('[payments] Stripe webhook processing requires `STRIPE_WEBHOOK_SECRET` env var.');
@@ -297,15 +452,7 @@ export class StripeDriver {
             gatewayId: intent.id,
             provider: this.provider,
             amount: { amount: intent.amount, currency: intent.currency },
-            status: intent.status === 'succeeded'
-                ? 'paid'
-                : intent.status === 'requires_payment_method' ||
-                    intent.status === 'requires_action' ||
-                    intent.status === 'processing'
-                    ? 'pending'
-                    : intent.status === 'canceled'
-                        ? 'canceled'
-                        : 'failed',
+            status: this.#mapIntentStatus(intent.status),
             payload: intent.metadata !== undefined && Object.keys(intent.metadata).length > 0
                 ? intent.metadata
                 : {},
@@ -318,9 +465,54 @@ export class StripeDriver {
         if (intent.status === 'succeeded') {
             result.paidAt = new Date(intent.created * 1000).toISOString();
         }
+        // A Pix/boleto intent is useless to the caller without what the payer has to act on;
+        // Stripe puts it under `next_action`. `image_url_png` is a URL, not the base64 PNG
+        // `pixQrCodeImage` promises, so it is deliberately not mapped there.
+        const pix = intent.next_action?.pix_display_qr_code;
+        if (pix?.data !== undefined) {
+            result.pixCode = pix.data;
+            result.pixCopiaECola = pix.data;
+        }
+        const hostedUrl = pix?.hosted_instructions_url ??
+            intent.next_action?.boleto_display_details?.hosted_voucher_url;
+        if (hostedUrl !== null && hostedUrl !== undefined)
+            result.hostedUrl = hostedUrl;
         return result;
     }
-    #mapSubscription(subscription) {
+    /**
+     * A PaymentIntent status → a `BillingStatus`.
+     *
+     * `requires_capture` is the manual-capture hold: Stripe has the funds reserved on the
+     * card and nothing has moved. It used to fall through to `failed` — the same shape of
+     * lie in the opposite direction, a live authorization reported as a dead payment — and
+     * `requires_confirmation` fell there with it. Neither is a failure; the first is
+     * `authorized` and the second is a payment nobody has confirmed yet.
+     */
+    #mapIntentStatus(status) {
+        switch (status) {
+            case 'succeeded':
+                return 'paid';
+            case 'requires_capture':
+                return 'authorized';
+            case 'requires_payment_method':
+            case 'requires_confirmation':
+            case 'requires_action':
+            case 'processing':
+                return 'pending';
+            case 'canceled':
+                return 'canceled';
+            default:
+                return 'failed';
+        }
+    }
+    /**
+     * A Stripe subscription status → a `SubscriptionStatus`.
+     *
+     * `paused` used to answer `active`, which entitled a subscriber nobody is billing —
+     * Stripe pauses collection precisely so you can stop serving them. It has its own name
+     * now: the subscription exists, it will bill again, and it must not grant access today.
+     */
+    #mapSubscriptionStatus(status) {
         const statusMap = {
             trialing: 'trialing',
             active: 'active',
@@ -329,8 +521,11 @@ export class StripeDriver {
             canceled: 'canceled',
             unpaid: 'past_due',
             incomplete_expired: 'ended',
-            paused: 'active',
+            paused: 'paused',
         };
+        return (status !== undefined ? statusMap[status] : undefined) ?? 'active';
+    }
+    #mapSubscription(subscription) {
         return {
             id: subscription.id,
             gatewayId: subscription.id,
@@ -338,7 +533,7 @@ export class StripeDriver {
             customerId: typeof subscription.customer === 'string'
                 ? subscription.customer
                 : subscription.customer.id,
-            status: statusMap[subscription.status] ?? 'active',
+            status: this.#mapSubscriptionStatus(subscription.status),
             planId: subscription.items.data[0]?.price.id ?? '',
             ...(subscription.items.data[0]?.price.unit_amount !== null
                 ? {
@@ -361,23 +556,609 @@ export class StripeDriver {
         };
     }
     #mapWebhookEvent(event) {
+        const object = event.data.object;
+        const normalized = this.#normalizeEvent(event.type, object);
         return {
             id: event.id,
             provider: this.provider,
-            type: event.type,
-            createdAt: new Date(event.created * 1000).toISOString(),
-            data: event.data.object,
+            type: normalized.type,
+            // Guarded: `new Date(undefined * 1000).toISOString()` throws a bare RangeError, which
+            // surfaces as a crash rather than as this package's own rejection. A real Stripe event
+            // always carries `created`, so this only fires on a malformed body — but a malformed
+            // body should be REFUSED, not turned into a stack trace.
+            //
+            // Deliberately untested: this spec's mocked Stripe SDK fills `created`, so a test here
+            // passes with and without the guard, which measures nothing. Reaching it needs the real
+            // SDK's `constructEvent` over a hand-signed body.
+            createdAt: Number.isFinite(event.created)
+                ? new Date(event.created * 1000).toISOString()
+                : new Date().toISOString(),
+            data: normalized.data,
             raw: event,
         };
     }
+    /**
+     * Stripe's own event type → the canonical one, with the payload the processor syncs on.
+     *
+     * This driver used to pass `event.type` and the raw Stripe object straight through, so
+     * `WebhookProcessor` — which switches on the canonical names — recognized nothing Stripe
+     * sent and synced nothing: `billing_payments` stayed empty while every webhook was
+     * ledgered as processed. A chargeback could not move a row that was never written.
+     *
+     * A type is only renamed when the canonical payload can actually be built from the
+     * object; when it cannot, the event passes through under its Stripe name with the raw
+     * object as `data`, which is what the processor does with anything it does not know.
+     * That matters because the built-in handlers THROW on a malformed payload, and a throw
+     * inside the webhook route is a 500 that Stripe retries forever.
+     */
+    #normalizeEvent(type, object) {
+        const passthrough = { type, data: object };
+        const as = (canonical, data) => data === undefined ? passthrough : { type: canonical, data: data };
+        switch (type) {
+            case 'payment_intent.succeeded':
+                return as('payment.succeeded', this.#intentData(object));
+            case 'payment_intent.payment_failed':
+                return as('payment.failed', this.#intentData(object));
+            // Real state changes with no canonical event of their own. `amount_capturable_updated`
+            // is the manual-capture authorization — money held, not moved — and there is
+            // deliberately no `payment.authorized` event for it to become.
+            case 'payment_intent.canceled':
+            case 'payment_intent.processing':
+            case 'payment_intent.requires_action':
+            case 'payment_intent.amount_capturable_updated':
+                return as('payment.updated', this.#intentData(object));
+            case 'charge.refunded': {
+                const charge = object;
+                // Stripe fires this for a PARTIAL refund too, and the canonical `payment.refunded`
+                // marks the whole payment refunded. Only `refunded: true` — Stripe's own "nothing
+                // left" flag — means that; a partial one is an update.
+                return as(charge.refunded === true ? 'payment.refunded' : 'payment.updated', this.#chargeData(object));
+            }
+            // The dispute family. `charge.dispute.created` fires for BOTH a chargeback and an
+            // inquiry, and the two are not the same event at all: on an inquiry the card network
+            // is asking a question and **no funds are withdrawn**, so calling it
+            // `payment.disputed` took a paid payment away over a question. Stripe distinguishes
+            // them only by the status prefix — an inquiry's is `warning_*`.
+            case 'charge.dispute.created': {
+                const dispute = object;
+                return typeof dispute.status === 'string' && dispute.status.startsWith('warning_')
+                    ? as('payment.dispute_warning', this.#disputeWarningData(object))
+                    : as('payment.disputed', this.#disputeData(object));
+            }
+            // An early fraud warning is the issuer's TC40/SAFE fraud report, and it arrives
+            // before any dispute exists. Stripe's own figure is that ~80% of them become a fraud
+            // dispute if you do nothing, and a refund inside the window stops the chargeback
+            // being filed at all — which is worth doing even on one you would win, because the
+            // chargeback still counts against the ratio that triggers network monitoring.
+            case 'radar.early_fraud_warning.created':
+                return as('payment.dispute_warning', this.#fraudWarningData(object));
+            case 'charge.dispute.closed': {
+                const outcome = this.#disputeOutcome(object);
+                // Only a status that names an outcome becomes a close. Anything else stays an
+                // update rather than inventing a result for money that has not settled.
+                return outcome === undefined
+                    ? as('payment.updated', this.#disputeData(object))
+                    : as('payment.dispute_closed', this.#disputeClosedData(object, outcome));
+            }
+            // Funds moving during an open dispute, and evidence being submitted. Neither is a
+            // resolution.
+            case 'charge.dispute.updated':
+            case 'charge.dispute.funds_withdrawn':
+            case 'charge.dispute.funds_reinstated':
+                return as('payment.updated', this.#disputeData(object));
+            case 'checkout.session.completed':
+            case 'checkout.session.async_payment_succeeded': {
+                const session = object;
+                // A completed session is not a paid one: a subscription checkout completes with no
+                // payment at all, and a delayed-notification method (boleto, SEPA) completes while
+                // the money is still in flight. `payment_status` is the only field that says so.
+                return as(session.payment_status === 'paid' ? 'payment.succeeded' : 'payment.updated', this.#sessionData(object));
+            }
+            case 'checkout.session.async_payment_failed':
+                return as('payment.failed', this.#sessionData(object));
+            case 'checkout.session.expired':
+                return as('payment.updated', this.#sessionData(object));
+            case 'customer.subscription.created':
+                return as('subscription.created', this.#subscriptionData(object));
+            case 'customer.subscription.updated':
+            case 'customer.subscription.paused':
+            case 'customer.subscription.resumed':
+            case 'customer.subscription.trial_will_end':
+                return as('subscription.updated', this.#subscriptionData(object));
+            case 'customer.subscription.deleted':
+                return as('subscription.canceled', this.#subscriptionData(object));
+            default:
+                // Everything else keeps its Stripe name and its raw object: unknown is ledgered
+                // and handed to a registered handler, never dropped.
+                return passthrough;
+        }
+    }
+    /** A PaymentIntent → the canonical payment payload, or `undefined` if it is not one. */
+    #intentData(object) {
+        const intent = object;
+        if (typeof intent.id !== 'string' ||
+            typeof intent.amount !== 'number' ||
+            typeof intent.currency !== 'string') {
+            return undefined;
+        }
+        const metadata = (intent.metadata ?? {});
+        return {
+            gatewayId: intent.id,
+            amount: intent.amount,
+            currency: intent.currency,
+            ...(typeof intent.customer === 'string' ? { customerId: intent.customer } : {}),
+            ...(typeof metadata.external_reference === 'string'
+                ? { externalReference: metadata.external_reference }
+                : {}),
+        };
+    }
+    /**
+     * A Charge → the canonical payment payload, keyed on the **PaymentIntent**.
+     *
+     * `charge()` returns `pi_…` and every other event here is keyed on it, so a refund
+     * ledgered under `ch_…` would write a second row for the same money instead of moving
+     * the first. The charge id is only used for a legacy Charges-API charge that has no
+     * intent at all.
+     */
+    #chargeData(object) {
+        const charge = object;
+        const gatewayId = typeof charge.payment_intent === 'string'
+            ? charge.payment_intent
+            : typeof charge.id === 'string'
+                ? charge.id
+                : undefined;
+        if (gatewayId === undefined ||
+            typeof charge.amount !== 'number' ||
+            typeof charge.currency !== 'string') {
+            return undefined;
+        }
+        const metadata = (charge.metadata ?? {});
+        return {
+            gatewayId,
+            amount: charge.amount,
+            currency: charge.currency,
+            ...(typeof charge.customer === 'string' ? { customerId: charge.customer } : {}),
+            ...(typeof metadata.external_reference === 'string'
+                ? { externalReference: metadata.external_reference }
+                : {}),
+        };
+    }
+    /**
+     * A Dispute → the canonical payment payload.
+     *
+     * `payment_intent` is nullable on the Dispute object (a charge created without one has
+     * none), so the charge id is the fallback rather than an assumption. The amount is the
+     * DISPUTED amount, which for a partial dispute is less than the payment — the row moves
+     * to `disputed` either way, and `event.raw` carries the reason and the evidence deadline.
+     */
+    #disputeData(object) {
+        const dispute = object;
+        const gatewayId = typeof dispute.payment_intent === 'string'
+            ? dispute.payment_intent
+            : typeof dispute.charge === 'string'
+                ? dispute.charge
+                : undefined;
+        if (gatewayId === undefined ||
+            typeof dispute.amount !== 'number' ||
+            typeof dispute.currency !== 'string') {
+            return undefined;
+        }
+        return { gatewayId, amount: dispute.amount, currency: dispute.currency };
+    }
+    /**
+     * An inquiry (`warning_*`) or the pre-dispute half of the dispute family. Carries the
+     * deadline, which is the entire value of the alert: an inquiry left unanswered reads to
+     * the issuer as accepting the claim and becomes a chargeback that is probably
+     * irreversible.
+     */
+    #disputeWarningData(object) {
+        const base = this.#disputeData(object);
+        if (base === undefined)
+            return undefined;
+        const dispute = object;
+        const dueBy = dispute.evidence_details?.due_by;
+        return {
+            ...base,
+            disputeId: dispute.id,
+            ...(typeof dispute.reason === 'string' ? { reason: dispute.reason } : {}),
+            ...(typeof dueBy === 'number'
+                ? { actionableUntil: new Date(dueBy * 1000).toISOString() }
+                : {}),
+        };
+    }
+    /**
+     * An early fraud warning has no deadline of its own — the window closes when the
+     * chargeback is filed, which is the thing you are trying to prevent — so it carries no
+     * `actionableUntil`. `actionable` is Stripe's own flag for whether anything can still be
+     * done: false once a dispute has arrived or the charge is fully refunded.
+     */
+    #fraudWarningData(object) {
+        const warning = object;
+        const gatewayId = typeof warning.payment_intent === 'string'
+            ? warning.payment_intent
+            : typeof warning.charge === 'string'
+                ? warning.charge
+                : undefined;
+        if (gatewayId === undefined)
+            return undefined;
+        return {
+            gatewayId,
+            disputeId: warning.id,
+            reason: warning.fraud_type,
+            actionable: warning.actionable,
+        };
+    }
+    /**
+     * `warning_closed` is an inquiry that sat 120 days without escalating. The networks send
+     * no explicit win for one, so it is `expired` rather than `won` — nothing was decided in
+     * your favour, the clock simply ran out in the right direction.
+     */
+    #disputeOutcome(object) {
+        const status = object.status;
+        if (status === 'won')
+            return 'won';
+        if (status === 'lost')
+            return 'lost';
+        if (status === 'warning_closed')
+            return 'expired';
+        return undefined;
+    }
+    #disputeClosedData(object, outcome) {
+        const base = this.#disputeData(object);
+        if (base === undefined)
+            return undefined;
+        return { ...base, disputeId: object.id, outcome };
+    }
+    /**
+     * A Stripe Dispute → the canonical {@link Dispute}.
+     *
+     * `amount` is the DISPUTED amount, which on a partial chargeback is less than the
+     * payment, and `reason` stays Stripe's own code (`fraudulent`, `product_not_received`, …)
+     * because the vocabulary is the network's, not this library's.
+     */
+    #mapDispute(dispute) {
+        const dueBy = dispute.evidence_details?.due_by;
+        return {
+            id: dispute.id,
+            provider: this.provider,
+            paymentGatewayId: this.#disputedPaymentId(dispute),
+            status: this.#mapDisputeStatus(dispute.status),
+            ...(typeof dispute.amount === 'number' && typeof dispute.currency === 'string'
+                ? { amount: { amount: dispute.amount, currency: dispute.currency } }
+                : {}),
+            ...(typeof dispute.reason === 'string' ? { reason: dispute.reason } : {}),
+            ...(typeof dueBy === 'number' ? { evidenceDueBy: new Date(dueBy * 1000).toISOString() } : {}),
+            canSubmitEvidence: this.#canSubmitEvidence(dispute),
+            ...(typeof dispute.created === 'number'
+                ? { createdAt: new Date(dispute.created * 1000).toISOString() }
+                : {}),
+            payload: dispute,
+        };
+    }
+    /**
+     * The disputed payment's id — the PaymentIntent, falling back to the charge.
+     *
+     * Same order as the webhook mappers, and for the same reason: `payment_intent` is what
+     * `charge()` returns, but it is nullable (a legacy Charges-API charge has none). Both are
+     * expandable, so an expanded object is read for its id rather than stringified.
+     */
+    #disputedPaymentId(dispute) {
+        const { payment_intent: intent, charge } = dispute;
+        if (typeof intent === 'string')
+            return intent;
+        if (intent !== null && typeof intent === 'object')
+            return intent.id;
+        if (typeof charge === 'string')
+            return charge;
+        if (charge !== null && typeof charge === 'object')
+            return charge.id;
+        return '';
+    }
+    /**
+     * A Stripe dispute status → the canonical {@link DisputeStatus}.
+     *
+     * The `warning_*` statuses are inquiries: the network is asking a question and **no
+     * funds have been withdrawn**, so they are `warning` and not `open`/`under_review` —
+     * the same money line the webhook mapping draws. `warning_closed` is an inquiry that
+     * lapsed without escalating, which is `expired` rather than `won`: nothing was decided
+     * in your favour, the clock simply ran out the right way. `prevented` — a dispute
+     * stopped before it became a formal chargeback — is `canceled`, because the money never
+     * left.
+     *
+     * The parameter is a plain `string`, not `Stripe.Dispute.Status`: `prevented` is in
+     * Stripe's current API reference and NOT in the SDK's union at 18.5.0, so typing this
+     * against the SDK would make the branch that handles it unreachable to the compiler
+     * while the API keeps sending it.
+     */
+    #mapDisputeStatus(status) {
+        switch (status) {
+            case 'warning_needs_response':
+            case 'warning_under_review':
+                return 'warning';
+            case 'warning_closed':
+                return 'expired';
+            case 'needs_response':
+                return 'open';
+            case 'under_review':
+                return 'under_review';
+            case 'won':
+                return 'won';
+            case 'lost':
+                return 'lost';
+            case 'prevented':
+                return 'canceled';
+            default:
+                // A status Stripe adds after this release. `open` is the reading that keeps it in
+                // front of an operator, and `payload` still carries Stripe's own word for it.
+                return 'open';
+        }
+    }
+    /**
+     * Whether Stripe will still take evidence for this dispute.
+     *
+     * Read from the status and `evidence_details.past_due`, never inferred from one of them
+     * alone: past the deadline the dispute is lost by default and the API rejects the
+     * update, and a dispute already `under_review` has spent its one submission. `won`,
+     * `lost`, `prevented` and `warning_closed` are over. Some disputes arrive already
+     * closed — a network that forbids contesting the reason at all, or a charge Stripe
+     * refunded first — and those must read `false` here so the caller learns it before
+     * building a case rather than at the API error.
+     */
+    #canSubmitEvidence(dispute) {
+        if (dispute.evidence_details?.past_due === true)
+            return false;
+        return dispute.status === 'needs_response' || dispute.status === 'warning_needs_response';
+    }
+    /**
+     * A {@link DisputeEvidence} → Stripe's `evidence` hash, or an error naming what cannot
+     * be carried.
+     *
+     * The rule is that nothing is dropped. Where the shared shape and Stripe's fields
+     * disagree — a URL against a File upload id, a count of prior payments against Visa's
+     * demand for two specific charges — this throws and says what to send instead, because a
+     * caller who believes a receipt was submitted and finds out at the outcome has been told
+     * a lie by this library.
+     */
+    #mapDisputeEvidence(evidence) {
+        if (evidence.termsAcceptedAt !== undefined) {
+            throw new Error('[payments] Stripe has no field for WHEN the customer accepted your terms. Its ' +
+                'nearest homes are the `refund_policy` / `cancellation_policy` documents with the ' +
+                'matching `*_policy_disclosure` text fields, which are where "how and when the ' +
+                'customer was shown this" belongs — pass the policy as a `DisputeDocument` and the ' +
+                'disclosure through `metadata`.');
+        }
+        const fields = {};
+        /** Every write goes through here, so two sources cannot quietly overwrite each other. */
+        const put = (field, value, source) => {
+            if (fields[field] !== undefined) {
+                throw new Error(`[payments] Stripe dispute evidence field \`${field}\` was set twice — by ${source} and by \`metadata.${field}\`. Pass it once; the driver will not pick a winner.`);
+            }
+            fields[field] = value;
+        };
+        if (evidence.explanation !== undefined) {
+            put('uncategorized_text', evidence.explanation, '`explanation`');
+        }
+        if (evidence.shippingCarrier !== undefined) {
+            put('shipping_carrier', evidence.shippingCarrier, '`shippingCarrier`');
+        }
+        if (evidence.shippingTrackingNumber !== undefined) {
+            put('shipping_tracking_number', evidence.shippingTrackingNumber, '`shippingTrackingNumber`');
+        }
+        if (evidence.shippingDate !== undefined) {
+            put('shipping_date', evidence.shippingDate, '`shippingDate`');
+        }
+        if (evidence.serviceDate !== undefined) {
+            put('service_date', evidence.serviceDate, '`serviceDate`');
+        }
+        if (evidence.customerName !== undefined) {
+            put('customer_name', evidence.customerName, '`customerName`');
+        }
+        if (evidence.customerEmail !== undefined) {
+            put('customer_email_address', evidence.customerEmail, '`customerEmail`');
+        }
+        if (evidence.customerIpAddress !== undefined) {
+            put('customer_purchase_ip', evidence.customerIpAddress, '`customerIpAddress`');
+        }
+        for (const document of evidence.documents ?? []) {
+            const field = STRIPE_DOCUMENT_FIELDS[document.kind];
+            put(field, document.id, `\`documents\` (${document.kind})`);
+        }
+        if (evidence.priorUndisputedPayments !== undefined) {
+            const prior = evidence.priorUndisputedPayments;
+            // Stripe's own requirement, not a house rule: Visa Compelling Evidence 3.0 is built
+            // around exactly two prior transactions, and Stripe rejects any other count. Failing
+            // here costs nothing; failing at the API spends the dispute's single submission.
+            if (prior.length !== 2) {
+                throw new Error(`[payments] Visa Compelling Evidence 3.0 takes exactly TWO prior undisputed transactions, and got ${prior.length}. Stripe also only accepts them on a dispute it has already marked eligible — check \`enhanced_eligibility_types\` on the dispute payload before building the case.`);
+            }
+            put('enhanced_evidence', {
+                visa_compelling_evidence_3: {
+                    prior_undisputed_transactions: prior.map((transaction) => ({
+                        charge: transaction.paymentGatewayId,
+                        ...(transaction.customerAccountId !== undefined
+                            ? { customer_account_id: transaction.customerAccountId }
+                            : {}),
+                        ...(transaction.customerDeviceId !== undefined
+                            ? { customer_device_id: transaction.customerDeviceId }
+                            : {}),
+                        ...(transaction.customerIpAddress !== undefined
+                            ? { customer_purchase_ip: transaction.customerIpAddress }
+                            : {}),
+                    })),
+                },
+            }, '`priorUndisputedPayments`');
+        }
+        // `metadata` is the escape hatch the shared type documents, and here it is Stripe's own
+        // field names — the only way to reach `product_description`, the `*_policy` files or
+        // Visa CE 3.0 without inventing fields on a type eighteen drivers share.
+        let submit = true;
+        for (const [key, value] of Object.entries(evidence.metadata ?? {})) {
+            if (key === 'submit') {
+                if (typeof value !== 'boolean') {
+                    throw new Error('[payments] `metadata.submit` on Stripe dispute evidence must be a boolean: ' +
+                        '`true` (the default) sends the response to the issuer and is final, `false` ' +
+                        'stages a draft on the dispute.');
+                }
+                submit = value;
+                continue;
+            }
+            if (key === 'enhanced_evidence') {
+                if (typeof value !== 'object' || value === null) {
+                    throw new Error("[payments] `metadata.enhanced_evidence` must be Stripe's enhanced evidence " +
+                        'object (`visa_compelling_evidence_3`, `visa_compliance`, ' +
+                        '`mastercard_compliance`).');
+                }
+                put('enhanced_evidence', value, '`metadata.enhanced_evidence`');
+                continue;
+            }
+            if (!STRIPE_EVIDENCE_FIELDS.has(key)) {
+                throw new Error(`[payments] \`${key}\` is not a Stripe dispute evidence field, and the driver will not send it — an unrecognized key fails the whole submission at the API. Use Stripe's own field names (https://docs.stripe.com/api/disputes/update), or \`explanation\` for free text.`);
+            }
+            if (typeof value !== 'string') {
+                throw new Error(`[payments] Stripe dispute evidence field \`${key}\` must be a string; got ${typeof value}.`);
+            }
+            if (STRIPE_EVIDENCE_FILE_FIELDS.has(key) && !value.startsWith('file_')) {
+                throw new Error(`[payments] Stripe's \`${key}\` evidence field takes a File upload id (\`file_…\`, created with purpose \`dispute_evidence\`), not \`${value}\`. Upload the document first and pass the id it returns.`);
+            }
+            put(key, value, '`metadata`');
+        }
+        if (Object.keys(fields).length === 0) {
+            throw new Error('[payments] Nothing to submit: the `DisputeEvidence` carried no field Stripe ' +
+                'accepts. Stripe takes ONE submission per dispute and forwards it to the issuer ' +
+                'immediately — an empty one spends it.');
+        }
+        return { fields: fields, submit };
+    }
+    /** A Checkout Session → the canonical payment payload, keyed on its PaymentIntent. */
+    #sessionData(object) {
+        const session = object;
+        const gatewayId = typeof session.payment_intent === 'string' ? session.payment_intent : undefined;
+        if (gatewayId === undefined ||
+            typeof session.amount_total !== 'number' ||
+            typeof session.currency !== 'string') {
+            return undefined;
+        }
+        const metadata = (session.metadata ?? {});
+        return {
+            gatewayId,
+            amount: session.amount_total,
+            currency: session.currency,
+            ...(typeof session.customer === 'string' ? { customerId: session.customer } : {}),
+            ...(typeof session.subscription === 'string' ? { subscriptionId: session.subscription } : {}),
+            ...(typeof metadata.external_reference === 'string'
+                ? { externalReference: metadata.external_reference }
+                : typeof session.client_reference_id === 'string'
+                    ? { externalReference: session.client_reference_id }
+                    : {}),
+        };
+    }
+    /** A Subscription → the canonical subscription payload. */
+    #subscriptionData(object) {
+        const subscription = object;
+        const customerId = typeof subscription.customer === 'string'
+            ? subscription.customer
+            : subscription.customer?.id;
+        if (typeof subscription.id !== 'string' || typeof customerId !== 'string')
+            return undefined;
+        const planId = subscription.items?.data?.[0]?.price?.id;
+        return {
+            gatewayId: subscription.id,
+            customerId,
+            status: this.#mapSubscriptionStatus(subscription.status),
+            ...(typeof planId === 'string' ? { planId } : {}),
+            ...(typeof subscription.trial_end === 'number'
+                ? { trialEndsAt: new Date(subscription.trial_end * 1000).toISOString() }
+                : {}),
+            ...(typeof subscription.ended_at === 'number'
+                ? { endsAt: new Date(subscription.ended_at * 1000).toISOString() }
+                : {}),
+        };
+    }
+    /**
+     * Canonical method → the Stripe `payment_method_types` entry that produces it. An
+     * unnamed (or unmappable) method leaves the intent on the account's dynamic payment
+     * methods, which is Stripe's own default rather than a silent substitution.
+     */
+    #mapMethodToStripe(method) {
+        switch (method) {
+            case 'pix':
+                return 'pix';
+            case 'boleto':
+                return 'boleto';
+            case 'credit_card':
+                return 'card';
+            default:
+                return undefined;
+        }
+    }
+    /**
+     * Stripe deduplicates on the `Idempotency-Key` request header, which the SDK takes as a
+     * request option — a key sent in the body retries into a second charge.
+     */
+    #requestOptions(idempotencyKey) {
+        return idempotencyKey !== undefined ? { idempotencyKey } : undefined;
+    }
+    /**
+     * A Stripe `payment_method_types` entry → the canonical {@link PaymentMethodType}.
+     *
+     * By category, never by brand: Stripe adds a local method most quarters, and a driver
+     * that enumerated iDEAL, BLIK, TWINT and the rest would go stale between releases while
+     * `PaymentMethodType` — a closed union — could never keep up. So SEPA and ACH are one
+     * answer (`bank_debit`, pulled from an account), iDEAL and Bancontact another
+     * (`bank_transfer`, pushed from a bank), and the brand stays readable on
+     * `payment.payload`.
+     *
+     * The type is read off `payment_method_types[0]`, which is the list of methods the
+     * intent ALLOWS. With one entry — what this driver sends whenever the charge names a
+     * `method` — it is exact; with the account's dynamic payment methods it is Stripe's own
+     * ordering, and the settled method is only known once `latest_charge` exists.
+     */
     #mapMethod(method) {
         switch (method) {
             case 'card':
+            case 'card_present':
                 return 'card';
             case 'pix':
                 return 'pix';
             case 'boleto':
                 return 'boleto';
+            // Pulled from an account you hold a mandate on.
+            case 'sepa_debit':
+            case 'us_bank_account':
+            case 'acss_debit':
+            case 'bacs_debit':
+            case 'au_becs_debit':
+                return 'bank_debit';
+            // Pushed from the payer's own bank, in their own banking app.
+            case 'ideal':
+            case 'bancontact':
+            case 'eps':
+            case 'p24':
+            case 'blik':
+            case 'multibanco':
+            case 'sofort':
+            case 'customer_balance':
+                return 'bank_transfer';
+            // Stored-balance and device wallets.
+            case 'link':
+            case 'paypal':
+            case 'wechat_pay':
+            case 'alipay':
+            case 'cashapp':
+            case 'revolut_pay':
+            case 'amazon_pay':
+            case 'twint':
+                return 'wallet';
+            case 'klarna':
+            case 'afterpay_clearpay':
+            case 'affirm':
+            case 'zip':
+                return 'bnpl';
+            // Paid in cash at a counter against a printed reference.
+            case 'oxxo':
+            case 'konbini':
+            case 'paysafecard':
+                return 'voucher';
             default:
                 return 'unknown';
         }