The complete open source platform to run your entire marketplace. Storefront, vendor panel, admin console, and integrations in one enterprise-grade platform you own.
TypeScript b2b-marketplacecomposable-commerceecommerceenterpriseheadless-commercemarketplacemedusamedusajsmulti-vendortypescript
fix(payout): default payout account data to empty object (#1582)
Viktor Holik8b73e95f83bc
diff --git a/apps/docs/learn/payouts.mdx b/apps/docs/learn/payouts.mdxindex 0cb1e1912..590dd8f95 100644--- a/apps/docs/learn/payouts.mdx+++ b/apps/docs/learn/payouts.mdx@@ -155,7 +155,8 @@ curl -X POST http://localhost:9000/vendor/payout-accounts/<account-id>/onboardin-H "Authorization: Bearer <seller-token>" \-H "Content-Type: application/json" \-d '{- "context": {+ "data": {+ "refresh_url": "https://my-store.com/settings/payouts","return_url": "https://my-store.com/settings/payouts"}}'diff --git a/apps/docs/references/api/vendor/payout-accounts/create-onboarding.mdx b/apps/docs/references/api/vendor/payout-accounts/create-onboarding.mdxindex 5ae192a39..d42df5221 100644--- a/apps/docs/references/api/vendor/payout-accounts/create-onboarding.mdx+++ b/apps/docs/references/api/vendor/payout-accounts/create-onboarding.mdx@@ -15,11 +15,11 @@ Creates an onboarding session with the payout provider. For Stripe Connect, the## Body parameters<ParamField body="data" type="object">- Provider-specific data forwarded when creating the onboarding.+ Provider-specific data forwarded when creating the onboarding (e.g. `refresh_url` and `return_url` for Stripe Connect). Merged over the payout account's stored `data`.</ParamField><ParamField body="context" type="object">- Provider-specific context (e.g. `refresh_url` and `return_url` for Stripe Connect).+ Additional context forwarded to the provider, such as an `idempotency_key`.</ParamField>## Response@@ -40,13 +40,13 @@ curl -X POST 'http://localhost:9000/vendor/payout-accounts/pacc_01HXYZ/onboardin-H 'Authorization: Bearer <token>' \-H 'x-seller-id: <seller_id>' \-H 'Content-Type: application/json' \- -d '{"context": {"refresh_url": "https://vendor.example.com/payouts", "return_url": "https://vendor.example.com/payouts"}}'+ -d '{"data": {"refresh_url": "https://vendor.example.com/payouts", "return_url": "https://vendor.example.com/payouts"}}'``````ts JS Clientconst { onboarding } = await client.vendor.payoutAccounts.$id.onboarding.mutate({$id: "pacc_01HXYZ",- context: {+ data: {refresh_url: "https://vendor.example.com/payouts",return_url: "https://vendor.example.com/payouts",},@@ -60,7 +60,6 @@ const { onboarding } = await client.vendor.payoutAccounts.$id.onboarding.mutate("onboarding": {"id": "onb_01HXYZ","data": { "url": "https://connect.stripe.com/setup/s/..." },- "context": { "return_url": "https://vendor.example.com/payouts" },"created_at": "2026-01-15T10:00:00.000Z"}}diff --git a/apps/docs/references/api/vendor/payout-accounts/create-payout-account.mdx b/apps/docs/references/api/vendor/payout-accounts/create-payout-account.mdxindex ddba8a53d..01a30e104 100644--- a/apps/docs/references/api/vendor/payout-accounts/create-payout-account.mdx+++ b/apps/docs/references/api/vendor/payout-accounts/create-payout-account.mdx@@ -9,11 +9,11 @@ Creates a payout account for the current seller through the configured payout pr## Body parameters<ParamField body="data" type="object">- Provider-specific data forwarded when creating the account.+ Provider-specific data forwarded when creating the account (e.g. `{ "country": "US" }` for Stripe Connect). Defaults to `{}`.</ParamField><ParamField body="context" type="object">- Provider-specific context (e.g. `{ "country": "US" }` for Stripe Connect).+ Additional context forwarded to the provider, such as an `idempotency_key`.</ParamField>## Response@@ -35,12 +35,12 @@ curl -X POST 'http://localhost:9000/vendor/payout-accounts' \-H 'Authorization: Bearer <token>' \-H 'x-seller-id: <seller_id>' \-H 'Content-Type: application/json' \- -d '{"context": {"country": "US"}}'+ -d '{"data": {"country": "US"}}'``````ts JS Clientconst { payout_account } = await client.vendor.payoutAccounts.mutate({- context: { country: "US" },+ data: { country: "US" },})```</RequestExample>@@ -51,7 +51,7 @@ const { payout_account } = await client.vendor.payoutAccounts.mutate({"payout_account": {"id": "pacc_01HXYZ","status": "pending",- "context": { "country": "US" },+ "data": { "id": "acct_1Q2w3E4r5T6y7U8i" },"created_at": "2026-01-15T10:00:00.000Z"}}diff --git a/integration-tests/http/payouts/vendor/payout-accounts.spec.ts b/integration-tests/http/payouts/vendor/payout-accounts.spec.tsnew file mode 100644index 000000000..9917a74b3--- /dev/null+++ b/integration-tests/http/payouts/vendor/payout-accounts.spec.ts@@ -0,0 +1,57 @@+import { medusaIntegrationTestRunner } from "@medusajs/test-utils"+import { MedusaContainer } from "@medusajs/framework/types"+import { PayoutAccountStatus } from "@mercurjs/types"+import { createSellerUser } from "../../../helpers/create-seller-user"++jest.setTimeout(120000)++medusaIntegrationTestRunner({+ testSuite: ({ getContainer, api }) => {+ describe("Vendor - Payout Accounts", () => {+ let appContainer: MedusaContainer+ let sellerHeaders: Awaited<ReturnType<typeof createSellerUser>>["headers"]++ beforeAll(async () => {+ appContainer = getContainer()+ })++ beforeEach(async () => {+ const result = await createSellerUser(appContainer, {+ email: "[email protected]",+ name: "Payout Account Seller",+ })+ sellerHeaders = result.headers+ })++ describe("POST /vendor/payout-accounts", () => {+ it("should create a payout account when data is omitted", async () => {+ const response = await api.post(+ "/vendor/payout-accounts",+ { context: { country: "DE" } },+ sellerHeaders+ )++ expect(response.status).toEqual(201)+ expect(response.data.payout_account).toEqual(+ expect.objectContaining({+ id: expect.any(String),+ status: PayoutAccountStatus.ACTIVE,+ data: {},+ })+ )+ })++ it("should create a payout account with an empty body", async () => {+ const response = await api.post(+ "/vendor/payout-accounts",+ {},+ sellerHeaders+ )++ expect(response.status).toEqual(201)+ expect(response.data.payout_account.id).toEqual(expect.any(String))+ })+ })+ })+ },+})diff --git a/packages/core/src/modules/payout/migrations/.snapshot-medusa-payout.json b/packages/core/src/modules/payout/migrations/.snapshot-medusa-payout.jsonindex 98f006115..9a966d09f 100644--- a/packages/core/src/modules/payout/migrations/.snapshot-medusa-payout.json+++ b/packages/core/src/modules/payout/migrations/.snapshot-medusa-payout.json@@ -38,6 +38,7 @@"autoincrement": false,"primary": false,"nullable": false,+ "default": "'{}'","mappedType": "json"},"context": {diff --git a/packages/core/src/modules/payout/migrations/Migration20260928120000.ts b/packages/core/src/modules/payout/migrations/Migration20260928120000.tsnew file mode 100644index 000000000..6cd9f1d63--- /dev/null+++ b/packages/core/src/modules/payout/migrations/Migration20260928120000.ts@@ -0,0 +1,13 @@+import { Migration } from "@medusajs/framework/mikro-orm/migrations";++export class Migration20260928120000 extends Migration {++ override async up(): Promise<void> {+ this.addSql(`alter table if exists "payout_account" alter column "data" set default '{}';`);+ }++ override async down(): Promise<void> {+ this.addSql(`alter table if exists "payout_account" alter column "data" drop default;`);+ }++}diff --git a/packages/core/src/modules/payout/models/payout-account.ts b/packages/core/src/modules/payout/models/payout-account.tsindex b683be5ce..1e70e3f06 100644--- a/packages/core/src/modules/payout/models/payout-account.ts+++ b/packages/core/src/modules/payout/models/payout-account.ts@@ -7,7 +7,7 @@ import { Payout } from "./payout";export const PayoutAccount = model.define("payout_account", {id: model.id({ prefix: "pacc" }).primaryKey(),status: model.enum(PayoutAccountStatus).default(PayoutAccountStatus.PENDING),- data: model.json(),+ data: model.json().default({}),context: model.json().nullable(),onboarding: model.hasOne(() => Onboarding, {mappedBy: 'account'