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.

More payouts improvements (#3287)

Steven Teydb484e7ec450
diff --git a/apps/web/app/(ee)/api/cron/payouts/balance-available/route.ts b/apps/web/app/(ee)/api/cron/payouts/balance-available/route.ts
index 06c4d90f81..0063127bda 100644
--- a/apps/web/app/(ee)/api/cron/payouts/balance-available/route.ts
+++ b/apps/web/app/(ee)/api/cron/payouts/balance-available/route.ts
@@ -1,8 +1,11 @@
import { handleAndReturnErrorResponse } from "@/lib/api/errors";
+import { BANK_ACCOUNT_STATUS_DESCRIPTIONS } from "@/lib/constants/payouts";
import { qstash } from "@/lib/cron";
import { verifyQstashSignature } from "@/lib/cron/verify-qstash";
+import { getPartnerBankAccount } from "@/lib/partners/get-partner-bank-account";
import { stripe } from "@/lib/stripe";
import { sendEmail } from "@dub/email";
+import PartnerPayoutWithdrawalFailed from "@dub/email/templates/partner-payout-withdrawal-failed";
import PartnerPayoutWithdrawalInitiated from "@dub/email/templates/partner-payout-withdrawal-initiated";
import { prisma } from "@dub/prisma";
import {
@@ -10,6 +13,7 @@ import {
currencyFormatter,
formatDate,
log,
+ prettyPrint,
} from "@dub/utils";
import { z } from "zod";
import { logAndRespond } from "../../utils";
@@ -53,10 +57,7 @@ export async function POST(req: Request) {
if (balance.available.length === 0) {
// should never happen, but just in case
return logAndRespond(
- `Partner ${partner.email} (${stripeAccount}) has no available balance. Skipping...`,
- {
- logLevel: "error",
- },
+ `Partner ${partner.email} (${stripeAccount}) has no available balances. Skipping...`,
);
}
@@ -89,6 +90,44 @@ export async function POST(req: Request) {
);
}
+ const bankAccount = await getPartnerBankAccount(stripeAccount);
+
+ const statusInfo = bankAccount
+ ? BANK_ACCOUNT_STATUS_DESCRIPTIONS[bankAccount.status]
+ : // edge case for cases where the partner doesn't have a bank account on file at all
+ {
+ title: "No bank account",
+ description: "This partner does not have an active bank account.",
+ variant: "invalid",
+ };
+
+ if (statusInfo.variant === "invalid") {
+ if (partner.email) {
+ const sentEmail = await sendEmail({
+ variant: "notifications",
+ subject:
+ "[Action Required]: Update your bank account details to receive payouts",
+ to: partner.email,
+ react: PartnerPayoutWithdrawalFailed({
+ email: partner.email,
+ bankAccount,
+ payout: {
+ amount: availableBalance,
+ currency,
+ failureReason: statusInfo.description,
+ isAvailableBalance: true,
+ },
+ }),
+ });
+ console.log(
+ `Sent email to partner ${partner.email} (${stripeAccount}): ${prettyPrint(sentEmail)}`,
+ );
+ }
+ return logAndRespond(
+ `Partner ${partner.email} (${stripeAccount}) has an errored bank account. Skipping...`,
+ );
+ }
+
if (["huf", "twd"].includes(currency)) {
// For HUF and TWD, Stripe requires payout amounts to be evenly divisible by 100
// We need to round down to the nearest 100 units
diff --git a/apps/web/app/(ee)/api/cron/payouts/payout-failed/route.ts b/apps/web/app/(ee)/api/cron/payouts/payout-failed/route.ts
index 891b147e03..d388fb01ae 100644
--- a/apps/web/app/(ee)/api/cron/payouts/payout-failed/route.ts
+++ b/apps/web/app/(ee)/api/cron/payouts/payout-failed/route.ts
@@ -1,5 +1,6 @@
import { handleAndReturnErrorResponse } from "@/lib/api/errors";
import { verifyQstashSignature } from "@/lib/cron/verify-qstash";
+import { getPartnerBankAccount } from "@/lib/partners/get-partner-bank-account";
import { sendEmail } from "@dub/email";
import PartnerPayoutWithdrawalFailed from "@dub/email/templates/partner-payout-withdrawal-failed";
import { prisma } from "@dub/prisma";
@@ -53,6 +54,8 @@ export async function POST(req: Request) {
});
if (partner.email) {
+ const bankAccount = await getPartnerBankAccount(stripeAccount);
+
const sentEmail = await sendEmail({
variant: "notifications",
subject:
@@ -60,6 +63,7 @@ export async function POST(req: Request) {
to: partner.email,
react: PartnerPayoutWithdrawalFailed({
email: partner.email,
+ bankAccount,
payout: {
amount: stripePayout.amount,
currency: stripePayout.currency,
diff --git a/apps/web/app/(ee)/api/partner-profile/payouts/settings/route.ts b/apps/web/app/(ee)/api/partner-profile/payouts/settings/route.ts
index 8ef7fdc4d5..f81e33ab75 100644
--- a/apps/web/app/(ee)/api/partner-profile/payouts/settings/route.ts
+++ b/apps/web/app/(ee)/api/partner-profile/payouts/settings/route.ts
@@ -1,15 +1,6 @@
import { withPartnerProfile } from "@/lib/auth/partner";
-import { stripe } from "@/lib/stripe";
+import { getPartnerBankAccount } from "@/lib/partners/get-partner-bank-account";
import { NextResponse } from "next/server";
-import { z } from "zod";
-
-const response = z
- .object({
- bank_name: z.string(),
- routing_number: z.string(),
- last4: z.string(),
- })
- .nullable();
// GET /api/partner-profile/payouts/settings
export const GET = withPartnerProfile(async ({ partner }) => {
@@ -17,17 +8,7 @@ export const GET = withPartnerProfile(async ({ partner }) => {
return NextResponse.json({});
}
- const externalAccounts = await stripe.accounts.listExternalAccounts(
- partner.stripeConnectId,
- {
- object: "bank_account",
- },
- );
-
- const bankAccounts =
- externalAccounts.data.length > 0
- ? response.parse(externalAccounts.data[0])
- : {};
+ const bankAccount = await getPartnerBankAccount(partner.stripeConnectId);
- return NextResponse.json(bankAccounts);
+ return NextResponse.json(bankAccount);
});
diff --git a/apps/web/app/(ee)/api/stripe/connect/webhook/account-application-deauthorized.ts b/apps/web/app/(ee)/api/stripe/connect/webhook/account-application-deauthorized.ts
index 77feb91d24..ed6708c0d3 100644
--- a/apps/web/app/(ee)/api/stripe/connect/webhook/account-application-deauthorized.ts
+++ b/apps/web/app/(ee)/api/stripe/connect/webhook/account-application-deauthorized.ts
@@ -1,3 +1,4 @@
+import { stripe } from "@/lib/stripe";
import { prisma } from "@dub/prisma";
import type Stripe from "stripe";
@@ -18,15 +19,23 @@ export async function accountApplicationDeauthorized(event: Stripe.Event) {
return `Partner with stripeConnectId ${stripeAccount} not found, skipping...`;
}
+ const stripeAccountData = await stripe.accounts.retrieve(stripeAccount);
+ if (stripeAccountData.deleted) {
+ console.log(
+ `Connected account ${stripeAccount} deauthorized, will set stripeConnectId for partner ${partner.id} to null as well`,
+ );
+ }
+
await prisma.partner.update({
where: {
id: partner.id,
},
data: {
+ stripeConnectId: stripeAccountData.deleted ? null : undefined,
payoutsEnabledAt: null,
payoutMethodHash: null,
},
});
- return `Connected account deauthorized, updated partner ${partner.email} (${partner.stripeConnectId}) with payoutsEnabledAt and payoutMethodHash null`;
+ return `Connected account ${stripeAccount} deauthorized, updated partner ${partner.email} (${partner.id})`;
}
diff --git a/apps/web/app/(ee)/api/stripe/connect/webhook/account-updated.ts b/apps/web/app/(ee)/api/stripe/connect/webhook/account-updated.ts
index 80d9406af4..4bc79dd031 100644
--- a/apps/web/app/(ee)/api/stripe/connect/webhook/account-updated.ts
+++ b/apps/web/app/(ee)/api/stripe/connect/webhook/account-updated.ts
@@ -1,11 +1,11 @@
import { detectDuplicatePayoutMethodFraud } from "@/lib/api/fraud/detect-duplicate-payout-method-fraud";
import { qstash } from "@/lib/cron";
-import { stripe } from "@/lib/stripe";
+import { getPartnerBankAccount } from "@/lib/partners/get-partner-bank-account";
import { sendEmail } from "@dub/email";
import ConnectedPayoutMethod from "@dub/email/templates/connected-payout-method";
import DuplicatePayoutMethod from "@dub/email/templates/duplicate-payout-method";
import { prisma } from "@dub/prisma";
-import { APP_DOMAIN_WITH_NGROK, log } from "@dub/utils";
+import { APP_DOMAIN_WITH_NGROK } from "@dub/utils";
import Stripe from "stripe";
const queue = qstash.queue({
@@ -45,26 +45,17 @@ export async function accountUpdated(event: Stripe.Event) {
payoutMethodHash: null,
},
});
+ // TODO: notify partner about the change
return `Payouts disabled, updated partner ${partner.email} (${partner.stripeConnectId}) with payoutsEnabledAt and payoutMethodHash null`;
}
return `No change in payout status for ${partner.email} (${partner.stripeConnectId}), skipping...`;
}
- const { data: externalAccounts } = await stripe.accounts.listExternalAccounts(
- partner.stripeConnectId!,
- );
+ const bankAccount = await getPartnerBankAccount(partner.stripeConnectId!);
- const defaultExternalAccount = externalAccounts.find(
- (account) => account.default_for_currency,
- );
-
- if (!defaultExternalAccount) {
- // this should never happen, but just in case
- await log({
- message: `Expected at least 1 external account for partner ${partner.email} (${partner.stripeConnectId}), none found`,
- type: "errors",
- });
- return `Expected at least 1 external account for partner ${partner.email} (${partner.stripeConnectId}), none found`;
+ if (!bankAccount) {
+ // TODO: account for cases where partner connects a debit card instead
+ return `No bank account found for partner ${partner.email} (${partner.stripeConnectId}), skipping...`;
}
const { payoutMethodHash } = await prisma.partner.update({
@@ -76,7 +67,7 @@ export async function accountUpdated(event: Stripe.Event) {
payoutsEnabledAt: partner.payoutsEnabledAt
? undefined // Don't update if already set
: new Date(),
- payoutMethodHash: defaultExternalAccount.fingerprint,
+ payoutMethodHash: bankAccount.fingerprint,
},
});
@@ -98,8 +89,7 @@ export async function accountUpdated(event: Stripe.Event) {
if (
duplicatePartnersCount === 0 &&
partner.email &&
- !partner.payoutsEnabledAt &&
- defaultExternalAccount.object === "bank_account"
+ !partner.payoutsEnabledAt
) {
await sendEmail({
variant: "notifications",
@@ -107,34 +97,20 @@ export async function accountUpdated(event: Stripe.Event) {
to: partner.email,
react: ConnectedPayoutMethod({
email: partner.email,
- payoutMethod: {
- account_holder_name: defaultExternalAccount.account_holder_name,
- bank_name: defaultExternalAccount.bank_name,
- last4: defaultExternalAccount.last4,
- routing_number: defaultExternalAccount.routing_number,
- },
+ payoutMethod: bankAccount,
}),
});
}
// Notify the partner about duplicate payout method
- if (
- duplicatePartnersCount > 0 &&
- partner.email &&
- defaultExternalAccount.object === "bank_account"
- ) {
+ if (duplicatePartnersCount > 0 && partner.email) {
await sendEmail({
variant: "notifications",
subject: "Duplicate payout method detected",
to: partner.email,
react: DuplicatePayoutMethod({
email: partner.email,
- payoutMethod: {
- account_holder_name: defaultExternalAccount.account_holder_name,
- bank_name: defaultExternalAccount.bank_name,
- last4: defaultExternalAccount.last4,
- routing_number: defaultExternalAccount.routing_number,
- },
+ payoutMethod: bankAccount,
}),
});
}
@@ -151,7 +127,7 @@ export async function accountUpdated(event: Stripe.Event) {
});
if (pendingPayouts > 0) {
- await queue.enqueueJSON({
+ const response = await queue.enqueueJSON({
url: `${APP_DOMAIN_WITH_NGROK}/api/cron/payouts/balance-available`,
deduplicationId: event.id,
method: "POST",
@@ -159,7 +135,8 @@ export async function accountUpdated(event: Stripe.Event) {
stripeAccount: partner.stripeConnectId,
},
});
+ return `Enqueued handle-balance-available queue for partner ${partner.stripeConnectId}: ${response.messageId}`;
}
- return `Updated partner ${partner.email} (${partner.stripeConnectId}) with country ${country}, payoutsEnabledAt set, payoutMethodHash ${defaultExternalAccount.fingerprint}`;
+ return `Updated partner ${partner.email} (${partner.stripeConnectId}) with country ${country}, payoutsEnabledAt set, payoutMethodHash ${bankAccount.fingerprint}`;
}
diff --git a/apps/web/app/(ee)/api/stripe/connect/webhook/balance-available.ts b/apps/web/app/(ee)/api/stripe/connect/webhook/balance-available.ts
index ce985c5dd0..3eade9c9dc 100644
--- a/apps/web/app/(ee)/api/stripe/connect/webhook/balance-available.ts
+++ b/apps/web/app/(ee)/api/stripe/connect/webhook/balance-available.ts
@@ -22,5 +22,5 @@ export async function balanceAvailable(event: Stripe.Event) {
},
});
- return `Enqueued balance available for partner ${stripeAccount}: ${response.messageId}`;
+ return `Enqueued handle-balance-available queue for partner ${stripeAccount}: ${response.messageId}`;
}
diff --git a/apps/web/app/(ee)/api/stripe/connect/webhook/route.ts b/apps/web/app/(ee)/api/stripe/connect/webhook/route.ts
index 7c4e6a87b3..2ba0d48217 100644
--- a/apps/web/app/(ee)/api/stripe/connect/webhook/route.ts
+++ b/apps/web/app/(ee)/api/stripe/connect/webhook/route.ts
@@ -10,6 +10,7 @@ import { payoutPaid } from "./payout-paid";
const relevantEvents = new Set([
"account.application.deauthorized",
+ "account.external_account.updated",
"account.updated",
"balance.available",
"payout.paid",
@@ -49,6 +50,7 @@ export const POST = async (req: Request) => {
case "account.updated":
response = await accountUpdated(event);
break;
+ case "account.external_account.updated":
case "balance.available":
response = await balanceAvailable(event);
break;
diff --git a/apps/web/app/(ee)/partners.dub.co/(dashboard)/payouts/partner-payout-details-sheet.tsx b/apps/web/app/(ee)/partners.dub.co/(dashboard)/payouts/partner-payout-details-sheet.tsx
index c153df0fd4..09bb9b1f06 100644
--- a/apps/web/app/(ee)/partners.dub.co/(dashboard)/payouts/partner-payout-details-sheet.tsx
+++ b/apps/web/app/(ee)/partners.dub.co/(dashboard)/payouts/partner-payout-details-sheet.tsx
@@ -143,7 +143,7 @@ function PayoutDetailsSheetContent({ payout }: PayoutDetailsSheetProps) {
value: (
<span className="text-red-600">{payout.failureReason}</span>
),
- tooltip: `Payout failures are usually due to ${payoutMethod === "paypal" ? "incorrect PayPal account configuration" : "invalid bank account details"}. Once you've updated your account, ${
+ tooltip: `Payout failures are usually due to ${payoutMethod === "paypal" ? "incorrect PayPal account configuration" : "invalid bank account details"}. Once you've [updated your account](/payouts?settings=true), ${
payoutMethod === "paypal"
? "you can retry the payout"
: "the payout will be retried automatically"
diff --git a/apps/web/app/(ee)/partners.dub.co/(dashboard)/payouts/partner-payout-settings-button.tsx b/apps/web/app/(ee)/partners.dub.co/(dashboard)/payouts/partner-payout-settings-button.tsx
index fd364328aa..9a28ba48bf 100644
--- a/apps/web/app/(ee)/partners.dub.co/(dashboard)/payouts/partner-payout-settings-button.tsx
+++ b/apps/web/app/(ee)/partners.dub.co/(dashboard)/payouts/partner-payout-settings-button.tsx
@@ -9,7 +9,7 @@ import { usePartnerPayoutSettingsSheet } from "./partner-payout-settings-sheet";
export function PartnerPayoutSettingsButton() {
const { partner } = usePartnerProfile();
- const { PartnerPayoutSettingsSheet, setShowPartnerPayoutSettingsSheet } =
+ const { PartnerPayoutSettingsSheet, openSettings } =
usePartnerPayoutSettingsSheet();
if (partner && !hasPermission(partner.role, "payout_settings.update")) {
@@ -29,7 +29,7 @@ export function PartnerPayoutSettingsButton() {
text="Payout settings"
variant="secondary"
className="h-9 px-3"
- onClick={() => setShowPartnerPayoutSettingsSheet(true)}
+ onClick={openSettings}
/>
</>
);
diff --git a/apps/web/app/(ee)/partners.dub.co/(dashboard)/payouts/partner-payout-settings-sheet.tsx b/apps/web/app/(ee)/partners.dub.co/(dashboard)/payouts/partner-payout-settings-sheet.tsx
index 00cc92a24d..f43c8704ac 100644
--- a/apps/web/app/(ee)/partners.dub.co/(dashboard)/payouts/partner-payout-settings-sheet.tsx
+++ b/apps/web/app/(ee)/partners.dub.co/(dashboard)/payouts/partner-payout-settings-sheet.tsx
@@ -13,6 +13,7 @@ import {
Button,
InfoTooltip,
Sheet,
+ useRouterStuff,
useScrollProgress,
} from "@dub/ui";
import {
@@ -23,24 +24,12 @@ import {
import { COUNTRY_CURRENCY_CODES } from "@dub/utils/src";
import { useAction } from "next-safe-action/hooks";
import Link from "next/link";
-import {
- Dispatch,
- SetStateAction,
- useCallback,
- useMemo,
- useRef,
- useState,
-} from "react";
+import { useCallback, useEffect, useMemo, useRef, useState } from "react";
import { useForm } from "react-hook-form";
import TextareaAutosize from "react-textarea-autosize";
import { toast } from "sonner";
import { z } from "zod";
-type PartnerPayoutSettingsSheetProps = {
- showPartnerPayoutSettingsSheet: boolean;
- setShowPartnerPayoutSettingsSheet: Dispatch<SetStateAction<boolean>>;
-};
-
type PartnerPayoutSettingsFormData = z.infer<
typeof partnerPayoutSettingsSchema
>;
@@ -67,24 +56,38 @@ function useExternalPayoutEnrollments() {
};
}
-function PartnerPayoutSettingsSheet(props: PartnerPayoutSettingsSheetProps) {
- const { showPartnerPayoutSettingsSheet, setShowPartnerPayoutSettingsSheet } =
- props;
+export function PartnerPayoutSettingsSheet() {
+ const { queryParams, searchParams } = useRouterStuff();
+ const [isOpen, setIsOpen] = useState(false);
+
+ useEffect(() => {
+ const settings = searchParams.get("settings");
+
+ if (settings === "true") {
+ setIsOpen(true);
+ } else {
+ setIsOpen(false);
+ }
+ }, [searchParams]);
return (
<Sheet
- open={showPartnerPayoutSettingsSheet}
- onOpenChange={setShowPartnerPayoutSettingsSheet}
+ open={isOpen}
+ onOpenChange={setIsOpen}
+ onClose={() => {
+ queryParams({
+ del: "settings",
+ });
+ }}
>
- <PartnerPayoutSettingsSheetInner {...props} />
+ <PartnerPayoutSettingsSheetInner />
</Sheet>
);
}
-function PartnerPayoutSettingsSheetInner({
- setShowPartnerPayoutSettingsSheet,
-}: PartnerPayoutSettingsSheetProps) {
+function PartnerPayoutSettingsSheetInner() {
const { partner } = usePartnerProfile();
+ const { queryParams } = useRouterStuff();
const {
register,
@@ -103,7 +106,9 @@ function PartnerPayoutSettingsSheetInner({
{
onSuccess: async () => {
toast.success("Payout settings updated successfully!");
- setShowPartnerPayoutSettingsSheet(false);
+ queryParams({
+ del: "settings",
+ });
mutatePrefix("/api/partner-profile");
},
onError({ error }) {
@@ -242,7 +247,11 @@ function PartnerPayoutSettingsSheetInner({
text="Cancel"
disabled={isPending}
className="h-8 w-fit px-3"
- onClick={() => setShowPartnerPayoutSettingsSheet(false)}
+ onClick={() => {
+ queryParams({
+ del: "settings",
+ });
+ }}
/>
<Button
@@ -324,23 +333,25 @@ function ConnectedExternalAccounts() {
}
export function usePartnerPayoutSettingsSheet() {
- const [showPartnerPayoutSettingsSheet, setShowPartnerPayoutSettingsSheet] =
- useState(false);
+ const { queryParams } = useRouterStuff();
+
+ const openSettings = useCallback(() => {
+ queryParams({
+ set: {
+ settings: "true",
+ },
+ });
+ }, [queryParams]);
const PartnerPayoutSettingsSheetCallback = useCallback(() => {
- return (
- <PartnerPayoutSettingsSheet
- showPartnerPayoutSettingsSheet={showPartnerPayoutSettingsSheet}
- setShowPartnerPayoutSettingsSheet={setShowPartnerPayoutSettingsSheet}
- />
- );
- }, [showPartnerPayoutSettingsSheet, setShowPartnerPayoutSettingsSheet]);
+ return <PartnerPayoutSettingsSheet />;
+ }, []);
return useMemo(
() => ({
- setShowPartnerPayoutSettingsSheet,
+ openSettings,
PartnerPayoutSettingsSheet: PartnerPayoutSettingsSheetCallback,
}),
- [setShowPartnerPayoutSettingsSheet, PartnerPayoutSettingsSheetCallback],
+ [openSettings, PartnerPayoutSettingsSheetCallback],
);
}
diff --git a/apps/web/lib/constants/payouts.ts b/apps/web/lib/constants/payouts.ts
index 42741437a3..b935922e3b 100644
--- a/apps/web/lib/constants/payouts.ts
+++ b/apps/web/lib/constants/payouts.ts
@@ -105,3 +105,37 @@ export const INVOICE_AVAILABLE_PAYOUT_STATUSES = [
"sent",
"completed",
];
+
+const VERIFIED_BANK_ACCOUNT_DESCRIPTION = {
+ title: "Verified bank account",
+ description:
+ "This bank account is successfully verified and ready to receive payouts.",
+ variant: "valid" as const,
+};
+
+export const BANK_ACCOUNT_STATUS_DESCRIPTIONS: Record<
+ string,
+ { title: string; description: string; variant: "valid" | "invalid" }
+> = {
+ verified: VERIFIED_BANK_ACCOUNT_DESCRIPTION,
+ new: VERIFIED_BANK_ACCOUNT_DESCRIPTION,
+ validated: VERIFIED_BANK_ACCOUNT_DESCRIPTION,
+ verification_failed: {
+ title: "Verification failed",
+ description:
+ "Bank account verification failed (e.g., microdeposit failure). Please update your bank account details to continue receiving payouts.",
+ variant: "invalid",
+ },
+ tokenized_account_number_deactivated: {
+ title: "Tokenized account deactivated",
+ description:
+ "The account uses a tokenized account number that has been deactivated due to expiration or revocation. Please reverify your bank account to continue receiving payouts.",
+ variant: "invalid",
+ },
+ errored: {
+ title: "Bank account error",
+ description:
+ "A payout sent to this bank account failed. Please update your bank account details to continue receiving payouts.",
+ variant: "invalid",
+ },
+};
diff --git a/apps/web/lib/partners/get-partner-bank-account.ts b/apps/web/lib/partners/get-partner-bank-account.ts
new file mode 100644
index 0000000000..6b808c479e
--- /dev/null
+++ b/apps/web/lib/partners/get-partner-bank-account.ts
@@ -0,0 +1,34 @@
+import { stripe } from "@/lib/stripe";
+import Stripe from "stripe";
+import { z } from "zod";
+
+export const bankAccountSchema = z
+ .object({
+ account_holder_name: z.string().nullable(),
+ bank_name: z.string().nullable(),
+ routing_number: z.string().nullable(),
+ last4: z.string(),
+ status: z.enum([
+ "new",
+ "validated",
+ "verified",
+ "verification_failed",
+ "tokenized_account_number_deactivated",
+ "errored",
+ ]),
+ fingerprint: z.string().nullish(),
+ })
+ .nullable();
+
+export const getPartnerBankAccount = async (stripeAccount: string) => {
+ const externalAccounts = (await stripe.accounts.listExternalAccounts(
+ stripeAccount,
+ {
+ object: "bank_account",
+ },
+ )) as Stripe.ApiList<Stripe.BankAccount>;
+
+ return externalAccounts.data.length > 0
+ ? bankAccountSchema.parse(externalAccounts.data[0])
+ : null;
+};
diff --git a/apps/web/ui/partners/payout-methods-dropdown.tsx b/apps/web/ui/partners/payout-methods-dropdown.tsx
index a090d7ee55..f55ee79719 100644
--- a/apps/web/ui/partners/payout-methods-dropdown.tsx
+++ b/apps/web/ui/partners/payout-methods-dropdown.tsx
@@ -2,17 +2,26 @@
import { generatePaypalOAuthUrl } from "@/lib/actions/partners/generate-paypal-oauth-url";
import { generateStripeAccountLink } from "@/lib/actions/partners/generate-stripe-account-link";
+import { BANK_ACCOUNT_STATUS_DESCRIPTIONS } from "@/lib/constants/payouts";
+import { bankAccountSchema } from "@/lib/partners/get-partner-bank-account";
import usePartnerProfile from "@/lib/swr/use-partner-profile";
import { PartnerProps } from "@/lib/types";
-import { Button, MatrixLines, Paypal, Popover, StripeIcon } from "@dub/ui";
+import {
+ Button,
+ DynamicTooltipWrapper,
+ MatrixLines,
+ Paypal,
+ Popover,
+ StripeIcon,
+} from "@dub/ui";
import { cn, fetcher } from "@dub/utils";
-import { ChevronsUpDown } from "lucide-react";
+import { AlertCircle, CheckCircle2, ChevronsUpDown } from "lucide-react";
import { useAction } from "next-safe-action/hooks";
import { useRouter } from "next/navigation";
import { useState } from "react";
import { toast } from "sonner";
-import type { Stripe } from "stripe";
import useSWR from "swr";
+import { z } from "zod";
export function PayoutMethodsDropdown() {
const router = useRouter();
@@ -23,11 +32,12 @@ export function PayoutMethodsDropdown() {
loading: isPartnerLoading,
} = usePartnerProfile();
- const { data: bankAccount, isLoading: isBankAccountLoading } =
- useSWR<Stripe.BankAccount>(
- partner?.stripeConnectId ? "/api/partner-profile/payouts/settings" : null,
- fetcher,
- );
+ const { data: bankAccount, isLoading: isBankAccountLoading } = useSWR<
+ z.infer<typeof bankAccountSchema>
+ >(
+ partner?.stripeConnectId ? "/api/partner-profile/payouts/settings" : null,
+ fetcher,
+ );
const { executeAsync: executeStripeAsync, isPending: isStripePending } =
useAction(generateStripeAccountLink, {
@@ -79,6 +89,7 @@ export function PayoutMethodsDropdown() {
label: bankAccount?.bank_name || "Stripe",
color: "bg-purple-100",
icon: <StripeIcon />,
+ status: bankAccount?.status,
getAccountDetails: (partner: Pick<PartnerProps, "stripeConnectId">) => {
if (!partner?.stripeConnectId || !bankAccount) {
return "Not connected";
@@ -137,59 +148,63 @@ export function PayoutMethodsDropdown() {
return (
<div>
<Popover
+ popoverContentClassName="w-[var(--radix-popover-trigger-width)]"
content={
- <div
- className={cn(
- "relative w-[350px]",
- isConnected("paypal") && "w-fit",
- )}
- >
+ <div className="relative w-full">
<div className="w-full space-y-0.5 rounded-lg bg-white p-1 text-sm">
<div className="flex flex-col gap-2">
{payoutMethods
.filter(({ isVisible }) => isVisible(partner))
- .map(({ id, label, color, icon, getAccountDetails }) => {
- return (
- <div
- key={id}
- className="flex w-full items-center justify-between gap-4 rounded-md px-2 py-1.5 transition-all duration-75"
- >
- <div className="flex items-center gap-x-2">
- <div
- className={cn(
- "size-8 shrink-0 rounded-lg",
- id === "paypal" && "p-2",
- color,
- )}
- >
- {icon}
- </div>
- <div>
- <span className="text-xs font-medium text-neutral-900">
- {label}
- </span>
- <span className="block w-44 truncate text-xs text-neutral-500">
- {getAccountDetails(partner)}
- </span>
+ .map(
+ ({ id, label, color, icon, status, getAccountDetails }) => {
+ return (
+ <div
+ key={id}
+ className="flex w-full items-center justify-between gap-4 rounded-md px-2 py-1.5 transition-all duration-75"
+ >
+ <div className="flex items-center gap-x-2">
+ <PayoutMethodStatusIndicator
+ className={cn(
+ "size-8 shrink-0 rounded-lg",
+ id === "paypal" && "p-2",
+ color,
+ )}
+ icon={icon}
+ partner={partner}
+ bankAccount={bankAccount}
+ isLoading={
+ isBankAccountLoading || isPartnerLoading
+ }
+ />
+ <div>
+ <div className="flex items-center gap-1">
+ <span className="text-xs font-medium text-neutral-900">
+ {label}
+ </span>
+ </div>
+ <span className="block w-44 truncate text-xs text-neutral-500">
+ {getAccountDetails(partner)}
+ </span>
+ </div>
</div>
- </div>
- <Button
- variant={isConnected(id) ? "secondary" : "primary"}
- text={
- isConnected(id)
- ? id === "paypal"
- ? "Switch account"
- : "Manage"
- : "Connect"
- }
- onClick={() => connectPayout(id)}
- loading={isStripePending || isPaypalPending}
- className="h-7 w-fit text-xs"
- />
- </div>
- );
- })}
+ <Button
+ variant={isConnected(id) ? "secondary" : "primary"}
+ text={
+ isConnected(id)
+ ? id === "paypal"
+ ? "Switch account"
+ : "Manage"
+ : "Connect"
+ }
+ onClick={() => connectPayout(id)}
+ loading={isStripePending || isPaypalPending}
+ className="h-7 w-fit text-xs"
+ />
+ </div>
+ );
+ },
+ )}
</div>
</div>
</div>
@@ -210,19 +225,23 @@ export function PayoutMethodsDropdown() {
) : (
<>
<div className="flex min-w-0 items-center gap-x-2.5 pr-2">
- <div
+ <PayoutMethodStatusIndicator
className={cn(
"size-8 shrink-0 rounded-lg",
selectedMethod?.id === "paypal" && "p-2",
selectedMethod?.color,
)}
- >
- {selectedMethod?.icon}
- </div>
+ icon={selectedMethod?.icon}
+ partner={partner}
+ bankAccount={bankAccount}
+ isLoading={isBankAccountLoading || isPartnerLoading}
+ />
<div className="min-w-0">
- <span className="block text-xs font-medium text-neutral-900">
- {selectedMethod?.label}
- </span>
+ <div className="flex items-center gap-1">
+ <span className="block text-xs font-medium text-neutral-900">
+ {selectedMethod?.label}
+ </span>
+ </div>
<span className="block w-44 truncate text-xs text-neutral-500">
{selectedMethod?.getAccountDetails(partner)}
</span>
@@ -254,3 +273,64 @@ function PayoutMethodSkeleton() {
</>
);
}
+
+function PayoutMethodStatusIndicator({
+ icon,
+ className,
+ partner,
+ bankAccount,
+ isLoading,
+}: {
+ icon: React.ReactNode;
+ className?: string;
+ partner: Pick<PartnerProps, "paypalEmail" | "stripeConnectId"> | null;
+ bankAccount?: z.infer<typeof bankAccountSchema> | null;
+ isLoading?: boolean;
+}) {
+ if (isLoading || !partner?.stripeConnectId || !bankAccount?.status) {
+ return <div className={className}>{icon}</div>;
+ }
+
+ const statusInfo = BANK_ACCOUNT_STATUS_DESCRIPTIONS[bankAccount.status];
+
+ return (
+ <DynamicTooltipWrapper
+ tooltipProps={{
+ content: statusInfo ? (
+ <div className="grid max-w-xs gap-2 p-4">
+ <div className="flex items-center gap-2 text-sm font-medium">
+ {statusInfo.title}
+ <div
+ className={cn(
+ statusInfo.variant === "invalid"
+ ? "border-red-300 bg-red-200 text-red-800"
+ : "border-green-300 bg-green-200 text-green-800",
+ "flex size-5 items-center justify-center rounded-md border",
+ )}
+ >
+ {statusInfo.variant === "invalid" ? (
+ <AlertCircle className="size-3" />
+ ) : (
+ <CheckCircle2 className="size-3" />
+ )}
+ </div>
+ </div>
+ <div className="text-pretty text-sm text-neutral-500">
+ {statusInfo.description}
+ </div>
+ </div>
+ ) : undefined,
+ }}
+ >
+ <div className={cn("relative shrink-0", className)}>
+ {icon}
+ <div
+ className={cn(
+ "absolute -bottom-0.5 -right-0.5 size-2.5 rounded-full",
+ statusInfo.variant === "invalid" ? "bg-red-500" : "bg-green-500",
+ )}
+ />
+ </div>
+ </DynamicTooltipWrapper>
+ );
+}
diff --git a/packages/email/src/templates/partner-payout-withdrawal-failed.tsx b/packages/email/src/templates/partner-payout-withdrawal-failed.tsx
index ed15fbdee8..aac7830255 100644
--- a/packages/email/src/templates/partner-payout-withdrawal-failed.tsx
+++ b/packages/email/src/templates/partner-payout-withdrawal-failed.tsx
@@ -1,6 +1,7 @@
import { currencyFormatter, DUB_WORDMARK } from "@dub/utils";
import {
Body,
+ Column,
Container,
Head,
Heading,
@@ -8,6 +9,7 @@ import {
Img,
Link,
Preview,
+ Row,
Section,
Tailwind,
Text,
@@ -23,13 +25,26 @@ export default function PartnerPayoutWithdrawalFailed({
failureReason:
"Your bank notified us that the bank account holder tax ID on file is incorrect.",
},
+ bankAccount = {
+ account_holder_name: "Brendon Urie",
+ bank_name: "BANK OF AMERICA, N.A.",
+ last4: "1234",
+ routing_number: "1234567890",
+ },
}: {
email: string;
payout: {
amount: number; // in cents
currency: string;
failureReason?: string | null;
+ isAvailableBalance?: boolean;
};
+ bankAccount?: {
+ account_holder_name: string | null;
+ bank_name: string | null;
+ last4: string;
+ routing_number: string | null;
+ } | null;
}) {
const amountFormatted = currencyFormatter(payout.amount, {
currency: payout.currency,
@@ -49,17 +64,30 @@ export default function PartnerPayoutWithdrawalFailed({
</Section>
<Heading className="mx-0 my-8 p-0 text-lg font-medium text-black">
- Your recent auto-withdrawal failed
+ {payout.isAvailableBalance
+ ? "Update your bank account details to receive payouts"
+ : "Your recent auto-withdrawal failed"}
</Heading>
- <Text>
- We attempted to transfer{" "}
- <span className="font-semibold text-purple-600">
- {amountFormatted}
- </span>{" "}
- from your Stripe Express account to your connected bank account,
- but the transaction failed.
- </Text>
+ {payout.isAvailableBalance ? (
+ <Text>
+ You have an available balance of{" "}
+ <span className="font-semibold text-purple-600">
+ {amountFormatted}
+ </span>{" "}
+ in your Stripe Express account, but we encountered an error when
+ attempting to transfer it to your connected bank account.
+ </Text>
+ ) : (
+ <Text>
+ We attempted to transfer{" "}
+ <span className="font-semibold text-purple-600">
+ {amountFormatted}
+ </span>{" "}
+ from your Stripe Express account to your connected bank account,
+ but the transaction failed.
+ </Text>
+ )}
{payout.failureReason && (
<Text className="text-sm leading-6 text-neutral-600">
@@ -69,34 +97,70 @@ export default function PartnerPayoutWithdrawalFailed({
</span>
</Text>
)}
+ {bankAccount && (
+ <Section className="my-6 rounded-lg border border-solid border-neutral-200 bg-neutral-50 p-4 pt-0">
+ <Text className="mb-3 text-sm font-semibold text-neutral-800">
+ Current bank account
+ </Text>
+
+ {bankAccount.account_holder_name && (
+ <Row className="mb-2">
+ <Column className="text-sm text-neutral-600">
+ Account Holder
+ </Column>
+ <Column className="text-right text-sm font-medium text-neutral-800">
+ {bankAccount.account_holder_name}
+ </Column>
+ </Row>
+ )}
+
+ {bankAccount.bank_name && (
+ <Row className="mb-2">
+ <Column className="text-sm text-neutral-600">
+ Bank Name
+ </Column>
+ <Column className="text-right text-sm font-medium text-neutral-800">
+ {bankAccount.bank_name}
+ </Column>
+ </Row>
+ )}
+
+ <Row className="mb-2">
+ <Column className="text-sm text-neutral-600">
+ Account Number
+ </Column>
+ <Column className="text-right text-sm font-medium text-neutral-800">
+ •••• {bankAccount.last4}
+ </Column>
+ </Row>
+
+ {bankAccount.routing_number && (
+ <Row>
+ <Column className="text-sm text-neutral-600">
+ Routing Number
+ </Column>
+ <Column className="text-right text-sm font-medium text-neutral-800">
+ {bankAccount.routing_number}
+ </Column>
+ </Row>
+ )}
+ </Section>
+ )}
<Text>
Please update your bank account details as soon as possible.
- Failed transfers are automatically retried, so having accurate
- bank details on file will ensure your funds are deposited
- successfully.
+ Failed transfers are automatically retried once you have a valid
+ bank account on file.
</Text>
<Section className="my-8">
<Link
className="rounded-lg bg-neutral-900 px-6 py-3 text-[13px] font-medium text-white no-underline"
- href="https://partners.dub.co/payouts"
+ href="https://partners.dub.co/payouts?settings=true"
>
Update bank account
</Link>
</Section>
-
- <Text className="text-sm leading-6 text-neutral-600">
- If you have any questions, please{" "}
- <Link
- href="https://dub.co/contact/support"
- className="font-medium text-black underline"
- >
- reach out to support
- </Link>
- .
- </Text>
-
<Footer email={email} />
</Container>
</Body>