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.

Unify sandbox payout processing with mock payment provider

Kiran Ke77c27ed22bf
diff --git a/apps/web/app/(ee)/api/cron/payouts/process/process-payouts.ts b/apps/web/app/(ee)/api/cron/payouts/process/process-payouts.ts
index ea16b427ca..4b4b7b7c3e 100644
--- a/apps/web/app/(ee)/api/cron/payouts/process/process-payouts.ts
+++ b/apps/web/app/(ee)/api/cron/payouts/process/process-payouts.ts
@@ -7,6 +7,7 @@ import {
CUTOFF_PERIOD,
CUTOFF_PERIOD_TYPES,
} from "@/lib/partners/cutoff-period";
+import { mockPaymentProvider } from "@/lib/sandbox/mock-payment-provider";
import { stripe } from "@/lib/stripe";
import { createFxQuote } from "@/lib/stripe/create-fx-quote";
import { calculatePayoutFeeForMethod } from "@/lib/stripe/payment-methods";
@@ -46,6 +47,7 @@ interface ProcessPayoutsProps {
| "payoutFeeWaiverLimit"
| "payoutFeeWaiverUsage"
| "webhookEnabled"
+ | "environment"
>;
program: Pick<
Program,
@@ -71,6 +73,8 @@ export async function processPayouts({
selectedPayoutIds,
excludedPayoutIds,
}: ProcessPayoutsProps) {
+ const isProductionWorkspace = workspace.environment === "production";
+
const cutoffPeriodValue = CUTOFF_PERIOD.find(
(c) => c.id === cutoffPeriod,
)?.value;
@@ -140,7 +144,9 @@ export async function processPayouts({
const totalPayoutAmount =
totalInternalPayoutAmount + totalExternalPayoutAmount;
- const paymentMethod = await stripe.paymentMethods.retrieve(paymentMethodId);
+ const paymentMethod = isProductionWorkspace
+ ? await stripe.paymentMethods.retrieve(paymentMethodId)
+ : await mockPaymentProvider.retrievePaymentMethod(paymentMethodId);
const payoutFee = calculatePayoutFeeForMethod({
paymentMethod: paymentMethod.type,
@@ -223,33 +229,35 @@ export async function processPayouts({
totalToCharge = convertedTotal;
}
- await stripe.paymentIntents.create(
- {
- amount: totalToCharge,
- customer: workspace.stripeId!,
- payment_method_types: [paymentMethod.type],
- payment_method: paymentMethod.id,
- ...(paymentMethod.type === "us_bank_account" && {
- payment_method_options: {
- us_bank_account: {
- preferred_settlement_speed:
- invoice.paymentMethod === "ach_fast" ? "fastest" : "standard",
+ if (isProductionWorkspace) {
+ await stripe.paymentIntents.create(
+ {
+ amount: totalToCharge,
+ customer: workspace.stripeId!,
+ payment_method_types: [paymentMethod.type],
+ payment_method: paymentMethod.id,
+ ...(paymentMethod.type === "us_bank_account" && {
+ payment_method_options: {
+ us_bank_account: {
+ preferred_settlement_speed:
+ invoice.paymentMethod === "ach_fast" ? "fastest" : "standard",
+ },
},
- },
- }),
- currency,
- confirmation_method: "automatic",
- confirm: true,
- transfer_group: invoice.id,
- ...(paymentMethod.type === "card"
- ? { statement_descriptor_suffix: "Dub Partners" }
- : { statement_descriptor: "Dub Partners" }),
- description: `Dub Partners payout invoice (${invoice.id})`,
- },
- {
- idempotencyKey: `process-payout-invoice/${invoice.id}`,
- },
- );
+ }),
+ currency,
+ confirmation_method: "automatic",
+ confirm: true,
+ transfer_group: invoice.id,
+ ...(paymentMethod.type === "card"
+ ? { statement_descriptor_suffix: "Dub Partners" }
+ : { statement_descriptor: "Dub Partners" }),
+ description: `Dub Partners payout invoice (${invoice.id})`,
+ },
+ {
+ idempotencyKey: `process-payout-invoice/${invoice.id}`,
+ },
+ );
+ }
const { users } = await prisma.project.update({
where: {
@@ -279,10 +287,12 @@ export async function processPayouts({
},
});
- await log({
- message: `<${program.url}|*${program.name}*> (\`${workspace.slug}\`) just sent a payout of *${currencyFormatter(totalPayoutAmount)}* :money_with_wings: \n\n Fees earned: *${currencyFormatter(invoiceFee)} (${payoutFee * 100}%)* :money_mouth_face:`,
- type: "payouts",
- });
+ if (isProductionWorkspace) {
+ await log({
+ message: `<${program.url}|*${program.name}*> (\`${workspace.slug}\`) just sent a payout of *${currencyFormatter(totalPayoutAmount)}* :money_with_wings: \n\n Fees earned: *${currencyFormatter(invoiceFee)} (${payoutFee * 100}%)* :money_mouth_face:`,
+ type: "payouts",
+ });
+ }
const qstashResponse = await qstash.publishJSON({
url: `${APP_DOMAIN_WITH_NGROK}/api/cron/payouts/process/updates`,
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 786ae9ff3d..f52d0d6dd2 100644
--- a/apps/web/app/(ee)/api/cron/payouts/process/route.ts
+++ b/apps/web/app/(ee)/api/cron/payouts/process/route.ts
@@ -1,9 +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 { WorkspaceEnvironment } from "@dub/prisma/client";
import { log } from "@dub/utils";
import * as z from "zod/v4";
import { logAndRespond } from "../../utils";
@@ -91,29 +89,16 @@ export async function POST(req: Request) {
});
}
- if (workspace.environment === WorkspaceEnvironment.production) {
- await processPayouts({
- program,
- workspace,
- invoice,
- userId,
- paymentMethodId,
- cutoffPeriod,
- selectedPayoutIds,
- excludedPayoutIds,
- });
- } else {
- await mockSandboxPayoutCompletion({
- workspace,
- program,
- invoice,
- userId,
- paymentMethodId,
- cutoffPeriod,
- selectedPayoutIds,
- excludedPayoutIds,
- });
- }
+ await processPayouts({
+ program,
+ workspace,
+ invoice,
+ userId,
+ paymentMethodId,
+ cutoffPeriod,
+ selectedPayoutIds,
+ excludedPayoutIds,
+ });
return logAndRespond(`Processed payouts for program ${program.name}.`);
} catch (error) {
diff --git a/apps/web/app/(ee)/api/cron/payouts/process/updates/route.ts b/apps/web/app/(ee)/api/cron/payouts/process/updates/route.ts
index d275ac98d3..ee560e0900 100644
--- a/apps/web/app/(ee)/api/cron/payouts/process/updates/route.ts
+++ b/apps/web/app/(ee)/api/cron/payouts/process/updates/route.ts
@@ -80,7 +80,9 @@ export async function POST(req: Request) {
};
}),
);
- console.log(JSON.stringify({ auditLogResponse }, null, 2));
+
+ // TODO
+ // Add banner to the email
const invoice = payouts[0].invoice;
const internalPayouts = payouts.filter(
diff --git a/apps/web/lib/actions/partners/confirm-payouts.ts b/apps/web/lib/actions/partners/confirm-payouts.ts
index 08e632452e..b9c8c61a93 100644
--- a/apps/web/lib/actions/partners/confirm-payouts.ts
+++ b/apps/web/lib/actions/partners/confirm-payouts.ts
@@ -16,11 +16,12 @@ import {
import { qstash } from "@/lib/cron";
import { exceededLimitError } from "@/lib/exceeded-limit-error";
import { CUTOFF_PERIOD_ENUM } from "@/lib/partners/cutoff-period";
+import { mockPaymentProvider } from "@/lib/sandbox/mock-payment-provider";
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, WorkspaceEnvironment } from "@dub/prisma/client";
+import { WorkspaceEnvironment } from "@dub/prisma/client";
import { APP_DOMAIN_WITH_NGROK } from "@dub/utils";
import * as z from "zod/v4";
import { authActionClient } from "../safe-action";
@@ -63,6 +64,9 @@ export const confirmPayoutsAction = authActionClient
total,
} = parsedInput;
+ const isProductionWorkspace =
+ workspace.environment === WorkspaceEnvironment.production;
+
const programId = getDefaultProgramIdOrThrow(workspace);
const program = await getProgramOrThrow({
@@ -75,6 +79,10 @@ export const confirmPayoutsAction = authActionClient
requiredPermissions: ["payouts.write"],
});
+ if (isProductionWorkspace && !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.",
@@ -148,49 +156,45 @@ export const confirmPayoutsAction = authActionClient
}
}
- let paymentMethod: PaymentMethod | null = null;
+ const paymentMethod = isProductionWorkspace
+ ? await stripe.paymentMethods.retrieve(paymentMethodId)
+ : await mockPaymentProvider.retrievePaymentMethod(paymentMethodId);
- if (workspace.environment === WorkspaceEnvironment.production) {
- if (!workspace.stripeId) {
- throw new Error("Workspace does not have a valid Stripe ID.");
- }
+ if (
+ isProductionWorkspace &&
+ paymentMethod.customer !== workspace.stripeId
+ ) {
+ throw new Error("Invalid payout method.");
+ }
- const stripPaymentMethod =
- await stripe.paymentMethods.retrieve(paymentMethodId);
+ 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 (stripPaymentMethod.customer !== workspace.stripeId) {
- throw new Error("Invalid payout method.");
- }
+ if (fastSettlement && paymentMethod.type !== "us_bank_account") {
+ throw new Error("Fast settlement is only supported for ACH payment.");
+ }
- if (!PAYMENT_METHOD_TYPES.includes(stripPaymentMethod.type)) {
+ // if it's a direct debit payment method, we need to check to make sure mandate is valid
+ if (
+ isProductionWorkspace &&
+ DIRECT_DEBIT_PAYMENT_METHOD_TYPES.includes(paymentMethod.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(
- `We only support ${PAYMENT_METHOD_TYPES.join(
- ", ",
- )} for now. Please update your payout method to one of these.`,
+ "No active mandate found for this bank account. Please set up a new bank account for payouts under your billing settings page.",
);
}
-
- 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) => {
@@ -216,7 +220,9 @@ export const confirmPayoutsAction = authActionClient
amount,
fee,
total,
- paymentMethod: fastSettlement ? "ach_fast" : paymentMethod,
+ paymentMethod: fastSettlement
+ ? "ach_fast"
+ : STRIPE_PAYMENT_METHOD_NORMALIZATION[paymentMethod.type],
payoutMode: program.payoutMode,
},
});
diff --git a/apps/web/lib/sandbox/mock-payment-provider.ts b/apps/web/lib/sandbox/mock-payment-provider.ts
new file mode 100644
index 0000000000..87d232335c
--- /dev/null
+++ b/apps/web/lib/sandbox/mock-payment-provider.ts
@@ -0,0 +1,11 @@
+class MockPaymentProvider {
+ async retrievePaymentMethod(id: string) {
+ return Promise.resolve({
+ id,
+ type: "us_bank_account" as const,
+ customer: "cus_mock_123",
+ });
+ }
+}
+
+export const mockPaymentProvider = new MockPaymentProvider();
diff --git a/apps/web/lib/sandbox/sandbox-payout.ts b/apps/web/lib/sandbox/sandbox-payout.ts
deleted file mode 100644
index 8ba8de0a46..0000000000
--- a/apps/web/lib/sandbox/sandbox-payout.ts
+++ /dev/null
@@ -1,212 +0,0 @@
-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?
-}