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.

Partners set their default payout method (#3927)

Pedro Ladeirac36af350892d
diff --git a/apps/web/app/(ee)/admin.dub.co/(dashboard)/partners/network/network-partner-change-history-item.tsx b/apps/web/app/(ee)/admin.dub.co/(dashboard)/partners/network/network-partner-change-history-item.tsx
index a4bf39d0d9..f083ceaa63 100644
--- a/apps/web/app/(ee)/admin.dub.co/(dashboard)/partners/network/network-partner-change-history-item.tsx
+++ b/apps/web/app/(ee)/admin.dub.co/(dashboard)/partners/network/network-partner-change-history-item.tsx
@@ -2,7 +2,9 @@
import { AdminNetworkPartner } from "@/lib/types";
import { NetworkStatusBadges } from "@/ui/partners/partner-network/network-status-badges";
+import { getPayoutMethodLabel } from "@/ui/partners/payouts/payout-method-config";
import { CountryFlag } from "@/ui/shared/country-flag";
+import { PartnerPayoutMethod } from "@dub/prisma/client";
import { StatusBadge, TimestampTooltip } from "@dub/ui";
import { capitalize, COUNTRIES, formatDate } from "@dub/utils";
@@ -14,6 +16,7 @@ const FIELD_LABELS: Record<PartnerChangeLogEntry["field"], string> = {
country: "Country",
profileType: "Profile type",
networkStatus: "Network status",
+ defaultPayoutMethod: "Default payout method",
};
export function NetworkPartnerChangeHistoryItem({
@@ -81,6 +84,18 @@ function renderChangeValue(
);
}
+ if (field === "defaultPayoutMethod") {
+ const label = value
+ ? getPayoutMethodLabel(value as PartnerPayoutMethod)
+ : "Not set";
+
+ return (
+ <span className="inline-flex min-w-0 max-w-full items-center rounded-md border border-neutral-200 bg-neutral-50 px-2 py-0.5 text-xs font-medium text-neutral-700">
+ <span className="truncate">{label}</span>
+ </span>
+ );
+ }
+
const label = value === null ? "Not set" : capitalize(value);
return (
diff --git a/apps/web/lib/actions/partners/set-default-payout-method.ts b/apps/web/lib/actions/partners/set-default-payout-method.ts
new file mode 100644
index 0000000000..f13c2773ce
--- /dev/null
+++ b/apps/web/lib/actions/partners/set-default-payout-method.ts
@@ -0,0 +1,94 @@
+"use server";
+
+import { throwIfNoPermission } from "@/lib/auth/partner-users/throw-if-no-permission";
+import { getPartnerPayoutMethods } from "@/lib/payouts/get-partner-payout-methods";
+import { recomputePartnerPayoutState } from "@/lib/payouts/recompute-partner-payout-state";
+import {
+ partnerProfileChangeHistoryLogSchema,
+ setDefaultPayoutMethodSchema,
+} from "@/lib/zod/schemas/partner-profile";
+import { getPayoutMethodLabel } from "@/ui/partners/payouts/payout-method-config";
+import { sendEmail } from "@dub/email";
+import DefaultPayoutMethodChanged from "@dub/email/templates/default-payout-method-changed";
+import { prisma } from "@dub/prisma";
+import { waitUntil } from "@vercel/functions";
+import { authPartnerActionClient } from "../safe-action";
+
+export const setDefaultPayoutMethodAction = authPartnerActionClient
+ .inputSchema(setDefaultPayoutMethodSchema)
+ .action(async ({ ctx, parsedInput }) => {
+ const { partner, partnerUser } = ctx;
+ const { type } = parsedInput;
+
+ throwIfNoPermission({
+ role: partnerUser.role,
+ permission: "payout_settings.update",
+ });
+
+ if (!partner.payoutsEnabledAt) {
+ throw new Error(
+ `You haven't enabled payout yet. Please connect a payout method first.`,
+ );
+ }
+
+ const payoutMethods = await getPartnerPayoutMethods(partner);
+ const payoutMethod = payoutMethods.find((m) => m.type === type);
+
+ if (!payoutMethod) {
+ throw new Error("This payout method is not available for your country.");
+ }
+
+ if (payoutMethod.default) {
+ throw new Error("This is already your default payout method.");
+ }
+
+ const { activePayoutMethods } = await recomputePartnerPayoutState(partner);
+ if (!activePayoutMethods.includes(type)) {
+ throw new Error(
+ "This payout method can't receive payouts right now. Please fix it in Stripe or choose another method.",
+ );
+ }
+
+ const fromDefault = partner.defaultPayoutMethod;
+
+ const partnerChangeHistoryLog = partner.changeHistoryLog
+ ? partnerProfileChangeHistoryLogSchema.parse(partner.changeHistoryLog)
+ : [];
+
+ partnerChangeHistoryLog.push({
+ field: "defaultPayoutMethod",
+ from: fromDefault,
+ to: type,
+ changedAt: new Date(),
+ });
+
+ await prisma.partner.update({
+ where: {
+ id: partner.id,
+ },
+ data: {
+ defaultPayoutMethod: type,
+ changeHistoryLog: partnerChangeHistoryLog,
+ },
+ });
+
+ if (partner.email) {
+ const fromLabel = fromDefault
+ ? getPayoutMethodLabel(fromDefault)
+ : "Not set";
+ const toLabel = getPayoutMethodLabel(type);
+
+ waitUntil(
+ sendEmail({
+ variant: "notifications",
+ subject: "Your default payout method was updated",
+ to: partner.email,
+ react: DefaultPayoutMethodChanged({
+ email: partner.email,
+ fromLabel,
+ toLabel,
+ }),
+ }),
+ );
+ }
+ });
diff --git a/apps/web/lib/payouts/recompute-partner-payout-state.ts b/apps/web/lib/payouts/recompute-partner-payout-state.ts
index 0e597e6561..87c3fe3b4b 100644
--- a/apps/web/lib/payouts/recompute-partner-payout-state.ts
+++ b/apps/web/lib/payouts/recompute-partner-payout-state.ts
@@ -12,8 +12,8 @@ const PAYOUT_METHOD_PRIORITY: PartnerPayoutMethod[] = [
/**
* Computes payoutsEnabledAt and defaultPayoutMethod based on currently active
- * payout methods. The default is always selected from priority order:
- * stablecoin > connect > paypal.
+ * payout methods. Preserves the partner's existing default when it is still
+ * active; otherwise falls back to priority order: stablecoin > connect > paypal.
*/
export async function recomputePartnerPayoutState(
partner: Pick<
@@ -74,7 +74,11 @@ export async function recomputePartnerPayoutState(
}
});
- const defaultPayoutMethod = activePayoutMethods[0] ?? null;
+ const defaultPayoutMethod =
+ partner.defaultPayoutMethod &&
+ activePayoutMethods.includes(partner.defaultPayoutMethod)
+ ? partner.defaultPayoutMethod
+ : activePayoutMethods[0] ?? null;
let payoutsEnabledAt: Date | null = null;
if (defaultPayoutMethod) {
@@ -108,6 +112,7 @@ export async function recomputePartnerPayoutState(
return {
payoutsEnabledAt,
defaultPayoutMethod,
+ activePayoutMethods,
cryptoWalletAddress,
cryptoWalletNetwork,
maskedCryptoWalletAddress,
diff --git a/apps/web/lib/zod/schemas/partner-profile.ts b/apps/web/lib/zod/schemas/partner-profile.ts
index ef5acd4ead..f1e9b7b070 100644
--- a/apps/web/lib/zod/schemas/partner-profile.ts
+++ b/apps/web/lib/zod/schemas/partner-profile.ts
@@ -218,6 +218,12 @@ export const partnerProfileChangeHistoryLogSchema = z.array(
to: z.enum(PartnerNetworkStatus),
changedAt: z.coerce.date(),
}),
+ z.object({
+ field: z.literal("defaultPayoutMethod"),
+ from: z.enum(PartnerPayoutMethod).nullable(),
+ to: z.enum(PartnerPayoutMethod),
+ changedAt: z.coerce.date(),
+ }),
]),
);
@@ -229,6 +235,10 @@ export const partnerPayoutMethodSchema = z.object({
identifier: z.string().nullable(),
});
+export const setDefaultPayoutMethodSchema = z.object({
+ type: z.enum(PartnerPayoutMethod),
+});
+
export const partnerProfilePayoutsQuerySchema = payoutsQuerySchema.extend({
programId: z.string().optional(),
sortBy: payoutsQuerySchema.shape.sortBy.default("initiatedAt"),
diff --git a/apps/web/ui/partners/payouts/payout-method-dropdown.tsx b/apps/web/ui/partners/payouts/payout-method-dropdown.tsx
index 6f094d7eaf..04d5c1d1b6 100644
--- a/apps/web/ui/partners/payouts/payout-method-dropdown.tsx
+++ b/apps/web/ui/partners/payouts/payout-method-dropdown.tsx
@@ -1,5 +1,7 @@
"use client";
+import { setDefaultPayoutMethodAction } from "@/lib/actions/partners/set-default-payout-method";
+import { mutatePrefix } from "@/lib/swr/mutate";
import usePartnerPayoutSettings from "@/lib/swr/use-partner-payout-settings";
import usePartnerProfile from "@/lib/swr/use-partner-profile";
import type { PartnerPayoutMethodSetting } from "@/lib/types";
@@ -9,7 +11,9 @@ import { PartnerPayoutMethod } from "@dub/prisma/client";
import { Button, Popover } from "@dub/ui";
import { cn } from "@dub/utils";
import { ChevronsUpDown } from "lucide-react";
+import { useAction } from "next-safe-action/hooks";
import { useCallback, useState } from "react";
+import { toast } from "sonner";
import { usePayoutConnectFlow } from "./use-payout-connect-flow";
export function PayoutMethodDropdown() {
@@ -23,8 +27,30 @@ export function PayoutMethodDropdown() {
StablecoinPayoutModal,
} = usePayoutConnectFlow();
- const { payoutMethods: payoutMethodsData, isLoading: isSettingsLoading } =
- usePartnerPayoutSettings();
+ const {
+ payoutMethods: payoutMethodsData,
+ isLoading: isSettingsLoading,
+ mutate: mutatePayoutSettings,
+ } = usePartnerPayoutSettings();
+
+ const [pendingDefaultType, setPendingDefaultType] =
+ useState<PartnerPayoutMethod | null>(null);
+
+ const { executeAsync: setDefaultPayoutMethod } = useAction(
+ setDefaultPayoutMethodAction,
+ {
+ onSuccess: async () => {
+ toast.success("Your default payout method has been updated.");
+ await Promise.all([
+ mutatePayoutSettings(),
+ mutatePrefix("/api/partner-profile"),
+ ]);
+ },
+ onError({ error }) {
+ toast.error(error.serverError);
+ },
+ },
+ );
const payoutMethods =
!payoutMethodsData || !Array.isArray(payoutMethodsData)
@@ -41,6 +67,18 @@ export function PayoutMethodDropdown() {
[connect],
);
+ const handleSetDefault = useCallback(
+ async (type: PartnerPayoutMethod) => {
+ setPendingDefaultType(type);
+ try {
+ await setDefaultPayoutMethod({ type });
+ } finally {
+ setPendingDefaultType(null);
+ }
+ },
+ [setDefaultPayoutMethod],
+ );
+
const selectedMethod =
payoutMethods?.find((m) => m.default) ??
payoutMethods?.find((m) => m.connected);
@@ -67,7 +105,9 @@ export function PayoutMethodDropdown() {
key={method.type}
method={method}
onAction={handleAction}
+ onSetDefault={handleSetDefault}
isActionPending={isPending}
+ pendingDefaultType={pendingDefaultType}
/>
))}
</div>
@@ -101,14 +141,19 @@ export function PayoutMethodDropdown() {
function PayoutMethodItem({
method,
onAction,
+ onSetDefault,
isActionPending,
+ pendingDefaultType,
}: {
method: PartnerPayoutMethodSetting;
onAction: (type: PartnerPayoutMethod, isManage: boolean) => void;
+ onSetDefault: (type: PartnerPayoutMethod) => void;
isActionPending: boolean;
+ pendingDefaultType: PartnerPayoutMethod | null;
}) {
const { partner } = usePartnerProfile();
const { Icon, wrapperClass } = getPayoutMethodIconConfig(method.type);
+ const payoutsDisabled = !partner?.payoutsEnabledAt;
return (
<div className="flex w-full cursor-default items-center justify-between gap-4 rounded-md px-2 py-1.5 transition-colors duration-75 hover:bg-neutral-50">
@@ -127,15 +172,12 @@ function PayoutMethodItem({
{method.label}
</span>
- {!partner?.payoutsEnabledAt ? (
- <span className="rounded bg-red-100 px-1.5 py-0.5 text-[0.7rem] font-medium leading-none text-red-700">
- Restricted
- </span>
- ) : method.default ? (
- <span className="rounded-md bg-green-100 px-1.5 py-0.5 text-[0.7rem] font-semibold leading-none text-green-700">
- Default
- </span>
- ) : null}
+ <PayoutMethodStatusBadge
+ method={method}
+ onSetDefault={onSetDefault}
+ pendingDefaultType={pendingDefaultType}
+ payoutsDisabled={payoutsDisabled}
+ />
</div>
<span className="mt-0.5 block truncate text-xs text-neutral-500">
{method.identifier ?? "Not connected"}
@@ -147,12 +189,63 @@ function PayoutMethodItem({
text={method.connected ? "Manage" : "Connect"}
onClick={() => onAction(method.type, method.connected)}
loading={isActionPending}
+ disabled={payoutsDisabled}
className="h-7 w-fit shrink-0 cursor-pointer text-xs"
/>
</div>
);
}
+function PayoutMethodStatusBadge({
+ method,
+ onSetDefault,
+ pendingDefaultType,
+ payoutsDisabled,
+}: {
+ method: PartnerPayoutMethodSetting;
+ onSetDefault: (type: PartnerPayoutMethod) => void;
+ pendingDefaultType: PartnerPayoutMethod | null;
+ payoutsDisabled: boolean;
+}) {
+ const isSettingDefault = pendingDefaultType === method.type;
+ const { partner } = usePartnerProfile();
+
+ if (!partner?.payoutsEnabledAt) {
+ return (
+ <span className="rounded bg-red-100 px-1.5 py-0.5 text-[0.7rem] font-medium leading-none text-red-700">
+ Restricted
+ </span>
+ );
+ }
+
+ if (method.default) {
+ return (
+ <span className="rounded-md bg-green-100 px-1.5 py-0.5 text-[0.7rem] font-semibold leading-none text-green-700">
+ Default
+ </span>
+ );
+ }
+
+ if (method.connected && !payoutsDisabled) {
+ return (
+ <button
+ type="button"
+ onClick={() => onSetDefault(method.type)}
+ disabled={isSettingDefault}
+ className={cn(
+ "rounded-md border border-neutral-200 bg-white px-1.5 py-0.5 text-[0.7rem] font-medium leading-none text-neutral-600",
+ "cursor-pointer transition-colors hover:bg-neutral-50",
+ "disabled:cursor-not-allowed disabled:opacity-50",
+ )}
+ >
+ {isSettingDefault ? "Setting..." : "Set as default"}
+ </button>
+ );
+ }
+
+ return null;
+}
+
function SelectedMethodDisplay({
method,
}: {
diff --git a/packages/email/src/templates/default-payout-method-changed.tsx b/packages/email/src/templates/default-payout-method-changed.tsx
new file mode 100644
index 0000000000..6648c9be0f
--- /dev/null
+++ b/packages/email/src/templates/default-payout-method-changed.tsx
@@ -0,0 +1,82 @@
+import { DUB_WORDMARK } from "@dub/utils";
+import {
+ Body,
+ Container,
+ Head,
+ Heading,
+ Html,
+ Img,
+ Link,
+ Preview,
+ Section,
+ Tailwind,
+ Text,
+} from "@react-email/components";
+import { Footer } from "../components/footer";
+
+export default function DefaultPayoutMethodChanged({
+ email = "[email protected]",
+ fromLabel = "Stablecoin",
+ toLabel = "Bank Account",
+}: {
+ email: string;
+ fromLabel: string;
+ toLabel: string;
+}) {
+ const hasPreviousDefault = fromLabel !== "Not set";
+
+ return (
+ <Html>
+ <Head />
+ <Preview>{`Your default payout method is now ${toLabel}`}</Preview>
+ <Tailwind>
+ <Body className="mx-auto my-auto bg-white font-sans">
+ <Container className="mx-auto my-10 max-w-[600px] rounded border border-solid border-neutral-200 px-10 py-5">
+ <Section className="mb-8 mt-6">
+ <Img src={DUB_WORDMARK} width="65" height="32" alt="dub" />
+ </Section>
+
+ <Heading className="mx-0 mb-4 p-0 text-lg font-medium text-neutral-800">
+ Default payout method updated
+ </Heading>
+
+ <Text className="mb-6 text-sm leading-6 text-neutral-600">
+ {hasPreviousDefault ? (
+ <>
+ Your default payout method changed from{" "}
+ <span className="font-medium text-neutral-900">
+ {fromLabel}
+ </span>{" "}
+ to{" "}
+ <span className="font-medium text-neutral-900">
+ {toLabel}
+ </span>
+ . Future payouts will be sent to {toLabel}.
+ </>
+ ) : (
+ <>
+ Your default payout method is now{" "}
+ <span className="font-medium text-neutral-900">
+ {toLabel}
+ </span>
+ . Future payouts will be sent there.
+ </>
+ )}
+ </Text>
+
+ <Section className="mb-6">
+ <Link
+ href="https://partners.dub.co/payouts?settings=true"
+ className="box-border block w-full rounded-md bg-black px-0 py-3 text-center text-sm font-medium leading-none text-white no-underline"
+ >
+ View payout settings
+ </Link>
+ </Section>
+
+ <Footer email={email} />
+ </Container>
+ </Body>
+ </Tailwind>
+ </Html>
+ );
+}