> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetMarketplacePayout # Package: earnings # Namespace: MarketplacePayouts # Method link: https://dev.wix.com/docs/api-reference/account-level/studio-workspace/earnings/marketplace-payout-v1/get-marketplace-payout.md ## Permission Scopes: SCOPE.PARTNERS.REVSHARE: SCOPE.PARTNERS.REVSHARE ## Introduction Retrieves a marketplace payout by ID. --- ## REST API ### Schema ``` Method: getMarketplacePayout Description: Retrieves a marketplace payout by GUID. URL: https://www.wixapis.com/partners/marketplace/v1/marketplace-payouts/{marketplacePayoutId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: marketplacePayoutId Method parameters: param name: marketplacePayoutId | type: none | required: true Return type: GetMarketplacePayoutResponse - name: marketplacePayout | type: MarketplacePayout | description: Retrieved marketplace payout. - name: id | type: string | description: MarketplacePayout GUID. | read-only: true | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the MarketplacePayout is updated. To prevent conflicting changes, the current revision must be passed when updating the MarketplacePayout. | read-only: true | validation: format int64 - name: createdDate | type: string | description: Date and time the payout record was created in Wix's systems. This is record bookkeeping, not the date of the marketplace transaction. For that, use `transactionDate`. | read-only: true | validation: format date-time - name: updatedDate | type: string | description: Date and time the payout record was last updated. Not the date of the marketplace transaction. For that, use `transactionDate`. | read-only: true | validation: format date-time - name: listing | type: Listing | description: The marketplace listing the transaction was made on, for example the template that was sold. The Wix Studio dashboard displays the listing's name instead of its GUID and type. - name: id | type: string | description: GUID of the listing. | validation: format GUID - name: type | type: Type | description: Type of the listing. - enum: - UNKNOWN: Unknown listing type. - TEMPLATE: A template listing. - name: transactionAmount | type: number | description: Total price of the marketplace transaction, converted to and stored in USD. | validation: format double - name: paymentSharePercent | type: number | description: Fractional percent of `transactionAmount` the partner earns as revenue share, used to calculate `amount`. For example, a value of `0.05` means 0.05%. | validation: format double - name: amount | type: number | description: Revenue share the partner earned on this transaction, in USD. Calculated as `transactionAmount` multiplied by `paymentSharePercent`, divided by 100. | validation: format double - name: transactionDate | type: string | description: Date and time the marketplace transaction took place, which is when the payout was earned. | validation: format date-time - name: invoiceId | type: string | description: GUID of the invoice this payout was included in, once invoiced. Empty until the payout is invoiced. This is the reference code of the partner's invoice. To resolve it, query the Materialized Invoices API for the materialized invoice whose `invoicesRefCodes` contains this value, and read that invoice's `status` to see whether it was paid. | validation: maxLength 50 - name: status | type: Status | description: Status of the marketplace payout. - `APPROVED`: Eligible to be invoiced. Shown as `Paid` in the Wix Studio dashboard, or as `Reversed` when `negative` is `true`. - `REJECTED`: Won't be paid. Shown as `Cancelled` in the Wix Studio dashboard, and excluded from the dashboard's earnings total. - enum: - APPROVED: Eligible to be invoiced. Shown as `Paid` in the Wix Studio dashboard, or as `Reversed` when `negative` is `true`. - REJECTED: Won't be paid. Shown as `Cancelled` in the Wix Studio dashboard, and excluded from its earnings total. - name: negative | type: boolean | description: Whether this payout is a reversal or cancellation of an earlier payout. When `true`, the payout offsets a previous earning, so its `amount` reduces the partner's total. One positive and one negative payout are allowed per transaction. Reversals are returned by queries like any other payout, and count toward totals, so don't filter them out when summing. ``` ### Examples ### Get Marketplace Payout Retrieves a single marketplace payout by ID ```curl curl -X GET \ 'https://www.wixapis.com/partners/marketplace/v1/marketplace-payouts/3f1c8e2a-9b47-4d1e-8a6f-2c5b7e9d0a14' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.marketplacePayouts.marketplacePayouts.getMarketplacePayout(marketplacePayoutId) Description: Retrieves a marketplace payout by GUID. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: marketplacePayoutId Method parameters: param name: marketplacePayoutId | type: string | description: GUID of the marketplace payout to retrieve. | required: true | validation: format GUID Return type: PROMISE - name: _id | type: string | description: MarketplacePayout GUID. | read-only: true | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the MarketplacePayout is updated. To prevent conflicting changes, the current revision must be passed when updating the MarketplacePayout. | read-only: true | validation: format int64 - name: _createdDate | type: Date | description: Date and time the payout record was created in Wix's systems. This is record bookkeeping, not the date of the marketplace transaction. For that, use `transactionDate`. | read-only: true - name: _updatedDate | type: Date | description: Date and time the payout record was last updated. Not the date of the marketplace transaction. For that, use `transactionDate`. | read-only: true - name: listing | type: Listing | description: The marketplace listing the transaction was made on, for example the template that was sold. The Wix Studio dashboard displays the listing's name instead of its GUID and type. - name: _id | type: string | description: GUID of the listing. | validation: format GUID - name: type | type: Type | description: Type of the listing. - enum: - UNKNOWN: Unknown listing type. - TEMPLATE: A template listing. - name: transactionAmount | type: number | description: Total price of the marketplace transaction, converted to and stored in USD. - name: paymentSharePercent | type: number | description: Fractional percent of `transactionAmount` the partner earns as revenue share, used to calculate `amount`. For example, a value of `0.05` means 0.05%. - name: amount | type: number | description: Revenue share the partner earned on this transaction, in USD. Calculated as `transactionAmount` multiplied by `paymentSharePercent`, divided by 100. - name: transactionDate | type: Date | description: Date and time the marketplace transaction took place, which is when the payout was earned. - name: invoiceId | type: string | description: GUID of the invoice this payout was included in, once invoiced. Empty until the payout is invoiced. This is the reference code of the partner's invoice. To resolve it, query the Materialized Invoices API for the materialized invoice whose `invoicesRefCodes` contains this value, and read that invoice's `status` to see whether it was paid. | validation: maxLength 50 - name: status | type: Status | description: Status of the marketplace payout. - `APPROVED`: Eligible to be invoiced. Shown as `Paid` in the Wix Studio dashboard, or as `Reversed` when `negative` is `true`. - `REJECTED`: Won't be paid. Shown as `Cancelled` in the Wix Studio dashboard, and excluded from the dashboard's earnings total. - enum: - APPROVED: Eligible to be invoiced. Shown as `Paid` in the Wix Studio dashboard, or as `Reversed` when `negative` is `true`. - REJECTED: Won't be paid. Shown as `Cancelled` in the Wix Studio dashboard, and excluded from its earnings total. - name: negative | type: boolean | description: Whether this payout is a reversal or cancellation of an earlier payout. When `true`, the payout offsets a previous earning, so its `amount` reduces the partner's total. One positive and one negative payout are allowed per transaction. Reversals are returned by queries like any other payout, and count toward totals, so don't filter them out when summing. ``` ### Examples ### Get Marketplace Payout Retrieves a single marketplace payout by ID ```javascript import { marketplacePayouts } from "@wix/marketplace-payouts"; const marketplacePayoutId = "3f1c8e2a-9b47-4d1e-8a6f-2c5b7e9d0a14"; async function getMarketplacePayout() { const response = await marketplacePayouts.getMarketplacePayout( marketplacePayoutId ); } /* Promise resolves to: { "marketplacePayout": { "_id": "3f1c8e2a-9b47-4d1e-8a6f-2c5b7e9d0a14", "revision": "1", "_createdDate": "2026-05-14T08:21:33.512Z", "_updatedDate": "2026-05-14T08:21:33.512Z", "listing": { "id": "a1c2e3f4-5b6d-4789-9012-3456789abcde", "type": "TEMPLATE" }, "transactionAmount": 79, "paymentSharePercent": 100, "amount": 79, "transactionDate": "2026-05-14T08:21:30.000Z", "invoiceId": "", "status": "APPROVED", "negative": false } } */ ``` ### getMarketplacePayout (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { marketplacePayouts } from '@wix/marketplace-payouts'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { marketplacePayouts }, // Include the auth strategy and host as relevant }); async function getMarketplacePayout(marketplacePayoutId) { const response = await myWixClient.marketplacePayouts.getMarketplacePayout(marketplacePayoutId); }; ``` ---