Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

Sandbox payout simulation, demo payment methods, environment banners

Kiran K7f58e9e63f54
diff --git a/apps/web/app/(ee)/api/cron/payouts/process/route.ts b/apps/web/app/(ee)/api/cron/payouts/process/route.ts
index f52d0d6dd2..ba07e6d283 100644
--- a/apps/web/app/(ee)/api/cron/payouts/process/route.ts
+++ b/apps/web/app/(ee)/api/cron/payouts/process/route.ts
@@ -1,6 +1,7 @@
import { handleAndReturnErrorResponse } from "@/lib/api/errors";
import { verifyQstashSignature } from "@/lib/cron/verify-qstash";
import { CUTOFF_PERIOD_ENUM } from "@/lib/partners/cutoff-period";
+import { mockSandboxPayoutCompletion } from "@/lib/sandbox/sandbox-payout";
import { prisma } from "@dub/prisma";
import { log } from "@dub/utils";
import * as z from "zod/v4";
@@ -89,16 +90,29 @@ export async function POST(req: Request) {
});
}
- await processPayouts({
- program,
- workspace,
- invoice,
- userId,
- paymentMethodId,
- cutoffPeriod,
- selectedPayoutIds,
- excludedPayoutIds,
- });
+ if (workspace.environment === "live") {
+ await processPayouts({
+ program,
+ workspace,
+ invoice,
+ userId,
+ paymentMethodId,
+ cutoffPeriod,
+ selectedPayoutIds,
+ excludedPayoutIds,
+ });
+ } else {
+ await mockSandboxPayoutCompletion({
+ workspace,
+ program,
+ invoice,
+ userId,
+ paymentMethodId,
+ cutoffPeriod,
+ selectedPayoutIds,
+ excludedPayoutIds,
+ });
+ }
return logAndRespond(`Processed payouts for program ${program.name}.`);
} catch (error) {
diff --git a/apps/web/app/(ee)/partners.dub.co/(apply)/[programSlug]/(default)/apply/success/page.tsx b/apps/web/app/(ee)/partners.dub.co/(apply)/[programSlug]/(default)/apply/success/page.tsx
index b4d02a1886..2a8e777bb7 100644
--- a/apps/web/app/(ee)/partners.dub.co/(apply)/[programSlug]/(default)/apply/success/page.tsx
+++ b/apps/web/app/(ee)/partners.dub.co/(apply)/[programSlug]/(default)/apply/success/page.tsx
@@ -1,5 +1,6 @@
import { getProgram } from "@/lib/fetchers/get-program";
import { DEFAULT_PARTNER_GROUP } from "@/lib/zod/schemas/groups";
+import { ProgramEnvironmentBanner } from "@/ui/layout/program-environment-banner";
import { prisma } from "@dub/prisma";
import { Logo } from "@dub/ui";
import { BoltFill, CursorRays, LinesY, MoneyBills2 } from "@dub/ui/icons";
@@ -48,9 +49,7 @@ export default async function SuccessPage(props: {
const { applicationId, enrollmentId } = searchParams;
- const params = await props.params;
-
- const { programSlug, groupSlug } = params;
+ const { programSlug, groupSlug } = await props.params;
const partnerGroupSlug = groupSlug ?? DEFAULT_PARTNER_GROUP.slug;
@@ -93,6 +92,7 @@ export default async function SuccessPage(props: {
} as CSSProperties
}
>
+ <ProgramEnvironmentBanner environment={program.workspace.environment} />
<ApplyHeader group={program.group} showLogin={false} showApply={false} />
<div className="p-6">
<div className="grid grid-cols-1 gap-5 sm:pt-20">
diff --git a/apps/web/app/api/workspaces/[idOrSlug]/billing/payment-methods/route.ts b/apps/web/app/api/workspaces/[idOrSlug]/billing/payment-methods/route.ts
index a0c84bce9a..3ea6c00e9a 100644
--- a/apps/web/app/api/workspaces/[idOrSlug]/billing/payment-methods/route.ts
+++ b/apps/web/app/api/workspaces/[idOrSlug]/billing/payment-methods/route.ts
@@ -19,6 +19,20 @@ const addPaymentMethodSchema = z.object({
// GET /api/workspaces/[idOrSlug]/billing/payment-methods - get all payment methods
export const GET = withWorkspace(
async ({ workspace }) => {
+ // send a demo value
+ if (workspace.environment !== "live") {
+ return NextResponse.json([
+ {
+ id: "pm_sandbox_card",
+ type: "card",
+ card: {
+ brand: "[DEMO] mastercard",
+ last4: "1234",
+ },
+ },
+ ]);
+ }
+
if (!workspace.stripeId) {
return NextResponse.json([]);
}
diff --git a/apps/web/lib/actions/partners/confirm-payouts.ts b/apps/web/lib/actions/partners/confirm-payouts.ts
index ee03605a4e..40ac6413f5 100644
--- a/apps/web/lib/actions/partners/confirm-payouts.ts
+++ b/apps/web/lib/actions/partners/confirm-payouts.ts
@@ -20,6 +20,7 @@ import { stripe } from "@/lib/stripe";
import { checkPaymentMethodMandate } from "@/lib/stripe/check-payment-method-mandate";
import { getWebhooks } from "@/lib/webhook/get-webhooks";
import { prisma } from "@dub/prisma";
+import { PaymentMethod } from "@dub/prisma/client";
import { APP_DOMAIN_WITH_NGROK } from "@dub/utils";
import * as z from "zod/v4";
import { authActionClient } from "../safe-action";
@@ -74,10 +75,6 @@ export const confirmPayoutsAction = authActionClient
requiredPermissions: ["payouts.write"],
});
- if (!workspace.stripeId) {
- throw new Error("Workspace does not have a valid Stripe ID.");
- }
-
if (fastSettlement && !workspace.fastDirectDebitPayouts) {
throw new Error(
"Fast settlement is not enabled for this program. Contact sales to enable it.",
@@ -151,37 +148,49 @@ export const confirmPayoutsAction = authActionClient
}
}
- const paymentMethod = await stripe.paymentMethods.retrieve(paymentMethodId);
+ let paymentMethod: PaymentMethod | null = null;
- if (paymentMethod.customer !== workspace.stripeId) {
- throw new Error("Invalid payout method.");
- }
-
- if (!PAYMENT_METHOD_TYPES.includes(paymentMethod.type)) {
- throw new Error(
- `We only support ${PAYMENT_METHOD_TYPES.join(
- ", ",
- )} for now. Please update your payout method to one of these.`,
- );
- }
+ if (workspace.environment === "live") {
+ if (!workspace.stripeId) {
+ throw new Error("Workspace does not have a valid Stripe ID.");
+ }
- if (fastSettlement && paymentMethod.type !== "us_bank_account") {
- throw new Error("Fast settlement is only supported for ACH payment.");
- }
+ const stripPaymentMethod =
+ await stripe.paymentMethods.retrieve(paymentMethodId);
- // if it's a direct debit payment method, we need to check to make sure mandate is valid
- if (DIRECT_DEBIT_PAYMENT_METHOD_TYPES.includes(paymentMethod.type)) {
- const mandate = await checkPaymentMethodMandate({
- paymentMethodId,
- });
+ if (stripPaymentMethod.customer !== workspace.stripeId) {
+ throw new Error("Invalid payout method.");
+ }
- if (!mandate) {
- // if mandate is not valid, remove the payment method
- await stripe.paymentMethods.detach(paymentMethodId);
+ if (!PAYMENT_METHOD_TYPES.includes(stripPaymentMethod.type)) {
throw new Error(
- "No active mandate found for this bank account. Please set up a new bank account for payouts under your billing settings page.",
+ `We only support ${PAYMENT_METHOD_TYPES.join(
+ ", ",
+ )} for now. Please update your payout method to one of these.`,
);
}
+
+ if (fastSettlement && stripPaymentMethod.type !== "us_bank_account") {
+ throw new Error("Fast settlement is only supported for ACH payment.");
+ }
+
+ // if it's a direct debit payment method, we need to check to make sure mandate is valid
+ if (DIRECT_DEBIT_PAYMENT_METHOD_TYPES.includes(stripPaymentMethod.type)) {
+ const mandate = await checkPaymentMethodMandate({
+ paymentMethodId,
+ });
+
+ if (!mandate) {
+ // if mandate is not valid, remove the payment method
+ await stripe.paymentMethods.detach(paymentMethodId);
+ throw new Error(
+ "No active mandate found for this bank account. Please set up a new bank account for payouts under your billing settings page.",
+ );
+ }
+ }
+
+ paymentMethod =
+ STRIPE_PAYMENT_METHOD_NORMALIZATION[stripPaymentMethod.type];
}
const invoice = await prisma.$transaction(async (tx) => {
@@ -207,9 +216,7 @@ export const confirmPayoutsAction = authActionClient
amount,
fee,
total,
- paymentMethod: fastSettlement
- ? "ach_fast"
- : STRIPE_PAYMENT_METHOD_NORMALIZATION[paymentMethod.type],
+ paymentMethod: fastSettlement ? "ach_fast" : paymentMethod,
payoutMode: program.payoutMode,
},
});
diff --git a/apps/web/lib/sandbox/sandbox-payout.ts b/apps/web/lib/sandbox/sandbox-payout.ts
new file mode 100644
index 0000000000..8ba8de0a46
--- /dev/null
+++ b/apps/web/lib/sandbox/sandbox-payout.ts
@@ -0,0 +1,212 @@
+import { getPayoutEligibilityFilter } from "@/lib/api/payouts/payout-eligibility-filter";
+import { payoutIdSelectionWhere } from "@/lib/api/payouts/payout-id-selection-where";
+import {
+ CUTOFF_PERIOD,
+ CUTOFF_PERIOD_TYPES,
+} from "@/lib/partners/cutoff-period";
+import { sendBatchEmail } from "@dub/email";
+import PartnerPayoutConfirmed from "@dub/email/templates/partner-payout-confirmed";
+import { prisma } from "@dub/prisma";
+import {
+ Invoice,
+ Program,
+ ProgramPayoutMode,
+ Project,
+} from "@dub/prisma/client";
+import { currencyFormatter } from "@dub/utils";
+import { addSeconds } from "date-fns";
+import { calculatePayoutFeeWithWaiver } from "../partners/calculate-payout-fee-with-waiver";
+import { calculatePayoutFeeForMethod } from "../stripe/payment-methods";
+
+interface ProcessPayoutsProps {
+ workspace: Pick<
+ Project,
+ | "id"
+ | "slug"
+ | "stripeId"
+ | "plan"
+ | "invoicePrefix"
+ | "payoutsUsage"
+ | "payoutsLimit"
+ | "payoutFee"
+ | "payoutFeeWaiverLimit"
+ | "payoutFeeWaiverUsage"
+ | "webhookEnabled"
+ >;
+ program: Pick<
+ Program,
+ "id" | "name" | "logo" | "url" | "minPayoutAmount" | "supportEmail"
+ > & {
+ payoutMode: ProgramPayoutMode;
+ };
+ invoice: Pick<Invoice, "id" | "paymentMethod">;
+ userId: string;
+ paymentMethodId: string;
+ cutoffPeriod?: CUTOFF_PERIOD_TYPES;
+ selectedPayoutIds?: string[];
+ excludedPayoutIds?: string[];
+}
+
+export async function mockSandboxPayoutCompletion({
+ workspace,
+ program,
+ invoice,
+ userId,
+ cutoffPeriod,
+ selectedPayoutIds,
+ excludedPayoutIds,
+}: ProcessPayoutsProps) {
+ const cutoffPeriodValue = CUTOFF_PERIOD.find(
+ (c) => c.id === cutoffPeriod,
+ )?.value;
+
+ await prisma.$executeRaw`
+ UPDATE Payout p
+ INNER JOIN Partner pn ON p.partnerId = pn.id
+ SET p.method = pn.defaultPayoutMethod
+ WHERE p.invoiceId = ${invoice.id}
+ AND pn.defaultPayoutMethod IS NOT NULL
+ AND p.status = 'processing'
+ `;
+
+ await prisma.payout.updateMany({
+ where: {
+ ...payoutIdSelectionWhere({ selectedPayoutIds, excludedPayoutIds }),
+ ...getPayoutEligibilityFilter({ program, workspace }),
+ ...(cutoffPeriodValue && {
+ periodEnd: {
+ lte: cutoffPeriodValue,
+ },
+ }),
+ },
+ data: {
+ invoiceId: invoice.id,
+ status: "completed",
+ userId,
+ initiatedAt: new Date(),
+ paidAt: addSeconds(new Date(), 5),
+ mode: program.payoutMode === "external" ? "external" : "internal",
+ },
+ });
+
+ if (program.payoutMode === "hybrid") {
+ await prisma.payout.updateMany({
+ where: {
+ invoiceId: invoice.id,
+ partner: {
+ payoutsEnabledAt: null,
+ },
+ },
+ data: {
+ mode: "external",
+ },
+ });
+ }
+
+ const payoutsByMode = await prisma.payout.groupBy({
+ by: ["mode"],
+ where: {
+ invoiceId: invoice.id,
+ },
+ _sum: {
+ amount: true,
+ },
+ });
+
+ const totalInternalPayoutAmount =
+ payoutsByMode.find((p) => p.mode === "internal")?._sum.amount ?? 0;
+ const totalExternalPayoutAmount =
+ payoutsByMode.find((p) => p.mode === "external")?._sum.amount ?? 0;
+ const totalPayoutAmount =
+ totalInternalPayoutAmount + totalExternalPayoutAmount;
+
+ const payoutFee = calculatePayoutFeeForMethod({
+ paymentMethod: "us_bank_account",
+ payoutFee: workspace.payoutFee,
+ });
+
+ if (!payoutFee) {
+ throw new Error("Failed to calculate payout fee.");
+ }
+
+ const { fee: invoiceFee } = calculatePayoutFeeWithWaiver({
+ payoutAmount: totalPayoutAmount,
+ payoutFee,
+ payoutFeeWaiverLimit: workspace.payoutFeeWaiverLimit,
+ payoutFeeWaiverUsage: workspace.payoutFeeWaiverUsage,
+ });
+
+ await prisma.$transaction([
+ prisma.invoice.update({
+ where: {
+ id: invoice.id,
+ },
+ data: {
+ amount: totalPayoutAmount,
+ externalAmount: totalExternalPayoutAmount,
+ fee: invoiceFee,
+ total: totalPayoutAmount + invoiceFee,
+ status: "completed",
+ paidAt: new Date(),
+ },
+ }),
+
+ prisma.commission.updateMany({
+ where: {
+ payout: {
+ invoiceId: invoice.id,
+ },
+ },
+ data: {
+ status: "paid",
+ },
+ }),
+ ]);
+
+ const payouts = await prisma.payout.findMany({
+ where: {
+ invoiceId: invoice.id,
+ },
+ include: {
+ partner: true,
+ program: true,
+ },
+ orderBy: {
+ id: "asc",
+ },
+ });
+
+ const internalPayouts = payouts.filter(
+ (payout) => payout.mode === "internal",
+ );
+
+ await sendBatchEmail(
+ internalPayouts.map((payout) => ({
+ to: payout.partner.email!,
+ subject: `Your ${currencyFormatter(payout.amount)} payout for ${payout.program.name} is on the way`,
+ variant: "notifications",
+ replyTo: payout.program.supportEmail || "noreply",
+ react: PartnerPayoutConfirmed({
+ email: payout.partner.email!,
+ program: {
+ id: payout.program.id,
+ name: payout.program.name,
+ logo: payout.program.logo,
+ },
+ payout: {
+ id: payout.id,
+ amount: payout.amount,
+ initiatedAt: payout.initiatedAt,
+ startDate: payout.periodStart,
+ endDate: payout.periodEnd,
+ mode: payout.mode,
+ paymentMethod: invoice.paymentMethod ?? "ach",
+ payoutMethod: payout.partner.defaultPayoutMethod ?? null,
+ },
+ }),
+ })),
+ );
+
+ // TODO:
+ // Should we track the commission/payout status updates?
+}
diff --git a/apps/web/ui/layout/program-environment-banner.tsx b/apps/web/ui/layout/program-environment-banner.tsx
index 20484eb7f4..472adcb9d1 100644
--- a/apps/web/ui/layout/program-environment-banner.tsx
+++ b/apps/web/ui/layout/program-environment-banner.tsx
@@ -14,7 +14,7 @@ export function ProgramEnvironmentBanner({
return (
<div
className={cn(
- "fixed left-0 right-0 top-0 z-50 flex h-8 items-center justify-between gap-4 overflow-hidden bg-amber-200 px-4 py-1.5 text-neutral-800",
+ "fixed left-0 right-0 top-0 z-50 flex h-12 items-center justify-between gap-4 overflow-hidden bg-amber-200 px-6 text-neutral-800",
)}
>
<div className="flex shrink-0 items-center gap-2">
diff --git a/apps/web/ui/layout/workspace-environment-banner.tsx b/apps/web/ui/layout/workspace-environment-banner.tsx
index 62f13a6a8f..b28b5d654f 100644
--- a/apps/web/ui/layout/workspace-environment-banner.tsx
+++ b/apps/web/ui/layout/workspace-environment-banner.tsx
@@ -26,7 +26,7 @@ export function WorkspaceEnvironmentBanner() {
initial={{ transform: "translateY(-100%)" }}
animate={{ transform: "translateY(0)" }}
className={cn(
- "fixed left-0 right-0 top-0 z-50 flex items-center justify-between gap-4 overflow-hidden bg-amber-200 px-4 py-1.5 text-neutral-800",
+ "fixed left-0 right-0 top-0 z-30 flex h-12 items-center justify-between gap-4 overflow-hidden bg-amber-200 px-6 text-neutral-800",
)}
>
<div className="flex min-w-0 shrink-0 items-center gap-2">